freenet.client.async

Class SplitFileInserterSegmentStorage

java.lang.Object

freenet.client.async.SplitFileInserterSegmentStorage

public class SplitFileInserterSegmentStorage
extends java.lang.Object

A single segment within a splitfile to be inserted.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SplitFileInserterSegmentStorage.MissingKeyException

Constructor Summary

Constructors

Constructor and Description
SplitFileInserterSegmentStorage(SplitFileInserterStorage parent, java.io.DataInputStream dis, int segNo, int keyLength, byte splitfileCryptoAlgorithm, byte[] splitfileCryptoKey, java.util.Random random, int maxRetries, int consecutiveRNFsCountAsSuccess, KeysFetchingLocally keysFetching) Create a segment from the fixed settings stored in the RAF by writeFixedSettings().
SplitFileInserterSegmentStorage(SplitFileInserterStorage parent, int segNo, boolean persistent, int dataBlocks, int checkBlocks, int crossCheckBlocks, int keyLength, byte splitfileCryptoAlgorithm, byte[] splitfileCryptoKey, java.util.Random random, int maxRetries, int consecutiveRNFsCountAsSuccess, KeysFetchingLocally keysFetching)

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Caller must check hasCompletedOrFailed() explicitly after calling cancel() on all segments.
void	checkKeys() Called on startup to check which keys we actually have.
freenet.client.async.SplitFileInserterSegmentStorage.BlockInsert	chooseBlock()
int	countSendableKeys()
ClientCHKBlock	encodeBlock(int blockNo)
boolean	hasCompletedOrFailed()
boolean	hasEncoded() Has the segment encoded all check blocks and cross-check blocks?
boolean	hasKeys()
boolean	hasSucceeded() Has the segment completed all inserts? Should not change once we reach this state, but might be possible in case of disk errors causing losing keys etc.
boolean	isFinishedEncoding()
void	onFailure(int blockNo, InsertException e)
void	onInsertedBlock(int blockNo, ClientCHK key) Called when a block insert succeeds
byte[]	readCheckBlock(int checkBlockNo)
byte[]	readDataBlock(int blockNo)
void	readStatus()
void	startEncode(short prio)
int	storedKeysLength()
long	storedStatusLength()
void	storeStatus(boolean force)
java.lang.String	toString()
void	writeFixedSettings(java.io.DataOutputStream dos)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SplitFileInserterSegmentStorage

public SplitFileInserterSegmentStorage(SplitFileInserterStorage parent,
                                       int segNo,
                                       boolean persistent,
                                       int dataBlocks,
                                       int checkBlocks,
                                       int crossCheckBlocks,
                                       int keyLength,
                                       byte splitfileCryptoAlgorithm,
                                       byte[] splitfileCryptoKey,
                                       java.util.Random random,
                                       int maxRetries,
                                       int consecutiveRNFsCountAsSuccess,
                                       KeysFetchingLocally keysFetching)

SplitFileInserterSegmentStorage

public SplitFileInserterSegmentStorage(SplitFileInserterStorage parent,
                                       java.io.DataInputStream dis,
                                       int segNo,
                                       int keyLength,
                                       byte splitfileCryptoAlgorithm,
                                       byte[] splitfileCryptoKey,
                                       java.util.Random random,
                                       int maxRetries,
                                       int consecutiveRNFsCountAsSuccess,
                                       KeysFetchingLocally keysFetching)
                                throws java.io.IOException,
                                       StorageFormatException

Create a segment from the fixed settings stored in the RAF by writeFixedSettings().

Throws:

java.io.IOException

StorageFormatException

Method Detail

storeStatus

public void storeStatus(boolean force)

readStatus

public void readStatus()
                throws java.io.IOException,
                       ChecksumFailedException,
                       StorageFormatException

Throws:

java.io.IOException

ChecksumFailedException

StorageFormatException

storedStatusLength

public long storedStatusLength()

writeFixedSettings

public void writeFixedSettings(java.io.DataOutputStream dos)
                        throws java.io.IOException

Throws:

java.io.IOException

hasKeys

public boolean hasKeys()

checkKeys

public void checkKeys()

Called on startup to check which keys we actually have. Does nothing unless the segment claims to have been encoded already. FIXME consider calling this later on for robustness, but we would then need to re-encode ...

storedKeysLength

public int storedKeysLength()

readDataBlock

public byte[] readDataBlock(int blockNo)
                     throws java.io.IOException

Throws:

java.io.IOException

readCheckBlock

public byte[] readCheckBlock(int checkBlockNo)
                      throws java.io.IOException

Throws:

java.io.IOException

startEncode

public void startEncode(short prio)

isFinishedEncoding

public boolean isFinishedEncoding()

encodeBlock

public ClientCHKBlock encodeBlock(int blockNo)
                           throws java.io.IOException

Throws:

java.io.IOException

hasSucceeded

public boolean hasSucceeded()

Has the segment completed all inserts? Should not change once we reach this state, but might be possible in case of disk errors causing losing keys etc.

hasEncoded

public boolean hasEncoded()

Has the segment encoded all check blocks and cross-check blocks?

onInsertedBlock

public void onInsertedBlock(int blockNo,
                            ClientCHK key)

Called when a block insert succeeds

onFailure

public void onFailure(int blockNo,
                      InsertException e)

hasCompletedOrFailed

public boolean hasCompletedOrFailed()

cancel

public boolean cancel()

Caller must check hasCompletedOrFailed() explicitly after calling cancel() on all segments.

Returns:

True if the segment has completed cancellation. False if it is waiting for an encode, in which case a callback to parent will be made when the encode finishes.

chooseBlock

public freenet.client.async.SplitFileInserterSegmentStorage.BlockInsert chooseBlock()

countSendableKeys

public int countSendableKeys()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object