net.i2p.data.i2np
Class VariableTunnelBuildMessage

java.lang.Object
  extended by net.i2p.data.DataStructureImpl
      extended by net.i2p.data.i2np.I2NPMessageImpl
          extended by net.i2p.data.i2np.TunnelBuildMessage
              extended by net.i2p.data.i2np.VariableTunnelBuildMessage
All Implemented Interfaces:
DataStructure, I2NPMessage

public class VariableTunnelBuildMessage
extends TunnelBuildMessage

Since:
0.7.12

Nested Class Summary
 
Nested classes/interfaces inherited from class net.i2p.data.i2np.I2NPMessageImpl
I2NPMessageImpl.Builder
 
Field Summary
static int MESSAGE_TYPE
           
 
Fields inherited from class net.i2p.data.i2np.TunnelBuildMessage
_records, MAX_RECORD_COUNT, RECORD_COUNT, RECORD_SIZE
 
Fields inherited from class net.i2p.data.i2np.I2NPMessageImpl
_context, CHECKSUM_LENGTH, DEFAULT_EXPIRATION_MS
 
Fields inherited from interface net.i2p.data.i2np.I2NPMessage
MAX_ID_VALUE, MAX_SIZE
 
Constructor Summary
VariableTunnelBuildMessage(I2PAppContext context)
          zero record count, will be set with readMessage()
VariableTunnelBuildMessage(I2PAppContext context, int records)
           
 
Method Summary
protected  int calculateWrittenLength()
          calculate the message body's length (not including the header and footer
 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)
          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
 java.lang.String toString()
           
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.TunnelBuildMessage
getRecord, getRecordCount, setRecord
 
Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl
createMessage, fromRawByteArray, getMessageExpiration, getMessageSize, getRawMessageSize, getUniqueId, read, readBytes, readBytes, readBytes, readMessage, registerBuilder, setMessageExpiration, setUniqueId, toByteArray, toByteArray, toRawByteArray, verifyUnwritten, writeBytes, written
 
Methods inherited from class net.i2p.data.DataStructureImpl
calculateHash, fromBase64, fromByteArray, read, toBase64
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface net.i2p.data.DataStructure
calculateHash, fromBase64, fromByteArray, toBase64
 

Field Detail

MESSAGE_TYPE

public static final int MESSAGE_TYPE
See Also:
Constant Field Values
Constructor Detail

VariableTunnelBuildMessage

public VariableTunnelBuildMessage(I2PAppContext context)
zero record count, will be set with readMessage()


VariableTunnelBuildMessage

public VariableTunnelBuildMessage(I2PAppContext context,
                                  int records)
Method Detail

calculateWrittenLength

protected int calculateWrittenLength()
Description copied from class: I2NPMessageImpl
calculate the message body's length (not including the header and footer

Overrides:
calculateWrittenLength in class TunnelBuildMessage

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

readMessage

public void readMessage(byte[] data,
                        int offset,
                        int dataSize,
                        int type)
                 throws I2NPMessageException,
                        java.io.IOException
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

Specified by:
readMessage in interface I2NPMessage
Overrides:
readMessage in class TunnelBuildMessage
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.
java.io.IOException - if there is a problem reading from the stream

writeMessageBody

protected int writeMessageBody(byte[] out,
                               int curIndex)
                        throws I2NPMessageException
Description copied from class: I2NPMessageImpl
write the message body to the output array, starting at the given index.

Overrides:
writeMessageBody in class TunnelBuildMessage
Returns:
the index into the array after the last byte written
Throws:
I2NPMessageException

toString

public java.lang.String toString()
Overrides:
toString in class TunnelBuildMessage