ShortTunnelBuildMessage (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.data.i2np.I2NPMessageImpl
- - net.i2p.data.i2np.TunnelBuildMessageBase
  - - net.i2p.data.i2np.TunnelBuildMessage
    - - net.i2p.data.i2np.ShortTunnelBuildMessage

All Implemented Interfaces:
I2NPMessage
```
public class ShortTunnelBuildMessage
extends TunnelBuildMessage
```
Variable size, small records. Preliminary, see proposal 157.

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.
static int SHORT_RECORD_SIZE
SHORT_RECORD_SIZE.
- Fields inherited from class net.i2p.data.i2np.TunnelBuildMessageBase
  _records, MAX_RECORD_COUNT, RECORD_COUNT, RECORD_SIZE
- 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.
`static int`	`SHORT_RECORD_SIZE` SHORT_RECORD_SIZE.

Constructor Summary

Constructors
Constructor and Description
`ShortTunnelBuildMessage(I2PAppContext context)` zero record count, will be set with readMessage()
`ShortTunnelBuildMessage(I2PAppContext context, int records)` ShortTunnelBuildMessage.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`calculateWrittenLength()` calculateWrittenLength.
`int`	`getType()` Return the unique identifier for this type of I2NP message, as defined in the I2NP spec
`void`	`readMessage(byte[] data, int offset, int dataSize, int type)` readMessage.
`void`	`setRecord(int index, EncryptedBuildRecord record)`
`String`	`toString()` toString.
`protected int`	`writeMessageBody(byte[] out, int curIndex)` writeMessageBody.

Methods inherited from class net.i2p.data.i2np.TunnelBuildMessageBase
getRecord, getRecordCount

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

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

- Field Detail
  - MESSAGE_TYPE
```
public static final int MESSAGE_TYPE
```
    MESSAGE_TYPE.
    See Also:
    Constant Field Values
  - SHORT_RECORD_SIZE
```
public static final int SHORT_RECORD_SIZE
```
    SHORT_RECORD_SIZE.
    See Also:
    Constant Field Values
- Constructor Detail
  - ShortTunnelBuildMessage
```
public ShortTunnelBuildMessage(I2PAppContext context)
```
    zero record count, will be set with readMessage()
  - ShortTunnelBuildMessage
```
public ShortTunnelBuildMessage(I2PAppContext context,
                               int records)
```
    ShortTunnelBuildMessage.
- Method Detail
  - calculateWrittenLength
```
protected int calculateWrittenLength()
```
    calculateWrittenLength.
    Overrides:
    calculateWrittenLength in class TunnelBuildMessageBase
  - 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
    Specified by:
    getType in interface I2NPMessage
    Overrides:
    getType in class TunnelBuildMessage
    Returns:
    the type
  - readMessage
```
public void readMessage(byte[] data,
                        int offset,
                        int dataSize,
                        int type)
                 throws I2NPMessageException
```
    readMessage.
    Specified by:
    readMessage in interface I2NPMessage
    Overrides:
    readMessage in class TunnelBuildMessageBase
    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.
  - setRecord
```
public void setRecord(int index,
                      EncryptedBuildRecord record)
```
    Overrides:
    setRecord in class TunnelBuildMessageBase
    Parameters:
    record - must be ShortEncryptedBuildRecord or null
    index - the index
  - toString
```
public String toString()
```
    toString.
    Overrides:
    toString in class TunnelBuildMessage
  - writeMessageBody
```
protected int writeMessageBody(byte[] out,
                               int curIndex)
                        throws I2NPMessageException
```
    writeMessageBody.
    Overrides:
    writeMessageBody in class TunnelBuildMessageBase
    Returns:
    the index into the array after the last byte written (NOT the length)
    Throws:
    I2NPMessageException

Class ShortTunnelBuildMessage

Nested Class Summary

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

Field Summary

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

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.TunnelBuildMessageBase

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

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_TYPE

SHORT_RECORD_SIZE

Constructor Detail

ShortTunnelBuildMessage

ShortTunnelBuildMessage

Method Detail

calculateWrittenLength

getType

readMessage

setRecord

toString

writeMessageBody