Package org.openremote.agent.protocol.tcp

Class AbstractTCPServer<T>

java.lang.Object

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

org.openremote.agent.protocol.tcp.AbstractTCPServer<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

TCPStringServer

public abstract class AbstractTCPServer<T>
extends AbstractNettyIOServer<T,io.netty.channel.socket.SocketChannel,io.netty.bootstrap.ServerBootstrap,InetSocketAddress>

Abstract IO Server for creating TCP socket servers that clients can connect to. Concrete implementation need to configure the pipeline with the necessary encoders and decoders to ensure messages of type <T> are generated/consumed at/from the end/start of the pipeline.

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 SocketAddress	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, workerGroup

Constructor Summary

Constructors

Constructor	Description
AbstractTCPServer(InetSocketAddress localAddress)

Method Summary

Modifier and Type	Method	Description
protected io.netty.bootstrap.ServerBootstrap	createAndConfigureBootstrap()	Create and configure the bootstrap to use for this instance
protected String	getClientDescriptor(io.netty.channel.socket.SocketChannel client)	Should return a descriptor to identify the speficied client for use in log files etc.
protected String	getSocketAddressString()	Get a string identifier that uniquely identifies the current instance of this server.

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

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

Methods inherited from class java.lang.Object

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

Field Details

localAddress

protected SocketAddress localAddress

Constructor Details

AbstractTCPServer

public AbstractTCPServer(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.SocketChannel,io.netty.bootstrap.ServerBootstrap,InetSocketAddress>

createAndConfigureBootstrap

protected io.netty.bootstrap.ServerBootstrap 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.SocketChannel,io.netty.bootstrap.ServerBootstrap,InetSocketAddress>

getClientDescriptor

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

Description copied from class: AbstractNettyIOServer

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

Specified by:

getClientDescriptor in class AbstractNettyIOServer<T,io.netty.channel.socket.SocketChannel,io.netty.bootstrap.ServerBootstrap,InetSocketAddress>