com.ghgande.j2mod.modbus.slave

Class ModbusSlaveFactory

java.lang.Object

com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory

public class ModbusSlaveFactory
extends Object

This is a factory class that allows users to easily create and manage slaves.
Each slave is uniquely identified by the port it is listening on, irrespective of if the socket type (TCP, UDP or Serial)

Version:

2.0 (March 2016)

Author:

Steve O'Hara (4NG)

Method Summary

Modifier and Type	Method and Description
static void	close() Closes all slaves and removes them from the running list
static void	close(ModbusSlave slave) Closes this slave and removes it from the running list
static ModbusSlave	createSerialSlave(SerialParameters serialParams) Creates a serial modbus slave or returns the one already allocated to this port
static ModbusSlave	createTCPSlave(InetAddress address, int port, int poolSize, boolean useRtuOverTcp) Creates a TCP modbus slave or returns the one already allocated to this port
static ModbusSlave	createTCPSlave(InetAddress address, int port, int poolSize, boolean useRtuOverTcp, int maxIdleSeconds) Creates a TCP modbus slave or returns the one already allocated to this port
static ModbusSlave	createTCPSlave(int port, int poolSize) Creates a TCP modbus slave or returns the one already allocated to this port
static ModbusSlave	createTCPSlave(int port, int poolSize, boolean useRtuOverTcp) Creates a TCP modbus slave or returns the one already allocated to this port
static ModbusSlave	createUDPSlave(InetAddress address, int port) Creates a UDP modbus slave or returns the one already allocated to this port
static ModbusSlave	createUDPSlave(int port) Creates a UDP modbus slave or returns the one already allocated to this port
static ModbusSlave	getSlave(AbstractModbusListener listener) Returns the running slave that utilises the give listener
static ModbusSlave	getSlave(ModbusSlaveType type, int port) Returns the running slave listening on the given port
static ModbusSlave	getSlave(ModbusSlaveType type, String port) Returns the running slave listening on the given port

Methods inherited from class java.lang.Object

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

Method Detail

createTCPSlave

public static ModbusSlave createTCPSlave(int port,
                                         int poolSize)
                                  throws ModbusException

Creates a TCP modbus slave or returns the one already allocated to this port

Parameters:

port - Port to listen on

poolSize - Pool size of listener threads

Returns:

new or existing TCP modbus slave associated with the port

Throws:

ModbusException - If a problem occurs e.g. port already in use

createTCPSlave

public static ModbusSlave createTCPSlave(int port,
                                         int poolSize,
                                         boolean useRtuOverTcp)
                                  throws ModbusException

Creates a TCP modbus slave or returns the one already allocated to this port

Parameters:

port - Port to listen on

poolSize - Pool size of listener threads

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

Returns:

new or existing TCP modbus slave associated with the port

Throws:

ModbusException - If a problem occurs e.g. port already in use

createTCPSlave

public static ModbusSlave createTCPSlave(InetAddress address,
                                         int port,
                                         int poolSize,
                                         boolean useRtuOverTcp)
                                  throws ModbusException

Creates a TCP modbus slave or returns the one already allocated to this port

Parameters:

address - IP address to listen on

port - Port to listen on

poolSize - Pool size of listener threads

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

Returns:

new or existing TCP modbus slave associated with the port

Throws:

ModbusException - If a problem occurs e.g. port already in use

createTCPSlave

public static ModbusSlave createTCPSlave(InetAddress address,
                                         int port,
                                         int poolSize,
                                         boolean useRtuOverTcp,
                                         int maxIdleSeconds)
                                  throws ModbusException

Creates a TCP modbus slave or returns the one already allocated to this port

Parameters:

address - IP address to listen on

port - Port to listen on

poolSize - Pool size of listener threads

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

maxIdleSeconds - Maximum idle seconds for TCP connection

Returns:

new or existing TCP modbus slave associated with the port

Throws:

ModbusException - If a problem occurs e.g. port already in use

createUDPSlave

public static ModbusSlave createUDPSlave(int port)
                                  throws ModbusException

Creates a UDP modbus slave or returns the one already allocated to this port

Parameters:

port - Port to listen on

Returns:

new or existing UDP modbus slave associated with the port

Throws:

ModbusException - If a problem occurs e.g. port already in use

createUDPSlave

public static ModbusSlave createUDPSlave(InetAddress address,
                                         int port)
                                  throws ModbusException

Creates a UDP modbus slave or returns the one already allocated to this port

Parameters:

address - IP address to listen on

port - Port to listen on

Returns:

new or existing UDP modbus slave associated with the port

Throws:

ModbusException - If a problem occurs e.g. port already in use

createSerialSlave

public static ModbusSlave createSerialSlave(SerialParameters serialParams)
                                     throws ModbusException

Creates a serial modbus slave or returns the one already allocated to this port

Parameters:

serialParams - Serial parameters for serial type slaves

Returns:

new or existing Serial modbus slave associated with the port

Throws:

ModbusException - If a problem occurs e.g. port already in use

close

public static void close(ModbusSlave slave)

Closes this slave and removes it from the running list

Parameters:

slave - Slave to remove

close

public static void close()

Closes all slaves and removes them from the running list

getSlave

public static ModbusSlave getSlave(ModbusSlaveType type,
                                   int port)

Returns the running slave listening on the given port

Parameters:

type - Type of slave

port - Port to check for running slave

Returns:

Null or ModbusSlave

getSlave

public static ModbusSlave getSlave(ModbusSlaveType type,
                                   String port)

Returns the running slave listening on the given port

Parameters:

type - Type of slave

port - Port to check for running slave

Returns:

Null or ModbusSlave

getSlave

public static ModbusSlave getSlave(AbstractModbusListener listener)

Returns the running slave that utilises the give listener

Parameters:

listener - Listener used for this slave

Returns:

Null or ModbusSlave