net.i2p.data.i2cp

Class HostReplyMessage

java.lang.Object

net.i2p.data.i2cp.I2CPMessageImpl

net.i2p.data.i2cp.HostReplyMessage

All Implemented Interfaces:

I2CPMessage

public class HostReplyMessage
extends I2CPMessageImpl

Response to HostLookupMessage. Replaces DestReplyMessage.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MESSAGE_TYPE
static int	RESULT_DECRYPTION_FAILURE Decryption failure result code.
static int	RESULT_FAILURE generic fail, other codes TBD
static int	RESULT_KEY_REQUIRED Request key required result code.
static int	RESULT_SECRET_AND_KEY_REQUIRED Request secret and key required result code.
static int	RESULT_SECRET_REQUIRED Request secret required result code.
static int	RESULT_SUCCESS

Constructor Summary

Constructors

Constructor and Description
HostReplyMessage()
HostReplyMessage(SessionId id, Destination d, long reqID) A message with RESULT_SUCCESS and a non-null Destination.
HostReplyMessage(SessionId id, int failureCode, long reqID) A message with a failure code and no Destination.

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)
Destination	getDestination() Gets the destination.
long	getReqID() Gets the request ID.
int	getResultCode() Gets the result code.
SessionId	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()

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

RESULT_DECRYPTION_FAILURE

public static final int RESULT_DECRYPTION_FAILURE

Decryption failure result code.

See Also:

Constant Field Values

RESULT_FAILURE

public static final int RESULT_FAILURE

generic fail, other codes TBD

See Also:

Constant Field Values

RESULT_KEY_REQUIRED

public static final int RESULT_KEY_REQUIRED

Request key required result code.

See Also:

Constant Field Values

RESULT_SECRET_AND_KEY_REQUIRED

public static final int RESULT_SECRET_AND_KEY_REQUIRED

Request secret and key required result code.

See Also:

Constant Field Values

RESULT_SECRET_REQUIRED

public static final int RESULT_SECRET_REQUIRED

Request secret required result code.

See Also:

Constant Field Values

RESULT_SUCCESS

public static final int RESULT_SUCCESS

See Also:

Constant Field Values

Constructor Detail

HostReplyMessage

public HostReplyMessage()

HostReplyMessage

public HostReplyMessage(SessionId id,
                        Destination d,
                        long reqID)

A message with RESULT_SUCCESS and a non-null Destination.

Parameters:

d - non-null

reqID - 0 to 2**32 - 1

HostReplyMessage

public HostReplyMessage(SessionId id,
                        int failureCode,
                        long reqID)

A message with a failure code and no Destination.

Parameters:

failureCode - 1-255

reqID - from the HostLookup 0 to 2**32 - 1

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

getDestination

public Destination getDestination()

Gets the destination.

Returns:

non-null only if result code is zero

getReqID

public long getReqID()

Gets the request ID.

Returns:

0 to 2**32 - 1

getResultCode

public int getResultCode()

Gets the result code.

Returns:

0 on success, 1-255 on failure

getSessionId

public SessionId 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