java.lang.Object
net.i2p.data.i2np.I2NPMessageImpl
net.i2p.data.i2np.TunnelBuildMessageBase
net.i2p.data.i2np.TunnelBuildMessage
- All Implemented Interfaces:
I2NPMessage
- Direct Known Subclasses:
ShortTunnelBuildMessage, VariableTunnelBuildMessage
The basic build message with 8 records.
Nested Class Summary
Nested classes/interfaces inherited from class I2NPMessageImpl
I2NPMessageImpl.BuilderModifier and TypeClassDescriptionstatic interfaceInterface for extending the types of messages handled - unused.Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe I2NP message type number for a tunnel build message.Fields inherited from class TunnelBuildMessageBase
_records, MAX_RECORD_COUNT, RECORD_COUNT, RECORD_SIZEModifier and TypeFieldDescriptionprotected EncryptedBuildRecord[]The encrypted records, one per hop, or null untilTunnelBuildMessageBase.readMessage(byte[], int, int, int).static final intMaximum number of records in any tunnel build message (8 hops).protected intNumber of records in _records, zero if not yet set.static final intSize in bytes of one encrypted record: 16 byte IV + 512 byte payload.Fields inherited from class I2NPMessageImpl
_context, _expiration, _log, CHECKSUM_LENGTH, DEFAULT_EXPIRATION_MS, HEADER_LENGTHModifier and TypeFieldDescriptionprotected final I2PAppContextApplication context this message belongs to.protected longExpiration time in milliseconds since the epoch, as an I2P Date.protected final LogLog for the message class, taken from the context's log manager.static final intNumber of checksum bytes the message header carries.static final longDefault lifetime of an unsent message, one minute in milliseconds.static final intI2NP message header size in bytes.Fields inherited from interface I2NPMessage
MAX_ID_VALUE, MAX_SIZEModifier and TypeFieldDescriptionstatic final long4 bytes unsigned.static final intNominal limit, actual max is much less.Constructor Summary
ConstructorsModifierConstructorDescriptionTunnelBuildMessage(I2PAppContext context) Creates a build message with the default record count.protectedTunnelBuildMessage(I2PAppContext context, int records) Creates a build message carrying the given number of build records.Method Summary
All MethodsMethods inherited from class TunnelBuildMessageBase
calculateWrittenLength, getRecord, getRecordCount, readMessage, setRecord, writeMessageBodyModifier and TypeMethodDescriptionprotected intWritten length of the message body: one record size per record.getRecord(int index) Build record at the given index, may be null.intHow many encrypted build records this message carries, which sets both the length of every hop record array and the tunnel's depth.voidreadMessage(byte[] data, int offset, int dataSize, int type) Read the records from a byte array.voidsetRecord(int index, EncryptedBuildRecord record) Store a build record.protected intwriteMessageBody(byte[] out, int curIndex) Write the records to the output array, starting at the given index.Methods inherited from class I2NPMessageImpl
createMessage, fromRawByteArray, fromRawByteArrayNTCP2, getMessageExpiration, getMessageSize, getRawMessageSize, getUniqueId, getUniqueId, readBytes, readBytes, readMessage, setMessageExpiration, setUniqueId, toByteArray, toByteArray, toByteArray, toRawByteArray, toRawByteArrayNTCP2Modifier and TypeMethodDescriptionstatic I2NPMessagecreateMessage(I2PAppContext context, int type) Yes, this is fairly ugly, but its the only place it ever happens.static I2NPMessagefromRawByteArray(I2PAppContext ctx, byte[] buffer, int offset, int len, I2NPMessageHandler handler) Read the message with a short 5-byte header.static I2NPMessagefromRawByteArrayNTCP2(I2PAppContext ctx, byte[] buffer, int offset, int len, I2NPMessageHandler handler) Read the message with a short 9-byte header.longDate after which the message should be dropped (and the associated uniqueId forgotten).intSerialized message size, including the 16-byte header.intThe raw header consists of a one-byte type and a 4-byte expiration in seconds only.longUnique id for this message, lazily initialized when negative.longgetUniqueId(long msgIDBloomXor) Replay resistant message Id.intreadBytes(byte[] data, int type, int offset) Read the header, then read the rest into buffer, then call readMessage in the implemented message type.intreadBytes(byte[] data, int type, int offset, int maxLen) Limit the max to read from the data buffer, so that we can use a large buffer but prevent the reader from reading off the end.voidreadMessage(byte[] data, int offset, int dataSize, int type, I2NPMessageHandler handler) Read the message fields from the byte array, ignoring the handler.voidsetMessageExpiration(long exp) The expiration is set to one minute from now in the constructor but it can be overridden here.voidsetUniqueId(long id) The ID is set to a random value when written but it can be overridden here.byte[]The message serialized into a new byte array.inttoByteArray(byte[] buffer) Write the message to the buffer, returning the number of bytes written.inttoByteArray(byte[] buffer, int off) Write the message to the buffer, returning the new offset (NOT the length).inttoRawByteArray(byte[] buffer) Write the message with a short 5-byte header.inttoRawByteArrayNTCP2(byte[] buffer, int off) Write the message to the buffer, returning the new offset (NOT the length).
Field Details
MESSAGE_TYPE
public static final int MESSAGE_TYPEThe I2NP message type number for a tunnel build message.- See Also:
Constructor Details
TunnelBuildMessage
Creates a build message with the default record count.- Parameters:
context- the application context the message is read and written under
TunnelBuildMessage
Creates a build message carrying the given number of build records.- Parameters:
context- the application context the message is read and written underrecords- the number of build records this message carries
Method Details
getType
toString