TunnelBuildMessageBase (Javadocs [I2P+ 2.13.0+]

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.

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
`protected EncryptedBuildRecord[]`	`_records` The encrypted records, one per hop, or null until readMessage().
`static int`	`MAX_RECORD_COUNT` Maximum number of records in any tunnel build message (8 hops).
`protected int`	`RECORD_COUNT` Number of records in _records, zero if not yet set.
`static int`	`RECORD_SIZE` Size in bytes of one encrypted record: 16 byte IV + 512 byte payload.

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

Constructors
Modifier	Constructor and Description
	`TunnelBuildMessageBase(I2PAppContext context)` Create with the default number of records.
`protected`	`TunnelBuildMessageBase(I2PAppContext context, int records)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`calculateWrittenLength()` Written length of the message body: one record size per record.
`EncryptedBuildRecord`	`getRecord(int index)` Build record at the given index, may be null.
`int`	`getRecordCount()`
`void`	`readMessage(byte[] data, int offset, int dataSize, int type)` Read the records from a byte array.
`void`	`setRecord(int index, EncryptedBuildRecord record)` Store a build record.
`protected int`	`writeMessageBody(byte[] out, int curIndex)` Write the records 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, 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, toString, wait, wait, wait

Methods inherited from interface net.i2p.data.i2np.I2NPMessage
getType

- Field Detail
  - _records
```
protected EncryptedBuildRecord[] _records
```
    The encrypted records, one per hop, or null until readMessage().
  - MAX_RECORD_COUNT
```
public static final int MAX_RECORD_COUNT
```
    Maximum number of records in any tunnel build message (8 hops).
    See Also:
    Constant Field Values
  - RECORD_COUNT
```
protected int RECORD_COUNT
```
    Number of records in _records, zero if not yet set.
  - RECORD_SIZE
```
public static final int RECORD_SIZE
```
    Size in bytes of one encrypted record: 16 byte IV + 512 byte payload.
    See Also:
    Constant Field Values
- Constructor Detail
  - TunnelBuildMessageBase
```
public TunnelBuildMessageBase(I2PAppContext context)
```
    Create with the default number of records.
  - TunnelBuildMessageBase
```
protected TunnelBuildMessageBase(I2PAppContext context,
                                 int records)
```
- Method Detail
  - calculateWrittenLength
```
protected int calculateWrittenLength()
```
    Written length of the message body: one record size per record.
    Specified by:
    calculateWrittenLength in class I2NPMessageImpl
  - getRecord
```
public EncryptedBuildRecord getRecord(int index)
```
    Build record at the given index, may be null.
    Parameters:
    index - the index
    Returns:
    may be null
  - getRecordCount
```
public int getRecordCount()
```
  - readMessage
```
public void readMessage(byte[] data,
                        int offset,
                        int dataSize,
                        int type)
                 throws I2NPMessageException
```
    Read the records from a byte array.
    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)
```
    Store a build record.
    Parameters:
    record - may be null
    index - the index
  - writeMessageBody
```
protected int writeMessageBody(byte[] out,
                               int curIndex)
                        throws I2NPMessageException
```
    Write the records 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 TunnelBuildMessageBase

Nested Class Summary

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

Field Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

_records

MAX_RECORD_COUNT

RECORD_COUNT

RECORD_SIZE

Constructor Detail

TunnelBuildMessageBase

TunnelBuildMessageBase

Method Detail

calculateWrittenLength

getRecord

getRecordCount

readMessage

setRecord

writeMessageBody