Package 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

Author:

jrandom

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MESSAGE_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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.
void	setMessageId(long id)	Deprecated. use 3-arg constructor
void	setPayload(Payload payload)	Deprecated. use 3-arg constructor
void	setSessionId(long id)	Deprecated. use 3-arg constructor
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 Details

MESSAGE_TYPE

public static final int MESSAGE_TYPE

See Also:

• Constant Field Values

Constructor Details

MessagePayloadMessage

public MessagePayloadMessage()

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

MessagePayloadMessage

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

For writing

Since:

0.9.54

Method Details

getSessionId

public long getSessionId()

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.

Since:

0.9.21

setSessionId

@Deprecated
public void setSessionId(long id)

Deprecated.

use 3-arg constructor

Parameters:

id - 0-65535

getMessageId

public long getMessageId()

setMessageId

@Deprecated
public void setMessageId(long id)

Deprecated.

use 3-arg constructor

getPayload

public Payload getPayload()

setPayload

@Deprecated
public void setPayload(Payload payload)

Deprecated.

use 3-arg constructor

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

IOException

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

IOException

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

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

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

toString

public String toString()

Overrides:

toString in class Object