com.ghgande.j2mod.modbus.facade

Class ModbusTCPMaster

java.lang.Object

com.ghgande.j2mod.modbus.facade.AbstractModbusMaster

com.ghgande.j2mod.modbus.facade.ModbusTCPMaster

public class ModbusTCPMaster
extends AbstractModbusMaster

Modbus/TCP Master facade.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
ModbusTCPMaster(String addr) Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String addr, boolean useRtuOverTcp) Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String addr, int port) Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String addr, int port, boolean useRtuOverTcp) Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String addr, int port, int timeout, boolean reconnect) Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String addr, int port, int timeout, boolean reconnect, boolean useRtuOverTcp) Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String addr, int port, int timeout, boolean reconnect, boolean useRtuOverTcp, Proxy proxy) Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String addr, int port, Proxy proxy) Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String addr, Proxy proxy) Constructs a new master facade instance for communication with a given slave.

Method Summary

Modifier and Type	Method and Description
void	connect() Connects this ModbusTCPMaster with the slave.
void	disconnect() Disconnects this ModbusTCPMaster from the slave.
boolean	equals(Object obj) A ModbusTCPMaster is equal if the underlying TCPMasterConnection is equal.
AbstractModbusTransport	getTransport() Returns the transport being used by the
int	hashCode() The unique value of the ModbusTCPMaster is calculated from the unique value of the TCPMasterConnection
boolean	isConnected() Returns true if the master is connected
boolean	isReconnecting() Tests if a constant connection is maintained or if a new connection is established for every transaction.
void	setReconnecting(boolean b) Sets the flag that specifies whether to maintain a constant connection or reconnect for every transaction.
void	setTimeout(int timeout) Sets the receive timeout

Methods inherited from class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster

getTimeout, maskWriteRegister, maskWriteRegister, readCoils, readCoils, readInputDiscretes, readInputDiscretes, readInputRegisters, readInputRegisters, readMultipleRegisters, readMultipleRegisters, setCheckingValidity, setRetries, writeCoil, writeCoil, writeMultipleCoils, writeMultipleCoils, writeMultipleRegisters, writeMultipleRegisters, writeSingleRegister, writeSingleRegister

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModbusTCPMaster

public ModbusTCPMaster(String addr)

Constructs a new master facade instance for communication with a given slave.

Parameters:

addr - an internet address as resolvable IP name or IP number, specifying the slave to communicate with.

ModbusTCPMaster

public ModbusTCPMaster(String addr,
                       Proxy proxy)

Constructs a new master facade instance for communication with a given slave.

Parameters:

addr - an internet address as resolvable IP name or IP number, specifying the slave to communicate with.

proxy - a proxy to use on the underlying tcp socket

ModbusTCPMaster

public ModbusTCPMaster(String addr,
                       boolean useRtuOverTcp)

Constructs a new master facade instance for communication with a given slave.

Parameters:

addr - an internet address as resolvable IP name or IP number, specifying the slave to communicate with.

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

ModbusTCPMaster

public ModbusTCPMaster(String addr,
                       int port)

Constructs a new master facade instance for communication with a given slave.

Parameters:

addr - an internet address as resolvable IP name or IP number, specifying the slave to communicate with.

port - the port the slave is listening to.

ModbusTCPMaster

public ModbusTCPMaster(String addr,
                       int port,
                       Proxy proxy)

Constructs a new master facade instance for communication with a given slave.

Parameters:

addr - an internet address as resolvable IP name or IP number, specifying the slave to communicate with.

port - the port the slave is listening to.

proxy - a proxy to use on the underlying tcp socket

ModbusTCPMaster

public ModbusTCPMaster(String addr,
                       int port,
                       boolean useRtuOverTcp)

Constructs a new master facade instance for communication with a given slave.

Parameters:

addr - an internet address as resolvable IP name or IP number, specifying the slave to communicate with.

port - the port the slave is listening to.

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

ModbusTCPMaster

public ModbusTCPMaster(String addr,
                       int port,
                       int timeout,
                       boolean reconnect)

Constructs a new master facade instance for communication with a given slave.

Parameters:

addr - an internet address as resolvable IP name or IP number, specifying the slave to communicate with.

port - the port the slave is listening to.

timeout - Socket timeout in milliseconds

reconnect - true if a new connection should be established for each transaction, false otherwise.

ModbusTCPMaster

public ModbusTCPMaster(String addr,
                       int port,
                       int timeout,
                       boolean reconnect,
                       boolean useRtuOverTcp)

Constructs a new master facade instance for communication with a given slave.

Parameters:

addr - an internet address as resolvable IP name or IP number, specifying the slave to communicate with.

port - the port the slave is listening to.

timeout - Socket timeout in milliseconds

reconnect - true if a new connection should be established for each transaction, false otherwise.

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

ModbusTCPMaster

public ModbusTCPMaster(String addr,
                       int port,
                       int timeout,
                       boolean reconnect,
                       boolean useRtuOverTcp,
                       Proxy proxy)

Constructs a new master facade instance for communication with a given slave.

Parameters:

addr - an internet address as resolvable IP name or IP number, specifying the slave to communicate with.

port - the port the slave is listening to.

timeout - Socket timeout in milliseconds

reconnect - true if a new connection should be established for each transaction, false otherwise.

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

proxy - proxy to use on the underlying tcp socket

Method Detail

connect

public void connect()
             throws Exception

Connects this ModbusTCPMaster with the slave.

Specified by:

connect in class AbstractModbusMaster

Throws:

Exception - if the connection cannot be established.

disconnect

public void disconnect()

Disconnects this ModbusTCPMaster from the slave.

Specified by:

disconnect in class AbstractModbusMaster

isReconnecting

public boolean isReconnecting()

Tests if a constant connection is maintained or if a new connection is established for every transaction.

Returns:

true if a new connection should be established for each transaction, false otherwise.

setReconnecting

public void setReconnecting(boolean b)

Sets the flag that specifies whether to maintain a constant connection or reconnect for every transaction.

Parameters:

b - true if a new connection should be established for each transaction, false otherwise.

setTimeout

public void setTimeout(int timeout)

Description copied from class: AbstractModbusMaster

Sets the receive timeout

Overrides:

setTimeout in class AbstractModbusMaster

Parameters:

timeout - Timeout in milliseconds

getTransport

public AbstractModbusTransport getTransport()

Description copied from class: AbstractModbusMaster

Returns the transport being used by the

Specified by:

getTransport in class AbstractModbusMaster

Returns:

ModbusTransport

isConnected

public boolean isConnected()

Description copied from class: AbstractModbusMaster

Returns true if the master is connected

Specified by:

isConnected in class AbstractModbusMaster

Returns:

True if connected

equals

public boolean equals(Object obj)

A ModbusTCPMaster is equal if the underlying TCPMasterConnection is equal. There can't be 2 un-identical ModbusTCPMasters with the same connection at the same time. One of the two, will raise a SocketException if you start both at the same time, since the socket is only usable by exactly on entity

Overrides:

equals in class Object

Parameters:

obj - Entity to be checked for equality

Returns:

true if object is equal, false otherwise

hashCode

public int hashCode()

The unique value of the ModbusTCPMaster is calculated from the unique value of the TCPMasterConnection

Overrides:

hashCode in class Object

Returns:

Unique integer hash code