net.solarnetwork.io.modbus.tcp.netty

Class TcpNettyModbusClient

java.lang.Object

net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<TcpModbusClientConfig>

net.solarnetwork.io.modbus.tcp.netty.TcpNettyModbusClient

All Implemented Interfaces:

net.solarnetwork.io.modbus.ModbusClient

public class TcpNettyModbusClient
extends net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<TcpModbusClientConfig>

TCP implementation of ModbusClient.

Nested Class Summary

Nested classes/interfaces inherited from class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient

net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage

Field Summary

Fields inherited from class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient

CLIENT_HANDLER_NAME, clientConfig, DEFAULT_PENDING_MESSAGE_TTL, DEFAULT_REPLY_TIMEOUT, LAST_ENCODED_MESSAGE, log, MESSAGE_DECODER_HANDLER_NAME, MESSAGE_ENCODER_HANDLER_NAME, WIRE_LOGGING_HANDLER_NAME

Constructor Summary

Constructors

Constructor and Description
TcpNettyModbusClient(TcpModbusClientConfig clientConfig) Constructor.
TcpNettyModbusClient(TcpModbusClientConfig clientConfig, ConcurrentMap<net.solarnetwork.io.modbus.ModbusMessage,net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage> pending, ConcurrentMap<Integer,TcpModbusMessage> pendingMessages, IntSupplier transactionIdSupplier) Constructor.
TcpNettyModbusClient(TcpModbusClientConfig clientConfig, io.netty.channel.EventLoopGroup eventLoopGroup, Class<? extends io.netty.channel.Channel> channelClass) Constructor.
TcpNettyModbusClient(TcpModbusClientConfig clientConfig, ScheduledExecutorService scheduler, ConcurrentMap<net.solarnetwork.io.modbus.ModbusMessage,net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage> pending, io.netty.channel.EventLoopGroup eventLoopGroup, Class<? extends io.netty.channel.Channel> channelClass, ConcurrentMap<Integer,TcpModbusMessage> pendingMessages, IntSupplier transactionIdSupplier) Constructor.

Method Summary

Modifier and Type	Method and Description
protected io.netty.channel.ChannelFuture	connect()
protected void	initChannel(io.netty.channel.Channel channel)
CompletableFuture<?>	stop()

Methods inherited from class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient

getClientConfig, getConnectionObserver, getPendingMessageTtl, getReplyTimeout, isConnected, isStarted, isWireLogging, newModbusChannelHandler, send, sendAsync, setConnectionObserver, setPendingMessageTtl, setReplyTimeout, setWireLogging, start

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpNettyModbusClient

public TcpNettyModbusClient(TcpModbusClientConfig clientConfig)

Constructor.

A default EventLoopGroup will be used.

Parameters:

clientConfig - the client configuration

TcpNettyModbusClient

public TcpNettyModbusClient(TcpModbusClientConfig clientConfig,
                            io.netty.channel.EventLoopGroup eventLoopGroup,
                            Class<? extends io.netty.channel.Channel> channelClass)

Constructor.

Parameters:

clientConfig - the client configuration

eventLoopGroup - the event loop group, or null to create an internal one

channelClass - the channel class, or null to use a default EventLoopGroup

TcpNettyModbusClient

public TcpNettyModbusClient(TcpModbusClientConfig clientConfig,
                            ConcurrentMap<net.solarnetwork.io.modbus.ModbusMessage,net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage> pending,
                            ConcurrentMap<Integer,TcpModbusMessage> pendingMessages,
                            IntSupplier transactionIdSupplier)

Constructor.

A default EventLoopGroup will be used.

Parameters:

clientConfig - the client configuration

pending - a map for request messages pending responses

pendingMessages - a mapping of transaction IDs to associated pendingMessages, to handle request and response pairing

transactionIdSupplier - a TCP Modbus transaction ID supplier; only values from 1-65535 should be supplied

Throws:

IllegalArgumentException - if any argument is null

TcpNettyModbusClient

public TcpNettyModbusClient(TcpModbusClientConfig clientConfig,
                            ScheduledExecutorService scheduler,
                            ConcurrentMap<net.solarnetwork.io.modbus.ModbusMessage,net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage> pending,
                            io.netty.channel.EventLoopGroup eventLoopGroup,
                            Class<? extends io.netty.channel.Channel> channelClass,
                            ConcurrentMap<Integer,TcpModbusMessage> pendingMessages,
                            IntSupplier transactionIdSupplier)

Constructor.

Parameters:

clientConfig - the client configuration

scheduler - the scheduler, or null to create an internal one

pending - a map for request messages pending responses

eventLoopGroup - the event loop group, or null to create an internal one

channelClass - the channel class, or null to use a default EventLoopGroup

pendingMessages - a mapping of transaction IDs to associated pendingMessages, to handle request and response pairing

transactionIdSupplier - a TCP Modbus transaction ID supplier; only values from 1-65535 should be supplied

Throws:

IllegalArgumentException - if any argument is null

Method Detail

connect

protected io.netty.channel.ChannelFuture connect()
                                          throws IOException

Specified by:

connect in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<TcpModbusClientConfig>

Throws:

IOException

stop

public CompletableFuture<?> stop()

Specified by:

stop in interface net.solarnetwork.io.modbus.ModbusClient

Overrides:

stop in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<TcpModbusClientConfig>

initChannel

protected void initChannel(io.netty.channel.Channel channel)

Overrides:

initChannel in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<TcpModbusClientConfig>