com.ghgande.j2mod.modbus.net

Class AbstractModbusListener

java.lang.Object

com.ghgande.j2mod.modbus.net.AbstractModbusListener

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

ModbusSerialListener, ModbusTCPListener, ModbusUDPListener

public abstract class AbstractModbusListener
extends Object
implements Runnable

Definition of a listener class

Version:

2.0 (March 2016)

Author:

Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
AbstractModbusListener()

Method Summary

Modifier and Type	Method and Description
InetAddress	getAddress() Returns the address bound to this socket
String	getError() Returns any startup errors that may have aoccurred
int	getPort() Returns the port being listened on
ProcessImage	getProcessImage(int unitId) Returns the related process image for this listener and Unit Id
String	getThreadName() Gets the name of the thread used by the listener
int	getTimeout() Get the socket timeout
boolean	isListening() Tests if this ModbusTCPListener is listening and accepting incoming connections.
void	setAddress(InetAddress addr) Sets the address of the interface to be listened to.
void	setListening(boolean b) Set the listening state of this ModbusTCPListener object.
void	setPort(int port) Sets the port to be listened to.
void	setThreadName(String threadName) Sets the name of the thread used by the listener
void	setTimeout(int timeout) Sets the socket timeout
abstract void	stop() Stop the listener thread for this ModbusListener instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

AbstractModbusListener

public AbstractModbusListener()

Method Detail

stop

public abstract void stop()

Stop the listener thread for this ModbusListener instance.

setPort

public void setPort(int port)

Sets the port to be listened to.

Parameters:

port - the number of the IP port as int.

getPort

public int getPort()

Returns the port being listened on

Returns:

Port number > 0

setAddress

public void setAddress(InetAddress addr)

Sets the address of the interface to be listened to.

Parameters:

addr - an InetAddress instance.

getAddress

public InetAddress getAddress()

Returns the address bound to this socket

Returns:

Bound address

isListening

public boolean isListening()

Tests if this ModbusTCPListener is listening and accepting incoming connections.

Returns:

true if listening (and accepting incoming connections), false otherwise.

setListening

public void setListening(boolean b)

Set the listening state of this ModbusTCPListener object. A ModbusTCPListener will silently drop any requests if the listening state is set to false.

Parameters:

b - listening state

getError

public String getError()

Returns any startup errors that may have aoccurred

Returns:

Error string

getTimeout

public int getTimeout()

Get the socket timeout

Returns:

Socket timeout in milliseconds

setTimeout

public void setTimeout(int timeout)

Sets the socket timeout

Parameters:

timeout - Timeout in milliseconds

getProcessImage

public ProcessImage getProcessImage(int unitId)

Returns the related process image for this listener and Unit Id

Parameters:

unitId - Unit ID

Returns:

Process image associated with this listener and Unit ID

getThreadName

public String getThreadName()

Gets the name of the thread used by the listener

Returns:

Name of thread or null if not assigned

setThreadName

public void setThreadName(String threadName)

Sets the name of the thread used by the listener

Parameters:

threadName - Name to use for the thread