net.solarnetwork.io.modbus.tcp.netty

Class NettyTcpModbusServer

java.lang.Object

net.solarnetwork.io.modbus.tcp.netty.NettyTcpModbusServer

public class NettyTcpModbusServer
extends Object

A basic asynchronous Modbus TCP server.

This server listens for Modbus requests, decodes them into ModbusMessage instances, and then passes those to the handler configured via setMessageHandler(BiConsumer). The handler must provide a response ModbusMessage, which this server will then encode and send back to the connected client.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_BIND_ADDRESS	The default bindAddress property value.
static long	DEFAULT_PENDING_MESSAGE_TTL	The pendingMessageTtl property default value.

Constructor Summary

Constructors

Constructor	Description
NettyTcpModbusServer(int port)	Constructor.
NettyTcpModbusServer(int port, ConcurrentMap<Integer,TcpModbusMessage> pendingMessages, IntSupplier transactionIdSupplier)	Constructor.
NettyTcpModbusServer(String bindAddress, int port)	Constructor.
NettyTcpModbusServer(String bindAddress, int port, ConcurrentMap<Integer,TcpModbusMessage> pendingMessages, IntSupplier transactionIdSupplier)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getBindAddress()	Get the address the server will listen on.
BiFunction<InetSocketAddress,Boolean,Boolean>	getClientConnectionListener()	Get an optional listener for client connection events.
BiConsumer<net.solarnetwork.io.modbus.ModbusMessage,Consumer<net.solarnetwork.io.modbus.ModbusMessage>>	getMessageHandler()	Get the message handler.
long	getPendingMessageTtl()	Get the pending Modbus message time-to-live expiration time.
int	getPort()	Get the port the server is listening to.
boolean	isWireLogging()	Get the "wire logging" setting.
void	setClientConnectionListener(BiFunction<InetSocketAddress,Boolean,Boolean> clientConnectionListener)	Set an optional listener for client connection events.
void	setMessageHandler(BiConsumer<net.solarnetwork.io.modbus.ModbusMessage,Consumer<net.solarnetwork.io.modbus.ModbusMessage>> messageHandler)	Set the message handler.
void	setPendingMessageTtl(long pendingMessageTtl)	Set the pending Modbus message time-to-live expiration time.
void	setWireLogging(boolean wireLogging)	Set the "wire logging" setting.
void	start()	Start the server.
void	stop()	Stop the server.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PENDING_MESSAGE_TTL

public static final long DEFAULT_PENDING_MESSAGE_TTL

The pendingMessageTtl property default value.

DEFAULT_BIND_ADDRESS

public static final String DEFAULT_BIND_ADDRESS

The default bindAddress property value.

See Also:

Constant Field Values

Constructor Detail

NettyTcpModbusServer

public NettyTcpModbusServer(int port)

Constructor.

Defaults to DEFAULT_BIND_ADDRESS.

Parameters:

port - the port to listen on

Throws:

IllegalArgumentException - if any argument is null

NettyTcpModbusServer

public NettyTcpModbusServer(String bindAddress,
                            int port)

Constructor.

Parameters:

bindAddress - the address to listen on

port - the port to listen on

Throws:

IllegalArgumentException - if any argument is null

NettyTcpModbusServer

public NettyTcpModbusServer(int port,
                            ConcurrentMap<Integer,TcpModbusMessage> pendingMessages,
                            IntSupplier transactionIdSupplier)

Constructor.

Defaults to DEFAULT_BIND_ADDRESS.

Parameters:

port - the port to listen on

pendingMessages - a map to use for saving request messages, using transaction IDs for keys

transactionIdSupplier - the transaction ID supplier

Throws:

IllegalArgumentException - if any argument is null

NettyTcpModbusServer

public NettyTcpModbusServer(String bindAddress,
                            int port,
                            ConcurrentMap<Integer,TcpModbusMessage> pendingMessages,
                            IntSupplier transactionIdSupplier)

Constructor.

Parameters:

bindAddress - the address to listen on

port - the port to listen on

pendingMessages - a map to use for saving request messages, using transaction IDs for keys

transactionIdSupplier - the transaction ID supplier

Throws:

IllegalArgumentException - if any argument is null

Method Detail

start

public void start()
           throws IOException

Start the server.

Upon return the server will be bound and ready to accept connections on the configured port.

Throws:

IOException

stop

public void stop()

Stop the server.

getBindAddress

public String getBindAddress()

Get the address the server will listen on.

Returns:

the socket bind address; defaults to DEFAULT_BIND_ADDRESS

getPort

public int getPort()

Get the port the server is listening to.

Returns:

the port

getMessageHandler

public BiConsumer<net.solarnetwork.io.modbus.ModbusMessage,Consumer<net.solarnetwork.io.modbus.ModbusMessage>> getMessageHandler()

Get the message handler.

Returns:

the handler

setMessageHandler

public void setMessageHandler(BiConsumer<net.solarnetwork.io.modbus.ModbusMessage,Consumer<net.solarnetwork.io.modbus.ModbusMessage>> messageHandler)

Set the message handler.

This handler will be passed an inbound message along with another Consumer for the reply message.

Parameters:

messageHandler - the handler to set

getClientConnectionListener

public BiFunction<InetSocketAddress,Boolean,Boolean> getClientConnectionListener()

Get an optional listener for client connection events.

Returns:

a client connection listener, or null

See Also:

setClientConnectionListener(BiFunction)

setClientConnectionListener

public void setClientConnectionListener(BiFunction<InetSocketAddress,Boolean,Boolean> clientConnectionListener)

Set an optional listener for client connection events.

The client remote address is passed to the consumer as the first argument. When a client connects, true will be passed as the second argument; when a client disconnects, false will be passed.

The return argument is inspected only after a connection event. If false is returned, the client connection will be closed. This provides a way to deny a client connection.

Parameters:

clientConnectionListener - the client connection listener, or null

isWireLogging

public boolean isWireLogging()

Get the "wire logging" setting.

Returns:

true to enable wire-level logging of all messages

setWireLogging

public void setWireLogging(boolean wireLogging)

Set the "wire logging" setting.

Parameters:

wireLogging - true to enable wire-level logging of all messages

getPendingMessageTtl

public long getPendingMessageTtl()

Get the pending Modbus message time-to-live expiration time.

Returns:

the pendingMessageTtl the pending Modbus message time-to-live, in milliseconds; defaults to DEFAULT_PENDING_MESSAGE_TTL

setPendingMessageTtl

public void setPendingMessageTtl(long pendingMessageTtl)

Set the pending Modbus message time-to-live expiration time.

This timeout represents the minimum amount of time the client will wait for a Modbus message response, before it qualifies for removal from the pending message queue.

Parameters:

pendingMessageTtl - the pending Modbus message time-to-live, in milliseconds