ModbusTcpServer (com.github.dathlin:HslCommunication 3.4.0 API)

java.lang.Object
- HslCommunication.Core.Net.NetworkBase.NetworkBase
- - HslCommunication.Core.Net.NetworkBase.NetworkServerBase
  - - HslCommunication.Core.Net.NetworkBase.NetworkDataServerBase
    - - HslCommunication.ModBus.ModbusTcpServer

所有已实现的接口:: IReadWriteNet

public class ModbusTcpServer
extends NetworkDataServerBase

字段概要

字段
限定符和类型	字段和说明
`int`	`RequestDelayTime` 获取或设置两次请求直接的延时时间，单位毫秒，默认是0，不发生延时，设置为20的话，可以有效防止有客户端疯狂进行请求而导致服务器的CPU占用率上升。
`boolean`	`UseModbusRtuOverTcp` 获取或设置当前的TCP服务器是否使用 modbus-rtu 报文进行通信，如果设置为 True，那么客户端需要使用 `ModbusRtuOverTcp` Get or set whether the current TCP server uses modbus-rtu messages for communication.

从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDataServerBase
EnableWrite, LogMsgFormatBinary, OnDataReceived, OnDataSend, WordLength

从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkBase
CoreSocket, fileCacheSize, LogNet, Token

从接口继承的字段 HslCommunication.Core.Net.IReadWriteNet
LogNet

构造器概要

构造器
构造器和说明

ModbusTcpServer()
实例化一个Modbus Tcp及Rtu的服务器，支持数据读写操作

构造器
构造器和说明
`ModbusTcpServer()` 实例化一个Modbus Tcp及Rtu的服务器，支持数据读写操作

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DataFormat`	`getDataFormat()`
`boolean`	`getIsStringReverse()`
`protected INetMessage`	`GetNewNetMessage()`
`byte`	`getStation()`
`boolean`	`getStationDataIsolation()` 获取或设置是否启动站点数据隔离功能，默认为 False，也即虚拟服务器模拟一个站点服务器，客户端使用正确的站号才能通信。
`protected void`	`LoadFromBytes(byte[] content)` 从字节数据加载数据信息，需要进行重写方法 Loading data information from byte data requires rewriting method
`OperateResultExOne<byte[]>`	`Read(String address, short length)` 一个字单位的数据表示的地址长度，西门子为2，三菱，欧姆龙，modbusTcp就为1，AB PLC无效 The address length represented by one word of data, Siemens is 2, Mitsubishi, Profinet.Omron, modbusTcp is 1, AB PLC is invalid
`OperateResultExOne<boolean[]>`	`ReadBool(String address, short length)` 批量读取 `Boolean` 数组信息，需要指定地址和长度，返回 `Boolean` 数组 Batch read `Boolean` array information, need to specify the address and length, return `Boolean` array
`boolean`	`ReadCoil(String address)`
`boolean[]`	`ReadCoil(String address, short length)`
`boolean`	`ReadDiscrete(String address)`
`boolean[]`	`ReadDiscrete(String address, short length)`
`protected OperateResultExOne<byte[]>`	`ReadFromCoreServer(AppSession session, byte[] receive)`
`protected byte[]`	`ReadFromModbusCore(byte[] modbusCore)` Modbus核心数据交互方法，允许重写自己来实现，报文只剩下核心的Modbus信息，去除了MPAB报头信息 The Modbus core data interaction method allows you to rewrite it to achieve the message.
`protected byte[]`	`SaveToBytes()` 将数据信息存储到字节数组去，需要进行重写方法 To store data information into a byte array, a rewrite method is required
`void`	`setDataFormat(DataFormat value)`
`void`	`setIsStringReverse(boolean value)`
`void`	`setStation(byte value)`
`void`	`setStationDataIsolation(boolean value)` 设置是否启动站点数据隔离功能，默认为 False，也即虚拟服务器模拟一个站点服务器，客户端使用正确的站号才能通信。
`String`	`toString()` 此处实现了连接Hsl异形客户端的协议，特殊的协议实现定制请联系作者 QQ群：592132877
`OperateResult`	`Write(String address, boolean[] value)` 批量写入 `Boolean` 数组数据，返回是否成功 Batch write `Boolean` array data, return whether the write was successful
`OperateResult`	`Write(String address, byte[] value)` 写入原始的byte数组数据到指定的地址，返回是否写入成功 Write the original byte array data to the specified address, and return whether the write was successful
`void`	`Write(String address, byte high, byte low)` 写入寄存器的数据，指定字节数据信息
`void`	`WriteCoil(String address, boolean data)`
`void`	`WriteCoil(String address, boolean[] data)`
`void`	`WriteDiscrete(String address, boolean data)`
`void`	`WriteDiscrete(String address, boolean[] data)`

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkDataServerBase
AddClient, ConnectClose, Dispose, getByteTransform, getConnectionId, GetOnlineCount, GetSerialMessageLogText, GetWordLength, isEnableWrite, RaiseDataReceived, RaiseDataSend, ReadBool, ReadCustomer, ReadDouble, ReadDouble, ReadFloat, ReadFloat, ReadInt16, ReadInt16, ReadInt32, ReadInt32, ReadInt64, ReadInt64, ReadString, ReadString, ReadUInt16, ReadUInt16, ReadUInt32, ReadUInt32, RemoveClient, RemoveClient, setByteTransform, setConnectionId, setEnableWrite, setLogNet, ThreadPoolLogin, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, WriteCustomer, WriteUnicodeString, WriteUnicodeString

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkServerBase
CloseAction, getPort, isStarted, ServerClose, ServerStart, ServerStart, setPort, setStarted, SocketAcceptExtraCheck, StartInitialization

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkBase
CheckRemoteToken, CloseSocket, CreateSocketAndConnect, CreateSocketAndConnect, CreateSocketAndConnect, ReadStream, Receive, Receive, Receive, ReceiveAndCheckBytes, ReceiveByMessage, ReceiveByMessage, ReceiveBytesContentFromSocket, ReceiveBytesContentFromSocket, ReceiveCommandLineFromSocket, ReceiveCommandLineFromSocket, ReceiveCommandLineFromSocket, ReceiveCommandLineFromSocket, ReceiveFrameWebSocketPayload, ReceiveHslMessage, ReceiveMqttMessage, ReceiveRedisCommand, ReceiveRedisCommandString, ReceiveStringArrayContentFromSocket, ReceiveStringArrayContentFromSocket, ReceiveStringContentFromSocket, ReceiveStringContentFromSocket, ReceiveWebSocketPayload, Send, Send, SendAccountAndCheckReceive, SendBaseAndCheckReceive, SendBytesAndCheckReceive, SendStreamToSocket, SendStringAndCheckReceive, SendStringAndCheckReceive, ThreadPoolCheckTimeOut, WriteStream, WriteStreamFromSocket

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

- 字段详细资料
  - UseModbusRtuOverTcp
```
public boolean UseModbusRtuOverTcp
```
    获取或设置当前的TCP服务器是否使用 modbus-rtu 报文进行通信，如果设置为 True，那么客户端需要使用 ModbusRtuOverTcp
    Get or set whether the current TCP server uses modbus-rtu messages for communication. If it is set to True, then the client needs to use ModbusRtuOverTcp
  - RequestDelayTime
```
public int RequestDelayTime
```
    获取或设置两次请求直接的延时时间，单位毫秒，默认是0，不发生延时，设置为20的话，可以有效防止有客户端疯狂进行请求而导致服务器的CPU占用率上升。
    Get or set the direct delay time of two requests, in milliseconds, the default is 0, no delay occurs, if it is set to 20, it can effectively prevent the client from making crazy requests and causing the server's CPU usage to increase.
- 构造器详细资料
  - ModbusTcpServer
```
public ModbusTcpServer()
```
    实例化一个Modbus Tcp及Rtu的服务器，支持数据读写操作
- 方法详细资料
  - getDataFormat
```
public DataFormat getDataFormat()
```
  - setDataFormat
```
public void setDataFormat(DataFormat value)
```
  - getIsStringReverse
```
public boolean getIsStringReverse()
```
  - setIsStringReverse
```
public void setIsStringReverse(boolean value)
```
  - getStation
```
public byte getStation()
```
  - setStation
```
public void setStation(byte value)
```
  - getStationDataIsolation
```
public boolean getStationDataIsolation()
```
    获取或设置是否启动站点数据隔离功能，默认为 False，也即虚拟服务器模拟一个站点服务器，客户端使用正确的站号才能通信。当设置为 True 时，虚拟服务器模式256个站点，无论客户端使用的什么站点，都能读取或是写入对应站点里去。服务器同时也可以访问任意站点自身的数据。
    Get or set whether to enable the site data isolation function, the default is False, that is, the virtual server simulates a site server, and the client can communicate with the correct site number. When set to True, 256 sites in virtual server mode, no matter what site the client uses, can read or write to the corresponding site.The server can also access any site's own data.
    
    返回:
    
    值信息
  - setStationDataIsolation
```
public void setStationDataIsolation(boolean value)
```
    设置是否启动站点数据隔离功能，默认为 False，也即虚拟服务器模拟一个站点服务器，客户端使用正确的站号才能通信。
    set whether to enable the site data isolation function, the default is False, that is, the virtual server simulates a site server, and the client can communicate with the correct site number.
    
    参数:
    
    value - 设置值
  - SaveToBytes
```
protected byte[] SaveToBytes()
```
    从类复制的说明: NetworkDataServerBase
    
    将数据信息存储到字节数组去，需要进行重写方法
    To store data information into a byte array, a rewrite method is required
    
    覆盖:
    
    SaveToBytes 在类中 NetworkDataServerBase
    
    返回:
    
    所有的内容
  - LoadFromBytes
```
protected void LoadFromBytes(byte[] content)
```
    从类复制的说明: NetworkDataServerBase
    
    从字节数据加载数据信息，需要进行重写方法
    Loading data information from byte data requires rewriting method
    
    覆盖:
    
    LoadFromBytes 在类中 NetworkDataServerBase
    
    参数:
    
    content - 字节数据
  - ReadCoil
```
public boolean ReadCoil(String address)
```
  - ReadCoil
```
public boolean[] ReadCoil(String address,
                          short length)
```
  - WriteCoil
```
public void WriteCoil(String address,
                      boolean data)
```
  - WriteCoil
```
public void WriteCoil(String address,
                      boolean[] data)
```
  - ReadDiscrete
```
public boolean ReadDiscrete(String address)
```
  - ReadDiscrete
```
public boolean[] ReadDiscrete(String address,
                              short length)
```
  - WriteDiscrete
```
public void WriteDiscrete(String address,
                          boolean data)
```
  - WriteDiscrete
```
public void WriteDiscrete(String address,
                          boolean[] data)
```
  - Read
```
public OperateResultExOne<byte[]> Read(String address,
                                       short length)
```
    从类复制的说明: NetworkDataServerBase
    
    一个字单位的数据表示的地址长度，西门子为2，三菱，欧姆龙，modbusTcp就为1，AB PLC无效
    The address length represented by one word of data, Siemens is 2, Mitsubishi, Profinet.Omron, modbusTcp is 1, AB PLC is invalid
    
    指定者:
    
    Read 在接口中 IReadWriteNet
    
    覆盖:
    
    Read 在类中 NetworkDataServerBase
    
    参数:
    
    address - 数据地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的byte[]数组
  - Write
```
public OperateResult Write(String address,
                           byte[] value)
```
    从接口复制的说明: IReadWriteNet
    
    写入原始的byte数组数据到指定的地址，返回是否写入成功
    Write the original byte array data to the specified address, and return whether the write was successful
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDataServerBase
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - ReadBool
```
public OperateResultExOne<boolean[]> ReadBool(String address,
                                              short length)
```
    从接口复制的说明: IReadWriteNet
    
    批量读取 Boolean 数组信息，需要指定地址和长度，返回 Boolean 数组
    Batch read Boolean array information, need to specify the address and length, return Boolean array
    
    指定者:
    
    ReadBool 在接口中 IReadWriteNet
    
    覆盖:
    
    ReadBool 在类中 NetworkDataServerBase
    
    参数:
    
    address - 数据地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的boolean[]数组
  - Write
```
public OperateResult Write(String address,
                           boolean[] value)
```
    从接口复制的说明: IReadWriteNet
    
    批量写入 Boolean 数组数据，返回是否成功
    Batch write Boolean array data, return whether the write was successful
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDataServerBase
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    是否写入成功
  - Write
```
public void Write(String address,
                  byte high,
                  byte low)
```
    写入寄存器的数据，指定字节数据信息
    
    参数:
    
    address - 起始地址，示例："100"，如果是输入寄存器："x=4;100"
    
    high - 高位数据
    
    low - 地位数据
  - GetNewNetMessage
```
protected INetMessage GetNewNetMessage()
```
    覆盖:
    
    GetNewNetMessage 在类中 NetworkDataServerBase
  - ReadFromCoreServer
```
protected OperateResultExOne<byte[]> ReadFromCoreServer(AppSession session,
                                                        byte[] receive)
```
    覆盖:
    
    ReadFromCoreServer 在类中 NetworkDataServerBase
  - ReadFromModbusCore
```
protected byte[] ReadFromModbusCore(byte[] modbusCore)
```
    Modbus核心数据交互方法，允许重写自己来实现，报文只剩下核心的Modbus信息，去除了MPAB报头信息
    The Modbus core data interaction method allows you to rewrite it to achieve the message. Only the core Modbus information is left in the message, and the MPAB header information is removed.
    
    参数:
    
    modbusCore - 核心的Modbus报文
    
    返回:
    
    进行数据交互之后的结果
  - toString
```
public String toString()
```
    从类复制的说明: NetworkServerBase
    
    此处实现了连接Hsl异形客户端的协议，特殊的协议实现定制请联系作者 QQ群：592132877
    
    覆盖:
    
    toString 在类中 NetworkDataServerBase
    
    返回:
    
    字符串信息

类 ModbusTcpServer

字段概要

从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDataServerBase

从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkBase

从接口继承的字段 HslCommunication.Core.Net.IReadWriteNet

构造器概要

方法概要

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkDataServerBase

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkServerBase

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkBase

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

字段详细资料

UseModbusRtuOverTcp

RequestDelayTime

构造器详细资料

ModbusTcpServer

方法详细资料

getDataFormat

setDataFormat

getIsStringReverse

setIsStringReverse

getStation

setStation

getStationDataIsolation

setStationDataIsolation

SaveToBytes

LoadFromBytes

ReadCoil

ReadCoil

WriteCoil

WriteCoil

ReadDiscrete

ReadDiscrete

WriteDiscrete

WriteDiscrete

Read

Write

ReadBool

Write

Write

GetNewNetMessage

ReadFromCoreServer

ReadFromModbusCore

toString