Package org.openremote.agent.protocol.udp

Class AbstractUDPServer<T>

java.lang.Object

org.openremote.agent.protocol.io.AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

org.openremote.agent.protocol.udp.AbstractUDPServer<T>

All Implemented Interfaces:

IOServer<T,io.netty.channel.socket.DatagramChannel,InetSocketAddress>

Direct Known Subclasses:

UDPStringServer

public abstract class AbstractUDPServer<T>
extends AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

UDP in Netty is crap; everything goes through the single server channel as it is connectionless but there is no way of tracking packet origin across decoders. From reading each channel is single threaded so making an assumption that we can store packet origin for processing in AbstractNettyIOServer.onMessageReceived(T, U, W). For outbound messages we wrap each decoder in a DatagramPacketEncoder which unfortunately only supports MessageToMessageEncoders.

Nested Class Summary

Nested classes/interfaces inherited from interface org.openremote.agent.protocol.io.IOServer

IOServer.IoServerMessageConsumer<T,U,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected InetSocketAddress	lastMessageSender
protected InetSocketAddress	localAddress

Fields inherited from class org.openremote.agent.protocol.io.AbstractNettyIOServer

allChannels, bootstrap, channel, channelFuture, clientConnectionStatusConsumers, clientLimit, connectionStatus, connectionStatusConsumers, executorService, INITIAL_RECONNECT_DELAY_MILLIS, LOG, MAX_RECONNECT_DELAY_MILLIS, messageConsumers, RECONNECT_BACKOFF_MULTIPLIER, reconnectDelayMilliseconds, reconnectTask, scheduledExecutorService, workerGroup

Constructor Summary

Constructors

Constructor	Description
AbstractUDPServer(InetSocketAddress localAddress)

Method Summary

Modifier and Type	Method	Description
protected void	addEncoder(io.netty.channel.socket.DatagramChannel channel, io.netty.channel.ChannelOutboundHandler encoder)
protected io.netty.bootstrap.Bootstrap	createAndConfigureBootstrap()	Create and configure the bootstrap to use for this instance
protected String	getClientDescriptor(io.netty.channel.socket.DatagramChannel client)	Should return a descriptor to identify the specified client for use in log files etc.
protected String	getSocketAddressString()	Get a string identifier that uniquely identifies the current instance of this server.
protected void	handleMessageReceived(io.netty.channel.socket.DatagramChannel channel, T message)
protected void	initChannel(io.netty.channel.socket.DatagramChannel channel)
void	sendMessage(T message)	Send a message to all clients
void	sendMessage(T message, io.netty.channel.socket.DatagramChannel client)	Send a message to a client
void	sendMessage(T message, InetSocketAddress destination)	Send a message to a recipient by address; for connection based protocols then the recipient must already be connected; this is mostly useful for connectionless protocols (i.e.

Methods inherited from class org.openremote.agent.protocol.io.AbstractNettyIOServer

addConnectionStatusConsumer, addConnectionStatusConsumer, addDecoder, addDecoders, addEncoders, addMessageConsumer, disconnectClient, getConnectionStatus, getConnectionStatus, initClientChannel, onClientConnected, onClientDisconnected, onConnectionStatusChanged, onDecodeException, onEncodeException, onMessageReceived, removeAllConnectionStatusConsumers, removeAllMessageConsumers, removeConnectionStatusConsumer, removeConnectionStatusConsumer, removeMessageConsumer, scheduleReconnect, sendClientConnectionStatus, start, stop

Methods inherited from class java.lang.Object

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

Field Details

localAddress

protected InetSocketAddress localAddress

lastMessageSender

protected InetSocketAddress lastMessageSender

Constructor Details

AbstractUDPServer

public AbstractUDPServer(InetSocketAddress localAddress)

Method Details

getSocketAddressString

protected String getSocketAddressString()

Description copied from class: AbstractNettyIOServer

Get a string identifier that uniquely identifies the current instance of this server. e.g. tcp://IP:PORT

Specified by:

getSocketAddressString in class AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

getClientDescriptor

protected String getClientDescriptor(io.netty.channel.socket.DatagramChannel client)

Description copied from class: AbstractNettyIOServer

Should return a descriptor to identify the specified client for use in log files etc.

Specified by:

getClientDescriptor in class AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

createAndConfigureBootstrap

protected io.netty.bootstrap.Bootstrap createAndConfigureBootstrap()

Description copied from class: AbstractNettyIOServer

Create and configure the bootstrap to use for this instance

Specified by:

createAndConfigureBootstrap in class AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

initChannel

protected void initChannel(io.netty.channel.socket.DatagramChannel channel)

Overrides:

initChannel in class AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

sendMessage

public void sendMessage(T message)

Description copied from interface: IOServer

Send a message to all clients

Specified by:

sendMessage in interface IOServer<T,io.netty.channel.socket.DatagramChannel,InetSocketAddress>

Overrides:

sendMessage in class AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

sendMessage

public void sendMessage(T message,
 io.netty.channel.socket.DatagramChannel client)

Description copied from interface: IOServer

Send a message to a client

Specified by:

sendMessage in interface IOServer<T,io.netty.channel.socket.DatagramChannel,InetSocketAddress>

Overrides:

sendMessage in class AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

sendMessage

public void sendMessage(T message,
 InetSocketAddress destination)

Description copied from class: AbstractNettyIOServer

Send a message to a recipient by address; for connection based protocols then the recipient must already be connected; this is mostly useful for connectionless protocols (i.e. UDP where only a single channel exists)

Overrides:

sendMessage in class AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

addEncoder

protected void addEncoder(io.netty.channel.socket.DatagramChannel channel,
 io.netty.channel.ChannelOutboundHandler encoder)

Overrides:

addEncoder in class AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>

handleMessageReceived

protected void handleMessageReceived(io.netty.channel.socket.DatagramChannel channel,
 T message)

Overrides:

handleMessageReceived in class AbstractNettyIOServer<T,io.netty.channel.socket.DatagramChannel,io.netty.bootstrap.Bootstrap,InetSocketAddress>