ClientMessage (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.ClientMessage

```
public class ClientMessage
extends Object
```
Wrap a message either destined for a local client or received from one. Note that an outbound message may get routed as an inbound message for local-local communication.

Constructor Summary

Constructors
Constructor and Description
`ClientMessage(Destination toDest, Payload payload, SessionConfig config, Destination fromDest, MessageId msgID, long messageNonce, long expiration, int flags)` For outbound (locally originated)
`ClientMessage(Hash toDestHash, Payload payload)` For inbound (from remote dest)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Destination`	`getDestination()` Retrieve the destination to which this message is directed.
`Hash`	`getDestinationHash()` Retrieve the destination to which this message is directed.
`long`	`getExpiration()` Expiration requested by the client that sent the message.
`int`	`getFlags()` Flags requested by the client that sent the message.
`Destination`	`getFromDestination()` Valid for outbound; null for inbound.
`MessageId`	`getMessageId()` Valid for outbound; null for inbound.
`long`	`getMessageNonce()` Valid for outbound; 0 for inbound.
`Payload`	`getPayload()` Retrieve the payload of the message.
`SessionConfig`	`getSenderConfig()` Retrieve the session config of the client that sent the message.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClientMessage
```
public ClientMessage(Destination toDest,
                     Payload payload,
                     SessionConfig config,
                     Destination fromDest,
                     MessageId msgID,
                     long messageNonce,
                     long expiration,
                     int flags)
```
    For outbound (locally originated)
    Parameters:
    toDest - the destination to send to
    payload - the message payload
    config - the session config of the sending client
    fromDest - the source destination
    msgID - the router's ID for this message
    messageNonce - the client's ID for this message
    expiration - the expiration time
    flags - the message flags
  - ClientMessage
```
public ClientMessage(Hash toDestHash,
                     Payload payload)
```
    For inbound (from remote dest)
    Parameters:
    toDestHash - the destination hash
    payload - the message payload
- Method Detail
  - getDestination
```
public Destination getDestination()
```
    Retrieve the destination to which this message is directed. Valid for outbound; null for inbound. If null, use getDestinationHash()
    Returns:
    the destination
  - getDestinationHash
```
public Hash getDestinationHash()
```
    Retrieve the destination to which this message is directed. Valid for inbound; null for outbound. If null, use getDestination()
    Returns:
    the destination hash
  - getExpiration
```
public long getExpiration()
```
    Expiration requested by the client that sent the message. This will only be available for locally originated messages.
    Returns:
    the expiration
  - getFlags
```
public int getFlags()
```
    Flags requested by the client that sent the message. This will only be available for locally originated messages.
    Returns:
    the flags
  - getFromDestination
```
public Destination getFromDestination()
```
    Valid for outbound; null for inbound.
    Returns:
    the from destination
  - getMessageId
```
public MessageId getMessageId()
```
    Valid for outbound; null for inbound.
    Returns:
    the message ID
  - getMessageNonce
```
public long getMessageNonce()
```
    Valid for outbound; 0 for inbound.
    Returns:
    the message nonce
  - getPayload
```
public Payload getPayload()
```
    Retrieve the payload of the message. All ClientMessage objects should have a payload
    Returns:
    the payload
  - getSenderConfig
```
public SessionConfig getSenderConfig()
```
    Retrieve the session config of the client that sent the message. This will only be available if the client was local
    Returns:
    the session config

Class ClientMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientMessage

ClientMessage

Method Detail

getDestination

getDestinationHash

getExpiration

getFlags

getFromDestination

getMessageId

getMessageNonce

getPayload

getSenderConfig