org.eclipse.californium.elements

Interface Connector

All Known Implementing Classes:

ConnectorBase, UDPConnector

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.
void	send(RawData msg) Sends a raw message to a client via the network.
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.

Parameters:

msg - the message to be sent

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

getAddress

InetSocketAddress getAddress()

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

Returns:

the address