com.ghgande.j2mod.modbus.net

Class ModbusTCPListener

java.lang.Object

com.ghgande.j2mod.modbus.net.AbstractModbusListener

com.ghgande.j2mod.modbus.net.ModbusTCPListener

All Implemented Interfaces:

Runnable

public class ModbusTCPListener
extends AbstractModbusListener

Class that implements a ModbusTCPListener.

If listening, it accepts incoming requests passing them on to be handled. If not listening, silently drops the requests.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Julie Haugh, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
ModbusTCPListener(int poolsize) /** Constructs a ModbusTCPListener instance.
ModbusTCPListener(int poolsize, boolean useRtuOverTcp) /** Constructs a ModbusTCPListener instance.
ModbusTCPListener(int poolsize, InetAddress addr) Constructs a ModbusTCPListener instance.
ModbusTCPListener(int poolsize, InetAddress addr, boolean useRtuOverTcp) Constructs a ModbusTCPListener instance.

Method Summary

Modifier and Type	Method and Description
void	run()
void	setMaxIdleSeconds(int maxIdleSeconds) Sets a maximum time a connection can be idle, i.e.
void	setTimeout(int timeout) Sets the socket timeout
void	stop() Stop the listener thread for this ModbusListener instance.

Methods inherited from class com.ghgande.j2mod.modbus.net.AbstractModbusListener

getAddress, getError, getPort, getProcessImage, getThreadName, getTimeout, isListening, setAddress, setListening, setPort, setThreadName

Methods inherited from class java.lang.Object

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

Constructor Detail

ModbusTCPListener

public ModbusTCPListener(int poolsize,
                         InetAddress addr)

Constructs a ModbusTCPListener instance.

Parameters:

poolsize - the size of the ThreadPool used to handle incoming requests.

addr - the interface to use for listening.

ModbusTCPListener

public ModbusTCPListener(int poolsize,
                         InetAddress addr,
                         boolean useRtuOverTcp)

Constructs a ModbusTCPListener instance.

Parameters:

poolsize - the size of the ThreadPool used to handle incoming requests.

addr - the interface to use for listening.

useRtuOverTcp - True if the RTU protocol should be used over TCP

ModbusTCPListener

public ModbusTCPListener(int poolsize)

/** Constructs a ModbusTCPListener instance. This interface is created to listen on the wildcard address (0.0.0.0), which will accept TCP packets on all available adapters/interfaces

Parameters:

poolsize - the size of the ThreadPool used to handle incoming requests.

ModbusTCPListener

public ModbusTCPListener(int poolsize,
                         boolean useRtuOverTcp)

/** Constructs a ModbusTCPListener instance. This interface is created to listen on the wildcard address (0.0.0.0), which will accept TCP packets on all available adapters/interfaces

Parameters:

poolsize - the size of the ThreadPool used to handle incoming requests.

useRtuOverTcp - True if the RTU protocol should be used over TCP

Method Detail

setMaxIdleSeconds

public void setMaxIdleSeconds(int maxIdleSeconds)

Sets a maximum time a connection can be idle, i.e. has no input/output. This is important for detecting "hanging" slave connection. Details: TCP connection is "immortal" in established state (problems will only be detected when any data are being actively sent in any direction). When a slave is performing socket.read() to get the next request it may not (and often won't) receive any notification that a peer host is down (powered off, for example) and hang forever. Such a connection will occupy thread in a thread pool and eventually the pool will be exhausted Settings this option will force closing the connection after maxIdleSeconds of total silence. This option is disabled by default (maxIdleSeconds == 0)

Parameters:

maxIdleSeconds - 0 to disable watchdog, or a positive number to set it.

setTimeout

public void setTimeout(int timeout)

Description copied from class: AbstractModbusListener

Sets the socket timeout

Overrides:

setTimeout in class AbstractModbusListener

Parameters:

timeout - Timeout in milliseconds

run

public void run()

stop

public void stop()

Description copied from class: AbstractModbusListener

Stop the listener thread for this ModbusListener instance.

Specified by:

stop in class AbstractModbusListener