TcpClientBasic (fox-edge-server-protocol-s7plc-core 1.0.9 API)

java.lang.Object
- cn.foxtech.device.protocol.v1.s7plc.core.service.TcpClientBasic

所有已实现的接口:

ICommunicable

直接已知子类:

PLCNetwork
```
public class TcpClientBasic
extends Object
implements ICommunicable
```
作者:

xingshuang

字段概要

字段
限定符和类型	字段和说明
`protected int`	`connectTimeout` 连接超时时间，默认是10s
`protected boolean`	`enableReconnect` 自动重连，true:自动重连，false：不自动重连，默认自动重连
`protected int`	`receiveTimeout` 接收数据超时时间，默认是10s
`protected Socket`	`socket` socket对象
`protected InetSocketAddress`	`socketAddress` socket的地址
`protected AtomicBoolean`	`socketError` socket是否发生错误
`protected String`	`tag` TAG名

构造器概要

构造器
构造器和说明

TcpClientBasic()

TcpClientBasic(String host, int port)

构造器
构造器和说明
`TcpClientBasic()`
`TcpClientBasic(String host, int port)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`checkConnected()` 校验连接状态，true为连接，false为断开
`void`	`close()` 关闭socket
`void`	`connect()` 连接
`protected void`	`doAfterConnected()` 连接成功之后要做的动作
`protected Socket`	`getAvailableSocket()` 获取有效的socket对象
`int`	`getConnectTimeout()`
`int`	`getReceiveTimeout()`
`InetSocketAddress`	`getSocketAddress()`
`boolean`	`isEnableReconnect()`
`int`	`read(byte[] data)` 读取数据
`int`	`read(byte[] data, int timeout)` 读取数据
`int`	`read(byte[] data, int offset, int length)` 读取数据
`int`	`read(byte[] data, int offset, int length, int timeout)` 读取数据
`int`	`read(byte[] data, int offset, int length, int maxLength, int timeout)` 读取数据
`int`	`read(byte[] data, int offset, int length, int maxLength, int timeout, boolean waitForMore)` 读取数据
`void`	`setConnectTimeout(int connectTimeout)`
`void`	`setEnableReconnect(boolean enableReconnect)`
`void`	`setReceiveTimeout(int receiveTimeout)`
`void`	`write(byte[] data)` 写入数据
`void`	`write(byte[] data, int offset, int length)` 写入数据
`void`	`write(byte[] data, int offset, int length, int maxLength)` 写入数据

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - socketAddress
```
protected final InetSocketAddress socketAddress
```
    socket的地址
  - socketError
```
protected final AtomicBoolean socketError
```
    socket是否发生错误
  - tag
```
protected String tag
```
    TAG名
  - socket
```
protected Socket socket
```
    socket对象
  - connectTimeout
```
protected int connectTimeout
```
    连接超时时间，默认是10s
  - receiveTimeout
```
protected int receiveTimeout
```
    接收数据超时时间，默认是10s
  - enableReconnect
```
protected boolean enableReconnect
```
    自动重连，true:自动重连，false：不自动重连，默认自动重连
- 构造器详细资料
  - TcpClientBasic
```
public TcpClientBasic()
```
  - TcpClientBasic
```
public TcpClientBasic(String host,
                      int port)
```
- 方法详细资料
  - getSocketAddress
```
public InetSocketAddress getSocketAddress()
```
  - isEnableReconnect
```
public boolean isEnableReconnect()
```
  - setEnableReconnect
```
public void setEnableReconnect(boolean enableReconnect)
```
  - getConnectTimeout
```
public int getConnectTimeout()
```
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
  - getReceiveTimeout
```
public int getReceiveTimeout()
```
  - setReceiveTimeout
```
public void setReceiveTimeout(int receiveTimeout)
```
  - checkConnected
```
public boolean checkConnected()
```
    校验连接状态，true为连接，false为断开
    
    返回:
    
    连接状态，true为连接，false为断开
  - connect
```
public void connect()
```
    连接
  - getAvailableSocket
```
protected Socket getAvailableSocket()
```
    获取有效的socket对象
    
    返回:
    
    socket对象
  - close
```
public void close()
```
    关闭socket
    
    指定者:
    
    close 在接口中 ICommunicable
  - doAfterConnected
```
protected void doAfterConnected()
```
    连接成功之后要做的动作
  - write
```
public void write(byte[] data)
```
    写入数据
    
    指定者:
    
    write 在接口中 ICommunicable
    
    参数:
    
    data - 字节数组
  - write
```
public void write(byte[] data,
                  int offset,
                  int length)
```
    写入数据
    
    指定者:
    
    write 在接口中 ICommunicable
    
    参数:
    
    data - 字节数组
    
    offset - 偏移量
    
    length - 数据长度
  - write
```
public void write(byte[] data,
                  int offset,
                  int length,
                  int maxLength)
```
    写入数据
    
    参数:
    
    data - 字节数组
    
    offset - 偏移量
    
    length - 数据长度
    
    maxLength - 单次通信允许的对最大长度
  - read
```
public int read(byte[] data)
```
    读取数据
    
    指定者:
    
    read 在接口中 ICommunicable
    
    参数:
    
    data - 字节数组
    
    返回:
    
    读取的数据长度
  - read
```
public int read(byte[] data,
                int timeout)
```
    读取数据
    
    参数:
    
    data - 字节数组
    
    timeout - 超时时间，毫秒级别，0：没有超时时间，无限等
    
    返回:
    
    读取的数据长度
  - read
```
public int read(byte[] data,
                int offset,
                int length)
```
    读取数据
    
    指定者:
    
    read 在接口中 ICommunicable
    
    参数:
    
    data - 字节数组
    
    offset - 偏移量
    
    length - 数据长度
    
    返回:
    
    读取的数据长度
  - read
```
public int read(byte[] data,
                int offset,
                int length,
                int timeout)
```
    读取数据
    
    参数:
    
    data - 字节数组
    
    offset - 偏移量
    
    length - 数据长度
    
    timeout - 超时时间，毫秒级别，0：没有超时时间，无限等
    
    返回:
    
    读取的数据长度
  - read
```
public int read(byte[] data,
                int offset,
                int length,
                int maxLength,
                int timeout)
```
    读取数据
    
    参数:
    
    data - 字节数组
    
    offset - 偏移量
    
    length - 数据长度
    
    maxLength - 单次通信允许的对最大长度
    
    timeout - 超时时间，毫秒级别，0：没有超时时间，无限等
    
    返回:
    
    读取的数据长度
  - read
```
public int read(byte[] data,
                int offset,
                int length,
                int maxLength,
                int timeout,
                boolean waitForMore)
```
    读取数据
    
    参数:
    
    data - 字节数组
    
    offset - 偏移量
    
    length - 数据长度
    
    maxLength - 单次通信允许的对最大长度
    
    timeout - 超时时间，毫秒级别，0：没有超时时间，无限等
    
    waitForMore - 若数据不够，是否等待，等待更多数据，大部分都是不等待的，等待都适用于分包粘包的情况
    
    返回:
    
    读取的数据长度

类 TcpClientBasic

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

socketAddress

socketError

tag

socket

connectTimeout

receiveTimeout

enableReconnect

构造器详细资料

TcpClientBasic

TcpClientBasic

方法详细资料

getSocketAddress

isEnableReconnect

setEnableReconnect

getConnectTimeout

setConnectTimeout

getReceiveTimeout

setReceiveTimeout

checkConnected

connect

getAvailableSocket

close

doAfterConnected

write

write

write

read

read

read

read

read

read