HostReplyMessage (Javadocs [I2P+ 2.13.0+]

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` 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_LEASESET_LOOKUP_FAILURE`
`static int`	`RESULT_LOOKUP_TYPE_UNSUPPORTED`
`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` RESULT_SUCCESS.

Constructor Summary

Constructors
Constructor and Description
`HostReplyMessage()` HostReplyMessage.
`HostReplyMessage(SessionId id, Destination d, long reqID, Properties options)` 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doReadMessage(InputStream in, int size)` doReadMessage.
`protected byte[]`	`doWriteMessage()` doWriteMessage.
`Destination`	`getDestination()` Gets the destination.
`Properties`	`getOptions()` Non-null only if result code is zero and options are present.
`long`	`getReqID()` Gets the request ID.
`int`	`getResultCode()` Gets the result code.
`SessionId`	`getSessionId()` Session id.
`int`	`getType()` Type.
`SessionId`	`sessionId()` Return the SessionId for this message.
`String`	`toString()` Returns a string representation of this message.

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
```
    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_LEASESET_LOOKUP_FAILURE
```
public static final int RESULT_LEASESET_LOOKUP_FAILURE
```
    See Also:
    Constant Field Values
  - RESULT_LOOKUP_TYPE_UNSUPPORTED
```
public static final int RESULT_LOOKUP_TYPE_UNSUPPORTED
```
    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
```
    RESULT_SUCCESS.
    See Also:
    Constant Field Values
- Constructor Detail
  - HostReplyMessage
```
public HostReplyMessage()
```
    HostReplyMessage.
  - HostReplyMessage
```
public HostReplyMessage(SessionId id,
                        Destination d,
                        long reqID,
                        Properties options)
```
    A message with RESULT_SUCCESS and a non-null Destination.
    Parameters:
    id - the session id
    d - non-null
    reqID - 0 to 2**32 - 1
    options - for replies to lookup types 2-4, may be null, see proposal 167
  - HostReplyMessage
```
public HostReplyMessage(SessionId id,
                        int failureCode,
                        long reqID)
```
    A message with a failure code and no Destination.
    Parameters:
    id - the session id
    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
```
    doReadMessage.
    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
```
    doWriteMessage.
    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
  - getOptions
```
public Properties getOptions()
```
    Non-null only if result code is zero and options are present.
    Returns:
    non-null only if result code is zero and options are present
  - 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()
```
    Session id.
    Returns:
    the session id
  - getType
```
public int getType()
```
    Type.
    Returns:
    the type
  - 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()
```
    Returns a string representation of this message.
    Overrides:
    toString in class Object

Class HostReplyMessage

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_TYPE

RESULT_DECRYPTION_FAILURE

RESULT_FAILURE

RESULT_KEY_REQUIRED

RESULT_LEASESET_LOOKUP_FAILURE

RESULT_LOOKUP_TYPE_UNSUPPORTED

RESULT_SECRET_AND_KEY_REQUIRED

RESULT_SECRET_REQUIRED

RESULT_SUCCESS

Constructor Detail

HostReplyMessage

HostReplyMessage

HostReplyMessage

Method Detail

doReadMessage

doWriteMessage

getDestination

getOptions

getReqID

getResultCode

getSessionId

getType

sessionId

toString