org.eclipse.californium.elements

Interface Connector

All Known Implementing Classes:

UDPConnector, UdpMulticastConnector

public interface Connector

A managed interface for exchanging messages between networked clients and a server application. An implementation usually binds to a socket on a local network interface in order to communicate with clients. After the start() method has been invoked, applications can use the send(RawData) method to send messages (wrapped in a RawData object) to a client via the network. Processing of messages received from clients is delegated to the handler registered via the setRawDataReceiver(RawDataChannel) method. Implementations of the send(RawData) method should be non-blocking to allow the server application to continue working on other tasks. This could be achieved by buffering outbound messages in a queue and off-loading the sending of messages via the network to a separate Thread.

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.
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 messageHandler) Sets the handler for incoming messages.
void	start() Starts the connector.
void	stop() Stops the connector.

Method Detail

start

void start()
           throws IOException

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

Throws:

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

stop

void stop()

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 start() method.

destroy

void destroy()

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

send

void send(RawData msg)

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.

Parameters:

msg - the message to be sent

Throws:

NullPointerException - if the message is null.

IllegalArgumentException - if the message cannot be sent due to formal constraints, e.g. because the message's payload is too large.

IllegalStateException - if the connector has not been started.

setRawDataReceiver

void setRawDataReceiver(RawDataChannel messageHandler)

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.

Parameters:

messageHandler - the message handler

Throws:

IllegalStateException - if the connector is running.

setEndpointContextMatcher

void setEndpointContextMatcher(EndpointContextMatcher matcher)

Set endpoint context matcher to be used for sending messages.

Parameters:

matcher - endpoint context matcher

See Also:

EndpointContextMatcher.isToBeSent(EndpointContext, EndpointContext)

getAddress

InetSocketAddress getAddress()

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.

Returns:

The IP address and port.

getProtocol

String getProtocol()

Returns the protocol of the connector.

Returns:

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