TunnelGatewayMessage (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.data.i2np.I2NPMessageImpl
- - net.i2p.data.i2np.FastI2NPMessageImpl
  - - net.i2p.data.i2np.TunnelGatewayMessage

All Implemented Interfaces:
I2NPMessage
```
public class TunnelGatewayMessage
extends FastI2NPMessageImpl
```
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
Modifier and Type Field and Description
static int MESSAGE_TYPE
Message type ID for this I2NP message
- 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

Fields
Modifier and Type	Field and Description
`static int`	`MESSAGE_TYPE` Message type ID for this I2NP message

Constructor Summary
Constructors
Constructor and Description
TunnelGatewayMessage(I2PAppContext context)
Constructor with 10-second message expiration from context clock.

Constructors
Constructor and Description
`TunnelGatewayMessage(I2PAppContext context)` Constructor with 10-second message expiration from context clock.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`calculateWrittenLength()` Calculate the serialized length of this message
`boolean`	`equals(Object object)` Two TunnelGatewayMessages are equal if they have the same tunnel ID and message content.
`I2NPMessage`	`getMessage()` Warning, at the IBGW, where the message was read in, this will be an UnknownI2NPMessage.
`TunnelId`	`getTunnelId()` Return the tunnelId
`int`	`getType()` Return the type
`int`	`hashCode()` Hash based on tunnel ID and embedded message.
`void`	`readMessage(byte[] data, int offset, int dataSize, int type)` Read and parse the message from raw data into fields.
`void`	`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)`
`String`	`toString()` Label with message ID, tunnel ID, and embedded message for logging.
`protected int`	`writeMessageBody(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.FastI2NPMessageImpl
readBytes, toByteArray, toByteArrayWithSavedChecksum

Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl
createMessage, fromRawByteArray, fromRawByteArrayNTCP2, getMessageExpiration, getMessageSize, getRawMessageSize, getUniqueId, getUniqueId, readBytes, setMessageExpiration, setUniqueId, toByteArray, toByteArray, toRawByteArray, toRawByteArrayNTCP2

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MESSAGE_TYPE
```
public static final int MESSAGE_TYPE
```
    Message type ID for this I2NP message
    See Also:
    Constant Field Values
- Constructor Detail
  - TunnelGatewayMessage
```
public TunnelGatewayMessage(I2PAppContext context)
```
    Constructor with 10-second message expiration from context clock.
- Method Detail
  - calculateWrittenLength
```
protected int calculateWrittenLength()
```
    Calculate the serialized length of this message
    Specified by:
    calculateWrittenLength in class I2NPMessageImpl
  - equals
```
public boolean equals(Object object)
```
    Two TunnelGatewayMessages are equal if they have the same tunnel ID and message content.
    Overrides:
    equals in class Object
  - getMessage
```
public I2NPMessage 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.
    Returns:
    the message
  - getTunnelId
```
public TunnelId getTunnelId()
```
    Return the tunnelId
  - getType
```
public int getType()
```
    Return the type
    Returns:
    the type
  - hashCode
```
public int hashCode()
```
    Hash based on tunnel ID and embedded message.
    Overrides:
    hashCode in class Object
    Returns:
    whether h code is present
  - readMessage
```
public void readMessage(byte[] data,
                        int offset,
                        int dataSize,
                        int type)
                 throws I2NPMessageException
```
    Read and parse the message from raw data into fields.
    Parameters:
    data - data to read from
    offset - where to start in the data array
    dataSize - how long into the data to read
    type - 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 interface I2NPMessage
    Overrides:
    readMessage in class I2NPMessageImpl
    Parameters:
    handler - unused, may be null
    Throws:
    I2NPMessageException
  - setMessage
```
public void setMessage(I2NPMessage msg)
```
    Throws:
    IllegalStateException - if msg previously set, to protect saved checksum
  - setTunnelId
```
public void setTunnelId(TunnelId id)
```
    Throws:
    IllegalStateException - if id previously set, to protect saved checksum
  - toString
```
public String toString()
```
    Label with message ID, tunnel ID, and embedded message for logging.
    Overrides:
    toString in class Object
  - writeMessageBody
```
protected int writeMessageBody(byte[] out,
                               int curIndex)
                        throws I2NPMessageException
```
    write the message body to the output array, starting at the given index
    Specified by:
    writeMessageBody in class I2NPMessageImpl
    Returns:
    the index into the array after the last byte written (NOT the length)
    Throws:
    I2NPMessageException

Class TunnelGatewayMessage

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.data.i2np.I2NPMessageImpl

Field Summary

Fields inherited from class net.i2p.data.i2np.FastI2NPMessageImpl

Fields inherited from class net.i2p.data.i2np.I2NPMessageImpl

Fields inherited from interface net.i2p.data.i2np.I2NPMessage

Constructor Summary

Method Summary

Methods inherited from class net.i2p.data.i2np.FastI2NPMessageImpl

Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_TYPE

Constructor Detail

TunnelGatewayMessage

Method Detail

calculateWrittenLength

equals

getMessage

getTunnelId

getType

hashCode

readMessage

readMessage

setMessage

setTunnelId

toString

writeMessageBody