TCPMasterConnection (j2mod 3.3.0 API)

java.lang.Object
- com.ghgande.j2mod.modbus.net.TCPMasterConnection

```
public class TCPMasterConnection
extends Object
```
Class that implements a TCPMasterConnection.

Version:

2.0 (March 2016)

Author:

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

Constructor Summary

Constructors
Constructor and Description

TCPMasterConnection(InetAddress adr)
Constructs a TCPMasterConnection instance with a given destination address.

Constructors
Constructor and Description
`TCPMasterConnection(InetAddress adr)` Constructs a `TCPMasterConnection` instance with a given destination address.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this `TCPMasterConnection`.
`void`	`connect()` Opens this `TCPMasterConnection`.
`void`	`connect(boolean useRtuOverTcp)` Opens this `TCPMasterConnection`.
`boolean`	`equals(Object obj)` A `TCPMasterConnection` is equal if `InetAddress` & port are equal.
`InetAddress`	`getAddress()` Returns the destination `InetAddress` of this `TCPMasterConnection`.
`AbstractModbusTransport`	`getModbusTransport()` Returns the `ModbusTransport` associated with this `TCPMasterConnection`.
`NetworkInterface`	`getNetworkInterface()` Gets the local `NetworkInterface` that this socket is bound to.
`int`	`getPort()` Returns the destination port of this `TCPMasterConnection`.
`int`	`getTimeout()` Returns the timeout (msec) for this `TCPMasterConnection`.
`boolean`	`getUseUrgentData()` Gets the current setting of the flag which controls sending urgent data to test a network connection.
`int`	`hashCode()` The unique value of the `TCPMasterConnection` is calculated from the unique values of the `InetAddress` & port
`boolean`	`isConnected()` Tests if this `TCPMasterConnection` is connected.
`boolean`	`isUseRtuOverTcp()` Returns true if this connection is an RTU over TCP type
`void`	`setAddress(InetAddress adr)` Sets the destination `InetAddress` of this `TCPMasterConnection`.
`void`	`setModbusTransport(ModbusTCPTransport trans)` Set the `ModbusTransport` associated with this `TCPMasterConnection`
`void`	`setNetworkInterface(NetworkInterface networkInterface)` Sets the local `NetworkInterface` to bind to for this `TCPMasterConnection`.
`void`	`setPort(int port)` Sets the destination port of this `TCPMasterConnection`.
`void`	`setProxy(Proxy proxy)` Sets the `Proxy` that this socket uses.
`void`	`setTimeout(int timeout)` Sets the timeout (msec) for this `TCPMasterConnection`.
`void`	`setUseRtuOverTcp(boolean useRtuOverTcp)` Sets the transport type to use Normally set during the connection but can also be set after a connection has been established
`void`	`setUseUrgentData(boolean useUrgentData)` Set the flag which controls sending urgent data to test a network connection.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TCPMasterConnection
```
public TCPMasterConnection(InetAddress adr)
```
    Constructs a TCPMasterConnection instance with a given destination address.
    
    Parameters:
    
    adr - the destination InetAddress.
- Method Detail
  - connect
```
public void connect()
             throws Exception
```
    Opens this TCPMasterConnection.
    
    Throws:
    
    Exception - if there is a network failure.
  - connect
```
public void connect(boolean useRtuOverTcp)
             throws Exception
```
    Opens this TCPMasterConnection.
    
    Parameters:
    
    useRtuOverTcp - True if the RTU protocol should be used over TCP
    
    Throws:
    
    Exception - if there is a network failure.
  - isConnected
```
public boolean isConnected()
```
    Tests if this TCPMasterConnection is connected.
    
    Returns:
    
    true if connected, false otherwise.
  - close
```
public void close()
```
    Closes this TCPMasterConnection.
  - getModbusTransport
```
public AbstractModbusTransport getModbusTransport()
```
    Returns the ModbusTransport associated with this TCPMasterConnection.
    
    Returns:
    
    the connection's ModbusTransport.
  - setModbusTransport
```
public void setModbusTransport(ModbusTCPTransport trans)
```
    Set the ModbusTransport associated with this TCPMasterConnection
    
    Parameters:
    
    trans - associated transport
  - getTimeout
```
public int getTimeout()
```
    Returns the timeout (msec) for this TCPMasterConnection.
    
    Returns:
    
    the timeout as int.
  - setTimeout
```
public void setTimeout(int timeout)
```
    Sets the timeout (msec) for this TCPMasterConnection. This is both the connection timeout and the transaction timeout
    
    Parameters:
    
    timeout - - the timeout in milliseconds as an int.
  - getPort
```
public int getPort()
```
    Returns the destination port of this TCPMasterConnection.
    
    Returns:
    
    the port number as int.
  - setPort
```
public void setPort(int port)
```
    Sets the destination port of this TCPMasterConnection. The default is defined as Modbus.DEFAULT_PORT.
    
    Parameters:
    
    port - the port number as int.
  - getAddress
```
public InetAddress getAddress()
```
    Returns the destination InetAddress of this TCPMasterConnection.
    
    Returns:
    
    the destination address as InetAddress.
  - setAddress
```
public void setAddress(InetAddress adr)
```
    Sets the destination InetAddress of this TCPMasterConnection.
    
    Parameters:
    
    adr - the destination address as InetAddress.
  - getNetworkInterface
```
public NetworkInterface getNetworkInterface()
```
    Gets the local NetworkInterface that this socket is bound to. If null (the default), the socket is bound to the adapter chosen by the system based on routing to the destination address when the connection is made
    
    Returns:
    
    the network card as NetworkInterface.
  - setNetworkInterface
```
public void setNetworkInterface(NetworkInterface networkInterface)
```
    Sets the local NetworkInterface to bind to for this TCPMasterConnection.
    
    Parameters:
    
    networkInterface - of the network card as NetworkInterface.
  - setProxy
```
public void setProxy(Proxy proxy)
```
    Sets the Proxy that this socket uses. If null (the default), no proxy is used.
    
    Parameters:
    
    proxy - the proxy as Proxy.
  - getUseUrgentData
```
public boolean getUseUrgentData()
```
    Gets the current setting of the flag which controls sending urgent data to test a network connection.
    
    Returns:
    
    Status
  - setUseUrgentData
```
public void setUseUrgentData(boolean useUrgentData)
```
    Set the flag which controls sending urgent data to test a network connection.
    
    Parameters:
    
    useUrgentData - - Connections are testing using urgent data.
  - isUseRtuOverTcp
```
public boolean isUseRtuOverTcp()
```
    Returns true if this connection is an RTU over TCP type
    
    Returns:
    
    True if RTU over TCP
  - setUseRtuOverTcp
```
public void setUseRtuOverTcp(boolean useRtuOverTcp)
                      throws Exception
```
    Sets the transport type to use Normally set during the connection but can also be set after a connection has been established
    
    Parameters:
    
    useRtuOverTcp - True if the transport should be interpreted as RTU over tCP
    
    Throws:
    
    Exception - If the connection is not valid
  - equals
```
public boolean equals(Object obj)
```
    A TCPMasterConnection is equal if InetAddress & port are equal. There is no way how two different TCPMasterConnections can use the same Socket at the same time, therefore this is good enough for an equality test
    
    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 TCPMasterConnection is calculated from the unique values of the InetAddress & port
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    Unique integer hash code

Class TCPMasterConnection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TCPMasterConnection

Method Detail

connect

connect

isConnected

close

getModbusTransport

setModbusTransport

getTimeout

setTimeout

getPort

setPort

getAddress

setAddress

getNetworkInterface

setNetworkInterface

setProxy

getUseUrgentData

setUseUrgentData

isUseRtuOverTcp

setUseRtuOverTcp

equals

hashCode