org.eclipse.californium.elements

Class RawData

java.lang.Object

org.eclipse.californium.elements.RawData

public final class RawData
extends Object

A container object for the data received or sent via a Connector. The following meta-data is included:

• the peer's endpoint context, containing it's address, optional principal, and optional correlation information
• a flag indicating whether the message is a multicast message (default is false)

A message received from a client via the network may also optionally contain the authenticated sender's identity as a Principal object.

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	bytes The raw message.

Method Summary

Methods

Modifier and Type	Method and Description
InetAddress	getAddress() Gets the address.
byte[]	getBytes() Gets the raw message.
EndpointContext	getEndpointContext() Gets additional information regarding the context this message has been received in or should be sent in.
InetSocketAddress	getInetSocketAddress() Gets the source/destination IP address and port.
int	getPort() Gets the port.
Principal	getSenderIdentity() Gets the identity of the sender of the message.
int	getSize() Gets the length of the serialized message
static RawData	inbound(byte[] data, EndpointContext peerEndpointContext, boolean isMulticast) Instantiates a new raw data for a message received from a peer.
boolean	isMulticast() Checks if this is a multicast message
void	onConnecting() Callback, when connector requires to establish a connection.
void	onContextEstablished(EndpointContext context) Callback, when context gets available.
void	onDtlsRetransmission(int flight) Callback, when the dtls connector retransmits a handshake flight.
void	onError(Throwable error) Called, when message was not sent by the connector.
void	onSent() Callback after message was sent by the connector.
static RawData	outbound(byte[] data, EndpointContext peerEndpointContext, MessageCallback callback, boolean useMulticast) Instantiates a new raw data for a message to be sent to a peer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bytes

public final byte[] bytes

The raw message.

Method Detail

inbound

public static RawData inbound(byte[] data,
              EndpointContext peerEndpointContext,
              boolean isMulticast)

Instantiates a new raw data for a message received from a peer.

Parameters:

data - the data that is to be sent or has been received.

peerEndpointContext - information regarding the context the message has been received in. The information contained will usually come from the transport layer, e.g. the ID of the DTLS session the message has been received in, and can be used to correlate this message with another (previously sent) message.

isMulticast - indicates whether the data has been received as a multicast message.

Returns:

the raw data object containing the inbound message.

Throws:

NullPointerException - if data or address is null.

outbound

public static RawData outbound(byte[] data,
               EndpointContext peerEndpointContext,
               MessageCallback callback,
               boolean useMulticast)

Instantiates a new raw data for a message to be sent to a peer.

The given callback handler is notified when the message has been sent by a Connector. The information contained in the MessageContext object that is passed in to the handler may be relevant for matching a response received via a RawDataChannel to a request sent using this method, e.g. when using a DTLS based connector the context may contain the DTLS session ID and epoch number which is required to match a response to a request as defined in the CoAP specification.

The message context is set via a callback in order to allow Connector implementations to process (send) messages asynchronously.

Parameters:

data - the data to send.

peerEndpointContext - remote peer's endpoint context to send data.

callback - the handler to call when this message has been sent (may be null).

useMulticast - indicates whether the data should be sent using a multicast message.

Returns:

the raw data object containing the outbound message.

Throws:

NullPointerException - if data or peerContext is null.

getBytes

public byte[] getBytes()

Gets the raw message.

Returns:

a copy of the raw message bytes

getSize

public int getSize()

Gets the length of the serialized message

Returns:

the size

getAddress

public InetAddress getAddress()

Gets the address.

Returns:

the address

getPort

public int getPort()

Gets the port.

Returns:

the port

isMulticast

public boolean isMulticast()

Checks if this is a multicast message

Returns:

true, if this is a multicast message

getInetSocketAddress

public InetSocketAddress getInetSocketAddress()

Gets the source/destination IP address and port.

Returns:

the address

getSenderIdentity

public Principal getSenderIdentity()

Gets the identity of the sender of the message. This property is only meaningful for messages received from a client.

Returns:

the identity or null if the sender has not been authenticated

getEndpointContext

public EndpointContext getEndpointContext()

Gets additional information regarding the context this message has been received in or should be sent in.

Returns:

the message context including the endpoint information

onConnecting

public void onConnecting()

Callback, when connector requires to establish a connection. Not called, if the connection is already established or the connector doesn't require to establish a connection.

onDtlsRetransmission

public void onDtlsRetransmission(int flight)

Callback, when the dtls connector retransmits a handshake flight.

Parameters:

flight - 1 ... 6, number of retransmitted flight.

onContextEstablished

public void onContextEstablished(EndpointContext context)

Callback, when context gets available. Used on sending an message.

Parameters:

context - established context to be forwarded to the callback.

onSent

public void onSent()

Callback after message was sent by the connector.

onError

public void onError(Throwable error)

Called, when message was not sent by the connector.

Parameters:

error - details for not sending the message. If null, UnknownError is used to call MessageCallback.onError(Throwable).