org.eclipse.californium.elements

Class UDPConnector

java.lang.Object

org.eclipse.californium.elements.UDPConnector

All Implemented Interfaces:

Connector

Direct Known Subclasses:

UdpMulticastConnector

public class UDPConnector
extends Object
implements Connector

A Connector employing UDP as the transport protocol for exchanging data between networked clients and a server application. It implements the network stage in the Californium architecture. In order to process data received from the network via UDP, client code can register a RawDataChannel instance by means of the setRawDataReceiver(RawDataChannel) method. Sending data out to connected clients can be achieved by means of the send(RawData) method. UDP broadcast is allowed. The number of threads can be set through setReceiverThreadCount(int) and setSenderThreadCount(int) before the connector is started.

Field Summary

Fields

Modifier and Type	Field and Description
protected InetSocketAddress	localAddr
static org.slf4j.Logger	LOGGER
protected boolean	running
static int	UNDEFINED

Constructor Summary

Constructors

Constructor and Description
UDPConnector() Creates a connector on the wildcard address listening on an ephemeral port, i.e.
UDPConnector(InetSocketAddress address) Creates a connector bound to a given IP address and port.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Stops the connector and cleans up any leftovers.
InetSocketAddress	getAddress() Gets the address of the socket this connector is bound to.
String	getProtocol() Returns the protocol of the connector.
int	getReceiveBufferSize()
int	getReceiverPacketSize()
int	getReceiverThreadCount()
int	getSendBufferSize()
int	getSenderThreadCount()
protected void	init(DatagramSocket socket) Initialize connector using the provided socket.
void	send(RawData msg) Sends a raw message to a client via the network.
void	setEndpointContextMatcher(EndpointContextMatcher matcher) Set endpoint context matcher to be used for sending messages.
void	setRawDataReceiver(RawDataChannel receiver) Sets the handler for incoming messages.
void	setReceiveBufferSize(int size)
void	setReceiverPacketSize(int size)
void	setReceiverThreadCount(int count)
void	setSendBufferSize(int size)
void	setSenderThreadCount(int count)
void	start() Starts the connector.
void	stop() Stops the connector.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

UNDEFINED

public static final int UNDEFINED

See Also:

Constant Field Values

running

protected volatile boolean running

localAddr

protected final InetSocketAddress localAddr

Constructor Detail

UDPConnector

public UDPConnector()

Creates a connector on the wildcard address listening on an ephemeral port, i.e. a port chosen by the system. The effect of this constructor is the same as invoking UDPConnector(null).

UDPConnector

public UDPConnector(InetSocketAddress address)

Creates a connector bound to a given IP address and port.

Parameters:

address - the IP address and port, if null the connector is bound to an ephemeral port on the wildcard address

Method Detail

start

public void start()
           throws IOException

Description copied from interface: Connector

Starts the connector. The connector might bind to a socket for instance.

Specified by:

start in interface Connector

Throws:

IOException - Signals that an I/O exception has occurred.

init

protected void init(DatagramSocket socket)
             throws IOException

Initialize connector using the provided socket.

Parameters:

socket - datagram socket for communication

Throws:

IOException - if there is an error in the datagram socket calls.

stop

public void stop()

Description copied from interface: Connector

Stops the connector. All resources such as threads or bound sockets on network interfaces should be stopped and released. A connector that has been stopped using this method can be started again using the Connector.start() method.

Specified by:

stop in interface Connector

destroy

public void destroy()

Description copied from interface: Connector

Stops the connector and cleans up any leftovers. A destroyed connector cannot be expected to be able to start again.

Specified by:

destroy in interface Connector

send

public void send(RawData msg)

Description copied from interface: Connector

Sends a raw message to a client via the network.

This should be a non-blocking operation.

The MessageCallback registered on the message will be notified about the different stages that the message is going through as part of being sent.

Specified by:

send in interface Connector

Parameters:

msg - the message to be sent

setRawDataReceiver

public void setRawDataReceiver(RawDataChannel receiver)

Description copied from interface: Connector

Sets the handler for incoming messages. The handler's RawDataChannel.receiveData(RawData) method will be called whenever a new message from a client has been received via the network.

Specified by:

setRawDataReceiver in interface Connector

Parameters:

receiver - the message handler

setEndpointContextMatcher

public void setEndpointContextMatcher(EndpointContextMatcher matcher)

Description copied from interface: Connector

Set endpoint context matcher to be used for sending messages.

Specified by:

setEndpointContextMatcher in interface Connector

Parameters:

matcher - endpoint context matcher

See Also:

EndpointContextMatcher.isToBeSent(EndpointContext, EndpointContext)

getAddress

public InetSocketAddress getAddress()

Description copied from interface: Connector

Gets the address of the socket this connector is bound to.

Note that the IP address returned might be a wildcard address, indicating that this connector is listening on all network interface's IP addresses.

The connector may have been configured to bind to an ephemeral port. In such cases the concrete port that the connector is bound to will only be known after it has been started.

If the connector is not running, the semantics of the address returned is undefined. It may be a default (wildcard) address or the address the connector has been configured to bind to.

Specified by:

getAddress in interface Connector

Returns:

The IP address and port.

setReceiveBufferSize

public void setReceiveBufferSize(int size)

getReceiveBufferSize

public int getReceiveBufferSize()

setSendBufferSize

public void setSendBufferSize(int size)

getSendBufferSize

public int getSendBufferSize()

setReceiverThreadCount

public void setReceiverThreadCount(int count)

getReceiverThreadCount

public int getReceiverThreadCount()

setSenderThreadCount

public void setSenderThreadCount(int count)

getSenderThreadCount

public int getSenderThreadCount()

setReceiverPacketSize

public void setReceiverPacketSize(int size)

getReceiverPacketSize

public int getReceiverPacketSize()

getProtocol

public String getProtocol()

Description copied from interface: Connector

Returns the protocol of the connector.

Specified by:

getProtocol in interface Connector

Returns:

protocol e.g. "UDP", "DTLS", "TCP", or "TLS"

toString

public String toString()

Overrides:

toString in class Object