org.eclipse.californium.elements

Class ConnectorBase

java.lang.Object

org.eclipse.californium.elements.ConnectorBase

All Implemented Interfaces:

Connector

public abstract class ConnectorBase
extends Object
implements Connector

ConnectorBase is a partial implementation of a Connector. It connects a server to a network interface and a port. ConnectorBase contains two separate threads for sending and receiving. The receiver thread constantly calls #receiveNext() which is supposed to listen on a socket until a datagram arrives and forward it to the RawDataChannel. The sender thread constantly calls #sendNext() which is supposed to wait on the outgoing queue for a RawData message to send. Both #sendNext() and #receiveNext() are expected to be blocking.

Constructor Summary

Constructors

Constructor and Description
ConnectorBase(InetSocketAddress address) Instantiates a new connector base.

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.
InetSocketAddress	getLocalAddr() Gets the local address this connector is listening to.
abstract String	getName() Gets the name of the connector, e.g.
RawDataChannel	getReceiver() Gets the receiver.
protected int	getReceiverThreadCount() Gets the receiver thread count.
protected int	getSenderThreadCount() Gets the sender thread count.
boolean	isRunning() Checks the connector has started but not stopped yet.
protected abstract RawData	receiveNext() Receives data from the socket queue.
void	send(RawData msg) Sends a raw message to a client via the network.
protected abstract void	sendNext(RawData raw) Sends data over the socket.
void	setRawDataReceiver(RawDataChannel receiver) Sets the handler for incoming messages.
void	setReceiver(RawDataChannel receiver) Sets the receiver for incoming messages.
void	start() Starts the connector.
void	stop() Stops the connector.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectorBase

public ConnectorBase(InetSocketAddress address)

Instantiates a new connector base.

Parameters:

address - the address to listen to

Method Detail

getAddress

public InetSocketAddress getAddress()

Description copied from interface: Connector

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

Specified by:

getAddress in interface Connector

Returns:

the address

getName

public abstract String getName()

Gets the name of the connector, e.g. the transport protocol used such as UDP or DTlS.

Returns:

the name

receiveNext

protected abstract RawData receiveNext()
                                throws Exception

Receives data from the socket queue.

Returns:

the received raw data with metadata

Throws:

Exception - any exceptions that should be properly logged

sendNext

protected abstract void sendNext(RawData raw)
                          throws Exception

Sends data over the socket.

Parameters:

raw - the raw data with metadata

Throws:

Exception - any exception that should be properly logged

getReceiverThreadCount

protected int getReceiverThreadCount()

Gets the receiver thread count.

Returns:

the receiver thread count

getSenderThreadCount

protected int getSenderThreadCount()

Gets the sender thread count.

Returns:

the sender thread count

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.

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()

Stops the connector and cleans up any leftovers. A destroyed connector cannot be expected to be able to start again. Note that this does not call stop() but the subclass has to do that if required.

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.

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

getLocalAddr

public InetSocketAddress getLocalAddr()

Gets the local address this connector is listening to.

Returns:

the local address

getReceiver

public RawDataChannel getReceiver()

Gets the receiver.

Returns:

the receiver

setReceiver

public void setReceiver(RawDataChannel receiver)

Sets the receiver for incoming messages.

Parameters:

receiver - the new receiver

isRunning

public boolean isRunning()

Checks the connector has started but not stopped yet.

Returns:

true, if is running