net.i2p.data.i2cp

Class MessagePayloadMessage

java.lang.Object

net.i2p.data.i2cp.I2CPMessageImpl

net.i2p.data.i2cp.MessagePayloadMessage

All Implemented Interfaces:

I2CPMessage

public class MessagePayloadMessage
extends I2CPMessageImpl

Defines the payload message a router sends to the client

Field Summary

Fields

Modifier and Type	Field and Description
static int	MESSAGE_TYPE

Constructor Summary

Constructors

Constructor and Description
MessagePayloadMessage() For reading.
MessagePayloadMessage(long sessID, long msgID, Payload payload) For writing

Method Summary

Modifier and Type	Method and Description
protected void	doReadMessage(InputStream in, int size) Read in the payload part of the message (after the initial 4 byte size and 1 byte type)
protected byte[]	doWriteMessage() Write out the payload part of the message (not including the 4 byte size and 1 byte type)
long	getMessageId()
Payload	getPayload()
long	getSessionId()
int	getType() Return the unique identifier for this type of message, as specified in the network specification document under #ClientAccessLayerMessages
SessionId	sessionId() Return the SessionId for this message.
String	toString()
void	writeMessage(OutputStream out) Write out the full message to the stream, including the 4 byte size and 1 byte type header.

Methods inherited from class net.i2p.data.i2cp.I2CPMessageImpl

readBytes, readMessage, readMessage, writeBytes

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

See Also:

Constant Field Values

Constructor Detail

MessagePayloadMessage

public MessagePayloadMessage()

For reading. Deprecated for writing, use 3-arg constructor

MessagePayloadMessage

public MessagePayloadMessage(long sessID,
                             long msgID,
                             Payload payload)

For writing

Method Detail

doReadMessage

protected void doReadMessage(InputStream in,
                             int size)
                      throws I2CPMessageException,
                             IOException

Description copied from class: I2CPMessageImpl

Read in the payload part of the message (after the initial 4 byte size and 1 byte type)

Specified by:

doReadMessage in class I2CPMessageImpl

Parameters:

in - InputStream

size - payload size

Throws:

I2CPMessageException - if the message format is invalid

IOException - if there's an error reading from the stream

doWriteMessage

protected byte[] doWriteMessage()
                         throws I2CPMessageException,
                                IOException

Description copied from class: I2CPMessageImpl

Write out the payload part of the message (not including the 4 byte size and 1 byte type)

Specified by:

doWriteMessage in class I2CPMessageImpl

Returns:

byte array

Throws:

UnsupportedOperationException - always

I2CPMessageException - if the message cannot be written

IOException - if there's an error writing to the stream

getMessageId

public long getMessageId()

getPayload

public Payload getPayload()

getSessionId

public long getSessionId()

getType

public int getType()

Description copied from interface: I2CPMessage

Return the unique identifier for this type of message, as specified in the network specification document under #ClientAccessLayerMessages

Returns:

unique identifier for this type of message

sessionId

public SessionId sessionId()

Return the SessionId for this message.

Specified by:

sessionId in interface I2CPMessage

Overrides:

sessionId in class I2CPMessageImpl

Returns:

null always. Extending classes with a SessionId must override.

toString

public String toString()

Overrides:

toString in class Object

writeMessage

public void writeMessage(OutputStream out)
                  throws I2CPMessageException,
                         IOException

Write out the full message to the stream, including the 4 byte size and 1 byte type header.

Specified by:

writeMessage in interface I2CPMessage

Overrides:

writeMessage in class I2CPMessageImpl

Parameters:

out - OutputStream

Throws:

IOException - if there's an error writing to the stream

I2CPMessageException - if the current object doesn't have sufficient data to write a properly formatted message.