Package net.i2p.data.i2np
Class TunnelGatewayMessage
java.lang.Object
net.i2p.data.i2np.I2NPMessageImpl
net.i2p.data.i2np.FastI2NPMessageImpl
net.i2p.data.i2np.TunnelGatewayMessage
- All Implemented Interfaces:
I2NPMessage
Defines the message sent between one tunnel's endpoint and another's gateway.
format: { tunnelId, sizeof(i2npMessage.toByteArray()), i2npMessage.toByteArray() }
-
Nested Class Summary
Nested classes/interfaces inherited from class net.i2p.data.i2np.I2NPMessageImpl
I2NPMessageImpl.Builder
-
Field Summary
Fields inherited from class net.i2p.data.i2np.FastI2NPMessageImpl
_checksum, _hasChecksum
Fields inherited from class net.i2p.data.i2np.I2NPMessageImpl
_context, _expiration, _log, CHECKSUM_LENGTH, DEFAULT_EXPIRATION_MS, HEADER_LENGTH
Fields inherited from interface net.i2p.data.i2np.I2NPMessage
MAX_ID_VALUE, MAX_SIZE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected int
calculate the message body's length (not including the header and footerboolean
Warning, at the IBGW, where the message was read in, this will be an UnknownI2NPMessage.int
getType()
Return the unique identifier for this type of I2NP message, as defined in the I2NP specint
hashCode()
void
readMessage
(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 specificationvoid
readMessage
(byte[] data, int offset, int dataSize, int type, I2NPMessageHandler handler) Note that for efficiency at the IBGW, this does not fully deserialize the included I2NP Message.void
setMessage
(I2NPMessage msg) void
setTunnelId
(TunnelId id) toString()
protected int
writeMessageBody
(byte[] out, int curIndex) write the message body to the output array, starting at the given indexMethods inherited from class net.i2p.data.i2np.FastI2NPMessageImpl
readBytes, toByteArray, toByteArrayWithSavedChecksum
Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl
createMessage, fromRawByteArray, fromRawByteArrayNTCP2, getMessageExpiration, getMessageSize, getRawMessageSize, getUniqueId, readBytes, readBytes, registerBuilder, setMessageExpiration, setUniqueId, toByteArray, toByteArray, toRawByteArray, toRawByteArrayNTCP2, writeBytes
-
Field Details
-
MESSAGE_TYPE
public static final int MESSAGE_TYPE- See Also:
-
-
Constructor Details
-
TunnelGatewayMessage
-
-
Method Details
-
getTunnelId
-
setTunnelId
- Throws:
IllegalStateException
- if id previously set, to protect saved checksum
-
getMessage
Warning, at the IBGW, where the message was read in, this will be an UnknownI2NPMessage. If you need a real message class, use UnknownI2NPMessage.convert(). Warning, will be null after message has been written. Note that if you change the expiration on the embedded message it will mess up the checksum of this message, so don't do that. -
setMessage
- Throws:
IllegalStateException
- if msg previously set, to protect saved checksum
-
calculateWrittenLength
protected int calculateWrittenLength()Description copied from class:I2NPMessageImpl
calculate the message body's length (not including the header and footer- Specified by:
calculateWrittenLength
in classI2NPMessageImpl
-
writeMessageBody
write the message body to the output array, starting at the given index- Specified by:
writeMessageBody
in classI2NPMessageImpl
- Returns:
- the index into the array after the last byte written (NOT the length)
- Throws:
I2NPMessageException
-
readMessage
public void readMessage(byte[] data, int offset, int dataSize, int type) throws I2NPMessageException Description copied from interface:I2NPMessage
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 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.
-
readMessage
public void readMessage(byte[] data, int offset, int dataSize, int type, I2NPMessageHandler handler) throws I2NPMessageException Note that for efficiency at the IBGW, this does not fully deserialize the included I2NP Message. It just puts it in an UnknownI2NPMessage.- Specified by:
readMessage
in interfaceI2NPMessage
- Overrides:
readMessage
in classI2NPMessageImpl
- Parameters:
handler
- unused, may be null- Throws:
I2NPMessageException
-
getType
public int getType()Description copied from interface:I2NPMessage
Return the unique identifier for this type of I2NP message, as defined in the I2NP spec -
hashCode
public int hashCode() -
equals
-
toString
-