org.eclipse.californium.scandium.dtls

Class MultiNodeConnectionIdGenerator

java.lang.Object

org.eclipse.californium.scandium.dtls.MultiNodeConnectionIdGenerator

All Implemented Interfaces:

ConnectionIdGenerator, NodeConnectionIdGenerator

public class MultiNodeConnectionIdGenerator
extends Object
implements NodeConnectionIdGenerator

Connection id generator for multiple nodes systems (cluster). Encodes node id into first byte of generated connection id. The node id must be unique in the cluster, to ensure, that other nodes of the cluster don't generate the same connection id.

Constructor Summary

Constructors

Constructor and Description
MultiNodeConnectionIdGenerator(int nodeId, int connectionIdLength) Create new connection id generator for multiple nodes.

Method Summary

Methods

Modifier and Type	Method and Description
ConnectionId	createConnectionId() Creates a connection id.
int	getNodeId() Get node ID of generator.
int	getNodeId(ConnectionId cid) Get node ID encoded in cid.
ConnectionId	read(org.eclipse.californium.elements.util.DatagramReader reader) Read connection id from record header bytes.
boolean	useConnectionId() Indicates, if connection ids are used or just supported.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiNodeConnectionIdGenerator

public MultiNodeConnectionIdGenerator(int nodeId,
                              int connectionIdLength)

Create new connection id generator for multiple nodes.

Parameters:

nodeId - node id of this node. The lowest byte must be unique in the cluster, to ensure, that other nodes of the cluster don't generate the same connection id.

connectionIdLength - length of connection id

Throws:

IllegalArgumentException - if length is less than 2 bytes

Method Detail

useConnectionId

public boolean useConnectionId()

Description copied from interface: ConnectionIdGenerator

Indicates, if connection ids are used or just supported.

Specified by:

useConnectionId in interface ConnectionIdGenerator

Returns:

true, if a connection is used, false, if only a connection id from the other peer is supported.

createConnectionId

public ConnectionId createConnectionId()

Creates a connection id. The caller must take care to use only unique connection ids. In cases where the generated connection id is already in use, it's intended to create a next connection id calling this method again. Places the nodeId into the first byte of the connection id.

Specified by:

createConnectionId in interface ConnectionIdGenerator

Returns:

created connection id or null, if this generator only supports connection ids from the other peer.

read

public ConnectionId read(org.eclipse.californium.elements.util.DatagramReader reader)

Read connection id from record header bytes. Returns null, if nodeId doesn't match the first byte of the connection id.

Specified by:

read in interface ConnectionIdGenerator

Parameters:

reader - reader with header bytes at the position of the connection id.

Returns:

read connection id or null, if this generator only supports connection ids from the other peer.

getNodeId

public int getNodeId()

Description copied from interface: NodeConnectionIdGenerator

Get node ID of generator.

Specified by:

getNodeId in interface NodeConnectionIdGenerator

Returns:

node ID

getNodeId

public int getNodeId(ConnectionId cid)

Description copied from interface: NodeConnectionIdGenerator

Get node ID encoded in cid.

Specified by:

getNodeId in interface NodeConnectionIdGenerator

Parameters:

cid - cid

Returns:

node ID