net.i2p.data.i2cp

Class SessionStatusMessage

java.lang.Object

net.i2p.data.i2cp.I2CPMessageImpl

net.i2p.data.i2cp.SessionStatusMessage

All Implemented Interfaces:

I2CPMessage

public class SessionStatusMessage
extends I2CPMessageImpl

Defines the message a router sends to a client indicating the status of the session.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MESSAGE_TYPE
static int	STATUS_CREATED
static int	STATUS_DESTROYED
static int	STATUS_DUP_DEST Used internally, not in spec, will be remapped to STATUS_INVALID before being sent.
static int	STATUS_INVALID
static int	STATUS_REFUSED Session refused status.
static int	STATUS_UPDATED

Constructor Summary

Constructors

Constructor and Description
SessionStatusMessage()

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)
SessionId	getSessionId()
int	getStatus()
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	setSessionId(SessionId id)
void	setStatus(int status)
String	toString()

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

readBytes, readMessage, readMessage, writeBytes, writeMessage

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

STATUS_CREATED

public static final int STATUS_CREATED

See Also:

Constant Field Values

STATUS_DESTROYED

public static final int STATUS_DESTROYED

See Also:

Constant Field Values

STATUS_DUP_DEST

public static final int STATUS_DUP_DEST

Used internally, not in spec, will be remapped to STATUS_INVALID before being sent.

See Also:

Constant Field Values

STATUS_INVALID

public static final int STATUS_INVALID

See Also:

Constant Field Values

STATUS_REFUSED

public static final int STATUS_REFUSED

Session refused status.

See Also:

Constant Field Values

STATUS_UPDATED

public static final int STATUS_UPDATED

See Also:

Constant Field Values

Constructor Detail

SessionStatusMessage

public SessionStatusMessage()

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:

I2CPMessageException - if the message cannot be written

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

getSessionId

public SessionId getSessionId()

getStatus

public int getStatus()

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.

setSessionId

public void setSessionId(SessionId id)

setStatus

public void setStatus(int status)

toString

public String toString()

Overrides:

toString in class Object