Package net.i2p.data.i2np
Class TunnelBuildMessageBase
java.lang.Object
net.i2p.data.i2np.I2NPMessageImpl
net.i2p.data.i2np.TunnelBuildMessageBase
- All Implemented Interfaces:
I2NPMessage
- Direct Known Subclasses:
TunnelBuildMessage,TunnelBuildReplyMessage
public abstract class TunnelBuildMessageBase extends I2NPMessageImpl
Base for TBM, TBRM, VTBM, VTBRM
Retrofitted over them.
There's really no difference between the build and build reply.
TBM and VBTM (but not TBRM and VTBRM?) messages are modified
in-place by doing a single setRecord(), and retransmitted.
Therefore they are NOT good candidates to use FastI2NPMessageImpl;
the checksum would have to be invalidated with every setRecord().
Which we could do in TBM and VTBM but not TBRM and VTBRM,
but keep it simple for now.
- Since:
- 0.8.8
-
Nested Class Summary
Nested classes/interfaces inherited from class net.i2p.data.i2np.I2NPMessageImpl
I2NPMessageImpl.Builder -
Field Summary
Fields Modifier and Type Field Description protected EncryptedBuildRecord[]_recordsstatic intMAX_RECORD_COUNTprotected intRECORD_COUNTstatic intRECORD_SIZEFields inherited from class net.i2p.data.i2np.I2NPMessageImpl
_context, _expiration, _log, CHECKSUM_LENGTH, DEFAULT_EXPIRATION_MS, HEADER_LENGTH -
Constructor Summary
Constructors Modifier Constructor Description TunnelBuildMessageBase(I2PAppContext context)protectedTunnelBuildMessageBase(I2PAppContext context, int records) -
Method Summary
Modifier and Type Method Description protected intcalculateWrittenLength()calculate the message body's length (not including the header and footerEncryptedBuildRecordgetRecord(int index)intgetRecordCount()voidreadMessage(byte[] data, int offset, int dataSize, int type)Read the body into the data structures, after the initial type byte and the uniqueId / expiration, using the current class's format as defined by the I2NP specificationvoidsetRecord(int index, EncryptedBuildRecord record)protected intwriteMessageBody(byte[] out, int curIndex)write the message body to the output array, starting at the given index.Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl
createMessage, fromRawByteArray, fromRawByteArrayNTCP2, getMessageExpiration, getMessageSize, getRawMessageSize, getUniqueId, readBytes, readBytes, readBytes, readMessage, registerBuilder, setMessageExpiration, setUniqueId, toByteArray, toByteArray, toByteArray, toRawByteArray, toRawByteArrayNTCP2, writeBytes
-
Field Details
-
_records
-
RECORD_COUNT
protected int RECORD_COUNT -
MAX_RECORD_COUNT
public static final int MAX_RECORD_COUNT- See Also:
- Constant Field Values
-
RECORD_SIZE
public static final int RECORD_SIZE- See Also:
- Constant Field Values
-
-
Constructor Details
-
TunnelBuildMessageBase
-
TunnelBuildMessageBase
- Since:
- 0.7.12
-
-
Method Details
-
setRecord
- Parameters:
record- may be null
-
getRecord
- Returns:
- may be null
-
getRecordCount
public int getRecordCount()- Since:
- 0.7.12
-
calculateWrittenLength
protected int calculateWrittenLength()Description copied from class:I2NPMessageImplcalculate the message body's length (not including the header and footer- Specified by:
calculateWrittenLengthin classI2NPMessageImpl
-
readMessage
public void readMessage(byte[] data, int offset, int dataSize, int type) throws I2NPMessageExceptionDescription copied from interface:I2NPMessageRead the body into the data structures, after the initial type byte and the uniqueId / expiration, using the current class's format as defined by the I2NP specification- Parameters:
data- data to read fromoffset- where to start in the data arraydataSize- how long into the data to readtype- I2NP message type- Throws:
I2NPMessageException- if the stream doesn't contain a valid message that this class can read.
-
writeMessageBody
Description copied from class:I2NPMessageImplwrite the message body to the output array, starting at the given index.- Specified by:
writeMessageBodyin classI2NPMessageImpl- Returns:
- the index into the array after the last byte written (NOT the length)
- Throws:
I2NPMessageException
-