点击或拖拽改变大小

ModbusTcpNet 类

Modbus-Tcp协议的客户端通讯类,方便的和服务器进行数据交互,支持标准的功能码,也支持扩展的功能码实现,地址采用富文本的形式,详细见备注说明
The client communication class of Modbus-Tcp protocol is convenient for data interaction with the server. It supports standard function codes and also supports extended function codes. The address is in rich text. For details, see the remarks.
继承层次

命名空间:  HslCommunication.ModBus
程序集:  HslCommunication (在 HslCommunication.dll 中) 版本:9.2.8.0 (9.2.8.0)
语法
public class ModbusTcpNet : NetworkDeviceBase

ModbusTcpNet 类型公开以下成员。

构造函数
  名称说明
公共方法ModbusTcpNet
实例化一个Modbus-Tcp协议的客户端对象
Instantiate a client object of the Modbus-Tcp protocol
公共方法ModbusTcpNet(String, Int32, Byte)
指定服务器地址,端口号,客户端自己的站号来初始化
Specify the server address, port number, and client's own station number to initialize
Top
属性
  名称说明
公共属性AddressStartWithZero
获取或设置起始的地址是否从0开始,默认为True
Gets or sets whether the starting address starts from 0. The default is True
公共属性AlienSession
当前的异形连接对象,如果设置了异形连接的话,仅用于异形模式的情况使用
The current alien connection object, if alien connection is set, is only used in the case of alien mode
(继承自 NetworkDoubleBase。)
公共属性代码示例ByteTransform
当前的数据变换机制,当你需要从字节数据转换类型数据的时候需要。
The current data transformation mechanism is required when you need to convert type data from byte data.
(继承自 NetworkDoubleBase。)
公共属性ConnectionId
当前连接的唯一ID号,默认为长度20的guid码加随机数组成,方便列表管理,也可以自己指定
The unique ID number of the current connection. The default is a 20-digit guid code plus a random number.
(继承自 NetworkDoubleBase。)
公共属性代码示例ConnectTimeOut
获取或设置连接的超时时间,单位是毫秒
Gets or sets the timeout for the connection, in milliseconds
(继承自 NetworkDoubleBase。)
公共属性DataFormat
获取或设置数据解析的格式,可选ABCD, BADC,CDAB,DCBA格式
公共属性代码示例IpAddress
获取或是设置远程服务器的IP地址,如果是本机测试,那么需要设置为127.0.0.1
Get or set the IP address of the remote server. If it is a local test, then it needs to be set to 127.0.0.1
(继承自 NetworkDoubleBase。)
公共属性IsStringReverse
字符串数据是否按照字来反转,默认为False
Whether the string data is reversed according to words. The default is False.
公共属性代码示例LogNet
组件的日志工具,支持日志记录,只要实例化后,当前网络的基本信息,就以DEBUG等级进行输出
The component's logging tool supports logging. As long as the instantiation of the basic network information, the output will be output at DEBUG
(继承自 NetworkBase。)
公共属性MessageId
获取modbus协议自增的消息号,你可以自定义modbus的消息号的规则,详细参见ModbusTcpNet说明,也可以查找SoftIncrementCount说明。
Get the message number incremented by the modbus protocol. You can customize the rules of the message number of the modbus. For details, please refer to the description of ModbusTcpNet, or you can find the description of SoftIncrementCount
公共属性代码示例Port
获取或设置服务器的端口号,具体的值需要取决于对方的配置
Gets or sets the port number of the server. The specific value depends on the configuration of the other party.
(继承自 NetworkDoubleBase。)
公共属性代码示例ReceiveTimeOut
获取或设置接收服务器反馈的时间,如果为负数,则不接收反馈
Gets or sets the time to receive server feedback, and if it is a negative number, does not receive feedback
(继承自 NetworkDoubleBase。)
公共属性Station
获取或者重新修改服务器的默认站号信息,当然,你可以再读写的时候动态指定,参见备注
Get or modify the default station number information of the server. Of course, you can specify it dynamically when reading and writing, see note
公共属性代码示例Token
网络类的身份令牌,在hsl协议的模式下会有效,在和设备进行通信的时候是无效的
Network-type identity tokens will be valid in the hsl protocol mode and will not be valid when communicating with the device
(继承自 NetworkBase。)
受保护的属性WordLength
一个字单位的数据表示的地址长度,西门子为2,三菱,欧姆龙,modbusTcp就为1,AB PLC无效
The address length represented by one word of data, Siemens is 2, Mitsubishi, Omron, modbusTcp is 1, AB PLC is invalid
(继承自 NetworkDeviceBase。)
Top
方法
  名称说明
受保护的方法AccountCertificate
认证账号,根据已经设置的用户名和密码,进行发送服务器进行账号认证。
Authentication account, according to the user name and password that have been set, sending server for account authentication.
(继承自 NetworkDoubleBase。)
受保护的方法AccountCertificateAsync
认证账号,根据已经设置的用户名和密码,进行发送服务器进行账号认证。
Authentication account, according to the user name and password that have been set, sending server for account authentication.
(继承自 NetworkDoubleBase。)
受保护的方法CheckRemoteToken
检查当前的头子节信息的令牌是否是正确的,仅用于某些特殊的协议实现
Check whether the token of the current header subsection information is correct, only for some special protocol implementations
(继承自 NetworkBase。)
公共方法代码示例ConnectClose
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式
Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode
(继承自 NetworkDoubleBase。)
公共方法代码示例ConnectCloseAsync
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式
Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode
(继承自 NetworkDoubleBase。)
公共方法代码示例ConnectServer
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速
Try to connect to a remote server. If the connection is successful, switch the short connection mode to the long connection mode. Each subsequent request will share a channel, making the communication speed faster.
(继承自 NetworkDoubleBase。)
公共方法代码示例ConnectServer(AlienSession)
使用指定的套接字创建异形客户端,在异形客户端的模式下,网络通道需要被动创建。
Use the specified socket to create the alien client. In the alien client mode, the network channel needs to be created passively.
(继承自 NetworkDoubleBase。)
公共方法代码示例ConnectServerAsync
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速
Try to connect to a remote server. If the connection is successful, switch the short connection mode to the long connection mode. Each subsequent request will share a channel, making the communication speed faster.
(继承自 NetworkDoubleBase。)
受保护的方法代码示例CreateSocketAndConnect(IPEndPoint, Int32)
创建一个新的socket对象并连接到远程的地址,需要指定远程终结点,超时时间(单位是毫秒)
To create a new socket object and connect to a remote address, you need to specify the remote endpoint and the timeout period (in milliseconds)
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnect(String, Int32)
创建一个新的socket对象并连接到远程的地址,默认超时时间为10秒钟,需要指定ip地址以及端口号信息
Create a new socket object and connect to the remote address. The default timeout is 10 seconds. You need to specify the IP address and port number.
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnect(String, Int32, Int32)
创建一个新的socket对象并连接到远程的地址,需要指定ip地址以及端口号信息,还有超时时间,单位是毫秒
To create a new socket object and connect to a remote address, you need to specify the IP address and port number information, and the timeout period in milliseconds
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnectAsync(IPEndPoint, Int32)
创建一个新的socket对象并连接到远程的地址,需要指定远程终结点,超时时间(单位是毫秒)
To create a new socket object and connect to a remote address, you need to specify the remote endpoint and the timeout period (in milliseconds)
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnectAsync(String, Int32)
创建一个新的socket对象并连接到远程的地址,默认超时时间为10秒钟,需要指定ip地址以及端口号信息
Create a new socket object and connect to the remote address. The default timeout is 10 seconds. You need to specify the IP address and port number.
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnectAsync(String, Int32, Int32)
创建一个新的socket对象并连接到远程的地址,需要指定ip地址以及端口号信息,还有超时时间,单位是毫秒
To create a new socket object and connect to a remote address, you need to specify the IP address and port number information, and the timeout period in milliseconds
(继承自 NetworkBase。)
公共方法Dispose
释放当前的资源
(继承自 NetworkDoubleBase。)
受保护的方法Dispose(Boolean)
释放当前的资源,并自动关闭长连接,如果设置了的话
(继承自 NetworkDoubleBase。)
公共方法Equals
Determines whether the specified object is equal to the current object.
(继承自 Object。)
受保护的方法ExtraAfterReadFromCoreServer
和服务器交互完成的时候调用的方法,可以根据读写结果进行一些额外的操作,具体的操作需要根据实际的需求来重写实现
The method called when the interaction with the server is completed can perform some additional operations based on the read and write results. The specific operations need to be rewritten according to actual needs.
(继承自 NetworkDoubleBase。)
受保护的方法代码示例ExtraOnDisconnect
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道
Select whether to rewrite this method according to the actual protocol. Some protocols need to send some packets to close the current network channel before disconnecting.
(继承自 NetworkDoubleBase。)
受保护的方法代码示例ExtraOnDisconnectAsync
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道
Select whether to rewrite this method according to the actual protocol. Some protocols need to send some packets to close the current network channel before disconnecting.
(继承自 NetworkDoubleBase。)
受保护的方法Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(继承自 Object。)
受保护的方法GetAvailableSocket
获取本次操作的可用的网络通道,如果是短连接,就重新生成一个新的网络通道,如果是长连接,就复用当前的网络通道。
Obtain the available network channels for this operation. If it is a short connection, a new network channel is regenerated. If it is a long connection, the current network channel is reused.
(继承自 NetworkDoubleBase。)
受保护的方法GetAvailableSocketAsync
获取本次操作的可用的网络通道,如果是短连接,就重新生成一个新的网络通道,如果是长连接,就复用当前的网络通道。
Obtain the available network channels for this operation. If it is a short connection, a new network channel is regenerated. If it is a long connection, the current network channel is reused.
(继承自 NetworkDoubleBase。)
公共方法GetHashCode
Serves as the default hash function.
(继承自 Object。)
受保护的方法GetNewNetMessage
获取一个新的消息对象的方法,需要在继承类里面进行重写
The method to get a new message object needs to be overridden in the inheritance class
(重写 NetworkDoubleBaseGetNewNetMessage.)
公共方法GetType
Gets the Type of the current instance.
(继承自 Object。)
受保护的方法代码示例InitializationOnConnect
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。
Whether to rewrite this method is based on the actual protocol. Some protocols require some initial signal handshake to establish a network channel after the connection is created.
(重写 NetworkDoubleBaseInitializationOnConnect(Socket).)
受保护的方法代码示例InitializationOnConnectAsync
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。
Whether to rewrite this method is based on the actual protocol. Some protocols require some initial signal handshake to establish a network channel after the connection is created.
(重写 NetworkDoubleBaseInitializationOnConnectAsync(Socket).)
公共方法IpAddressPing
对当前设备的IP地址进行PING的操作,返回PING的结果,正常来说,返回Success
PING the IP address of the current device and return the PING result. Normally, it returns Success
(继承自 NetworkDoubleBase。)
受保护的方法MemberwiseClone
Creates a shallow copy of the current Object.
(继承自 Object。)
公共方法代码示例Read(String, UInt16)
从Modbus服务器批量读取寄存器的信息,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x03,如果需要使用04功能码,那么地址就写成 x=4;100
To read the register information from the Modbus server in batches, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x03. If you need to use the 04 function code, the address is written as x = 4; 100
(重写 NetworkDeviceBaseRead(String, UInt16).)
公共方法代码示例ReadT
读取支持Hsl特性的数据内容,该特性为HslDeviceAddressAttribute,详细参考api文档说明
Read the data content of the Hsl attribute. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details.
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadAsync(String, UInt16)
从Modbus服务器批量读取寄存器的信息,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x03,如果需要使用04功能码,那么地址就写成 x=4;100
To read the register information from the Modbus server in batches, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x03. If you need to use the 04 function code, the address is written as x = 4; 100
(重写 NetworkDeviceBaseReadAsync(String, UInt16).)
公共方法代码示例ReadAsyncT
异步读取支持Hsl特性的数据内容,该特性为HslDeviceAddressAttribute,详细参考api文档说明
Asynchronously read the data content of the Hsl attribute. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details.
(继承自 NetworkDeviceBase。)
公共方法ReadBool(String)
读取单个的Boolean数据信息
Read a single Boolean data message
(继承自 NetworkDeviceBase。)
公共方法ReadBool(String, UInt16)
批量读取线圈或是离散的数据信息,需要指定地址和长度,具体的结果取决于实现,如果富文本地址不指定,默认使用的功能码是 0x01
To read coils or discrete data in batches, you need to specify the address and length. The specific result depends on the implementation. If the rich text address is not specified, the default function code is 0x01.
(重写 NetworkDeviceBaseReadBool(String, UInt16).)
公共方法ReadBoolAsync(String)
异步读取单个的Boolean数据信息
Asynchronously read a single Boolean data message
(继承自 NetworkDeviceBase。)
公共方法ReadBoolAsync(String, UInt16)
批量读取线圈或是离散的数据信息,需要指定地址和长度,具体的结果取决于实现,如果富文本地址不指定,默认使用的功能码是 0x01
To read coils or discrete data in batches, you need to specify the address and length. The specific result depends on the implementation. If the rich text address is not specified, the default function code is 0x01.
(重写 NetworkDeviceBaseReadBoolAsync(String, UInt16).)
公共方法ReadCoil(String)
读取线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x01
To read the coil, you need to specify the start address. If the rich text address is not specified, the default function code is 0x01.
公共方法ReadCoil(String, UInt16)
批量的读取线圈,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x01
For batch reading coils, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x01.
公共方法ReadCoilAsync(String)
读取线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x01
To read the coil, you need to specify the start address. If the rich text address is not specified, the default function code is 0x01.
公共方法ReadCoilAsync(String, UInt16)
批量的读取线圈,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x01
For batch reading coils, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x01.
公共方法代码示例ReadCustomerT
读取自定义的数据类型,需要继承自IDataTransfer接口
Read custom data types, need to inherit from IDataTransfer interface
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadCustomerAsyncT
异步写入自定义类型的数据,该类型必须继承自IDataTransfer接口
Asynchronously write data of a custom type, which must inherit from the IDataTransfer interface
(继承自 NetworkDeviceBase。)
公共方法ReadDiscrete(String)
读取输入线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x02
To read the input coil, you need to specify the start address. If the rich text address is not specified, the default function code is 0x02.
公共方法ReadDiscrete(String, UInt16)
批量的读取输入点,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x02
To read input points in batches, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x02
公共方法ReadDiscreteAsync(String)
读取输入线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x02
To read the input coil, you need to specify the start address. If the rich text address is not specified, the default function code is 0x02.
公共方法ReadDiscreteAsync(String, UInt16)
批量的读取输入点,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x02
To read input points in batches, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x02
公共方法代码示例ReadDouble(String)
读取双浮点的数据
Read double floating point data
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadDouble(String, UInt16)
读取双浮点数据的数组
Read double floating point data array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadDoubleAsync(String)
异步读取双浮点的数据
Asynchronously read double floating point data
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadDoubleAsync(String, UInt16)
异步读取双浮点数据的数组
Asynchronously read double floating point data array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadFloat(String)
读取单浮点数据
Read single floating point data
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadFloat(String, UInt16)
读取单浮点精度的数组
Read single floating point array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadFloatAsync(String)
异步读取单浮点数据
Asynchronously read single floating point data
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadFloatAsync(String, UInt16)
异步读取单浮点精度的数组
Asynchronously read single floating point array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadFromCoreServer(Byte)
将数据发送到当前的网络通道中,并从网络通道中接收一个INetMessage指定的完整的报文,网络通道将根据GetAvailableSocket方法自动获取,本方法是线程安全的。
Send data to the current network channel and receive a complete message specified by INetMessage from the network channel. The network channel will be automatically obtained according to the GetAvailableSocket method This method is thread-safe.
(继承自 NetworkDoubleBase。)
公共方法代码示例ReadFromCoreServer(Socket, Byte)
将数据报文发送指定的网络通道上,根据当前指定的INetMessage类型,返回一条完整的数据指令
Sends a data message to the specified network channel, and returns a complete data command according to the currently specified INetMessage type
(继承自 NetworkDoubleBase。)
公共方法代码示例ReadFromCoreServerAsync(Byte)
将数据发送到当前的网络通道中,并从网络通道中接收一个INetMessage指定的完整的报文,网络通道将根据GetAvailableSocket方法自动获取,本方法是线程安全的。
Send data to the current network channel and receive a complete message specified by INetMessage from the network channel. The network channel will be automatically obtained according to the GetAvailableSocket method This method is thread-safe.
(继承自 NetworkDoubleBase。)
公共方法代码示例ReadFromCoreServerAsync(Socket, Byte)
将数据报文发送指定的网络通道上,根据当前指定的INetMessage类型,返回一条完整的数据指令
Sends a data message to the specified network channel, and returns a complete data command according to the currently specified INetMessage type
(继承自 NetworkDoubleBase。)
公共方法代码示例ReadInt16(String)
读取16位的有符号的整型数据
Read 16-bit signed integer data
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt16(String, UInt16)
读取16位的有符号整型数组
Read 16-bit signed integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt16Async(String)
异步读取16位的有符号的整型数据
Asynchronously read 16-bit signed integer data
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt16Async(String, UInt16)
异步读取16位的有符号整型数组
Asynchronously read 16-bit signed integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt32(String)
读取32位的有符号整型
Read 32-bit signed integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt32(String, UInt16)
读取32位有符号整型数组
Read 32-bit signed integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt32Async(String)
异步读取32位的有符号整型
Asynchronously read 32-bit signed integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt32Async(String, UInt16)
异步读取32位有符号整型数组
Asynchronously read 32-bit signed integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt64(String)
读取64位的有符号整型
Read 64-bit signed integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt64(String, UInt16)
读取64位的有符号整型数组
Read 64-bit signed integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt64Async(String)
异步读取64位的有符号整型
Asynchronously read 64-bit signed integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadInt64Async(String, UInt16)
异步读取64位的有符号整型数组
Asynchronously read 64-bit signed integer array
(继承自 NetworkDeviceBase。)
受保护的方法ReadStream
读取流中的数据到缓存区,读取的长度需要按照实际的情况来判断
Read the data in the stream to the buffer area. The length of the read needs to be determined according to the actual situation.
(继承自 NetworkBase。)
受保护的方法ReadStreamAsync
读取流中的数据到缓存区,读取的长度需要按照实际的情况来判断
Read the data in the stream to the buffer area. The length of the read needs to be determined according to the actual situation.
(继承自 NetworkBase。)
公共方法代码示例ReadString(String, UInt16)
读取字符串数据,默认为最常见的ASCII编码
Read string data, default is the most common ASCII encoding
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadString(String, UInt16, Encoding)
使用指定的编码,读取字符串数据
Reads string data using the specified encoding
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadStringAsync(String, UInt16)
异步读取字符串数据,默认为最常见的ASCII编码
Asynchronously read string data, default is the most common ASCII encoding
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadStringAsync(String, UInt16, Encoding)
异步使用指定的编码,读取字符串数据
Asynchronously reads string data using the specified encoding
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt16(String)
读取16位的无符号整型
Read 16-bit unsigned integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt16(String, UInt16)
读取16位的无符号整型数组
Read 16-bit unsigned integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt16Async(String)
异步读取16位的无符号整型
Asynchronously read 16-bit unsigned integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt16Async(String, UInt16)
异步读取16位的无符号整型数组
Asynchronously read 16-bit unsigned integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt32(String)
读取32位的无符号整型
Read 32-bit unsigned integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt32(String, UInt16)
读取32位的无符号整型数组
Read 32-bit unsigned integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt32Async(String)
异步读取32位的无符号整型
Asynchronously read 32-bit unsigned integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt32Async(String, UInt16)
异步读取32位的无符号整型数组
Asynchronously read 32-bit unsigned integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt64(String)
读取64位的无符号整型
Read 64-bit unsigned integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt64(String, UInt16)
读取64位的无符号整型的数组
Read 64-bit unsigned integer array
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt64Async(String)
异步读取64位的无符号整型
Asynchronously read 64-bit unsigned integer
(继承自 NetworkDeviceBase。)
公共方法代码示例ReadUInt64Async(String, UInt16)
异步读取64位的无符号整型的数组
Asynchronously read 64-bit unsigned integer array
(继承自 NetworkDeviceBase。)
受保护的方法Receive
接收固定长度的字节数组,允许指定超时时间,默认为60秒,当length大于0时,接收固定长度的数据内容,当length小于0时,接收不大于1024长度的随机数据信息
Receiving a fixed-length byte array, allowing a specified timeout time. The default is 60 seconds. When length is greater than 0, fixed-length data content is received. When length is less than 0, random data information of a length not greater than 1024 is received.
(继承自 NetworkBase。)
受保护的方法ReceiveAndCheckBytes
[自校验] 接收一条完整的同步数据,包含头子节和内容字节,基础的数据,如果结果异常,则结束通讯
[Self-checking] Receive a complete synchronization data, including header subsection and content bytes, basic data, if the result is abnormal, the communication ends
(继承自 NetworkBase。)
受保护的方法ReceiveAndCheckBytesAsync
[自校验] 接收一条完整的同步数据,包含头子节和内容字节,基础的数据,如果结果异常,则结束通讯
[Self-checking] Receive a complete synchronization data, including header subsection and content bytes, basic data, if the result is abnormal, the communication ends
(继承自 NetworkBase。)
受保护的方法ReceiveAsync
接收固定长度的字节数组,允许指定超时时间,默认为60秒,当length大于0时,接收固定长度的数据内容,当length小于0时,接收不大于1024长度的随机数据信息
Receiving a fixed-length byte array, allowing a specified timeout time. The default is 60 seconds. When length is greater than 0, fixed-length data content is received. When length is less than 0, random data information of a length not greater than 1024 is received.
(继承自 NetworkBase。)
受保护的方法ReceiveByMessage
接收一条完整的 数据内容,需要指定超时时间,单位为毫秒。
Receive a complete data content, Need to specify a timeout period in milliseconds
(继承自 NetworkBase。)
受保护的方法ReceiveByMessageAsync
接收一条完整的 数据内容,需要指定超时时间,单位为毫秒。
Receive a complete data content, Need to specify a timeout period in milliseconds
(继承自 NetworkBase。)
受保护的方法ReceiveBytesContentFromSocket
[自校验] 从网络中接收一串字节数据,如果结果异常,则结束通讯
[Self-checking] Receive a string of byte data from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveBytesContentFromSocketAsync
[自校验] 从网络中接收一串字节数据,如果结果异常,则结束通讯
[Self-checking] Receive a string of byte data from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveCommandLineFromSocket(Socket, Byte, Int32)
接收一行命令数据,需要自己指定这个结束符,默认超时时间为60秒,也即是60000,单位是毫秒
To receive a line of command data, you need to specify the terminator yourself. The default timeout is 60 seconds, which is 60,000, in milliseconds.
(继承自 NetworkBase。)
受保护的方法ReceiveCommandLineFromSocket(Socket, Byte, Byte, Int32)
接收一行命令数据,需要自己指定这个结束符,默认超时时间为60秒,也即是60000,单位是毫秒
To receive a line of command data, you need to specify the terminator yourself. The default timeout is 60 seconds, which is 60,000, in milliseconds.
(继承自 NetworkBase。)
受保护的方法ReceiveCommandLineFromSocketAsync(Socket, Byte, Int32)
接收一行命令数据,需要自己指定这个结束符,默认超时时间为60秒,也即是60000,单位是毫秒
To receive a line of command data, you need to specify the terminator yourself. The default timeout is 60 seconds, which is 60,000, in milliseconds.
(继承自 NetworkBase。)
受保护的方法ReceiveCommandLineFromSocketAsync(Socket, Byte, Byte, Int32)
接收一行命令数据,需要自己指定这个结束符,默认超时时间为60秒,也即是60000,单位是毫秒
To receive a line of command data, you need to specify the terminator yourself. The default timeout is 60 seconds, which is 60,000, in milliseconds.
(继承自 NetworkBase。)
受保护的方法ReceiveFrameWebSocketPayload
从socket接收一条WebSocketMessage片段数据,返回WebSocketMessage的数据信息和是否最后一条数据内容
Receive a piece of WebSocketMessage fragment data from the socket, return the data information of WebSocketMessage and whether the last data content
(继承自 NetworkBase。)
受保护的方法ReceiveFrameWebSocketPayloadAsync
从socket接收一条WebSocketMessage片段数据,返回WebSocketMessage的数据信息和是否最后一条数据内容
Receive a piece of WebSocketMessage fragment data from the socket, return the data information of WebSocketMessage and whether the last data content
(继承自 NetworkBase。)
受保护的方法ReceiveHslMessage
接收一条hsl协议的数据信息,自动解析,解压,解码操作,获取最后的实际的数据,接收结果依次为暗号,用户码,负载数据
Receive a piece of hsl protocol data information, automatically parse, decompress, and decode operations to obtain the last actual data. The result is a opCode, user code, and payload data in order.
(继承自 NetworkBase。)
受保护的方法ReceiveHslMessageAsync
接收一条hsl协议的数据信息,自动解析,解压,解码操作,获取最后的实际的数据,接收结果依次为暗号,用户码,负载数据
Receive a piece of hsl protocol data information, automatically parse, decompress, and decode operations to obtain the last actual data. The result is a opCode, user code, and payload data in order.
(继承自 NetworkBase。)
受保护的方法ReceiveMqttMessage
接收一条完成的MQTT协议的报文信息,包含控制码和负载数据
Receive a message of a completed MQTT protocol, including control code and payload data
(继承自 NetworkBase。)
受保护的方法ReceiveMqttMessageAsync
接收一条完成的MQTT协议的报文信息,包含控制码和负载数据
Receive a message of a completed MQTT protocol, including control code and payload data
(继承自 NetworkBase。)
受保护的方法ReceiveRedisCommand
从网络接收一条完整的redis报文的消息
Receive a complete redis message from the network
(继承自 NetworkBase。)
受保护的方法ReceiveRedisCommandAsync
从网络接收一条完整的redis报文的消息
Receive a complete redis message from the network
(继承自 NetworkBase。)
受保护的方法ReceiveRedisCommandString
接收一行基于redis协议的字符串的信息,需要指定固定的长度
Receive a line of information based on the redis protocol string, you need to specify a fixed length
(继承自 NetworkBase。)
受保护的方法ReceiveRedisCommandStringAsync
接收一行基于redis协议的字符串的信息,需要指定固定的长度
Receive a line of information based on the redis protocol string, you need to specify a fixed length
(继承自 NetworkBase。)
受保护的方法ReceiveStringArrayContentFromSocket
[自校验] 从网络中接收一个字符串数组,如果结果异常,则结束通讯
[Self-check] Receive an array of strings from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveStringArrayContentFromSocketAsync
[自校验] 从网络中接收一个字符串数组,如果结果异常,则结束通讯
[Self-check] Receive an array of strings from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveStringContentFromSocket
[自校验] 从网络中接收一个字符串数据,如果结果异常,则结束通讯
[Self-checking] Receive a string of data from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveStringContentFromSocketAsync
[自校验] 从网络中接收一个字符串数据,如果结果异常,则结束通讯
[Self-checking] Receive a string of data from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveWebSocketPayload
从socket接收一条完整的websocket数据,返回WebSocketMessage的数据信息
Receive a complete websocket data from the socket, return the data information of the WebSocketMessage
(继承自 NetworkBase。)
受保护的方法ReceiveWebSocketPayloadAsync
从socket接收一条完整的websocket数据,返回WebSocketMessage的数据信息
Receive a complete websocket data from the socket, return the data information of the WebSocketMessage
(继承自 NetworkBase。)
受保护的方法Send(Socket, Byte)
发送消息给套接字,直到完成的时候返回,经过测试,本方法是线程安全的。
Send a message to the socket until it returns when completed. After testing, this method is thread-safe.
(继承自 NetworkBase。)
受保护的方法Send(Socket, Byte, Int32, Int32)
发送消息给套接字,直到完成的时候返回,经过测试,本方法是线程安全的。
Send a message to the socket until it returns when completed. After testing, this method is thread-safe.
(继承自 NetworkBase。)
受保护的方法SendAccountAndCheckReceive
[自校验] 直接发送字符串数组并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send string array directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendAccountAndCheckReceiveAsync
[自校验] 直接发送字符串数组并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send string array directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendAsync(Socket, Byte)
发送消息给套接字,直到完成的时候返回,经过测试,本方法是线程安全的。
Send a message to the socket until it returns when completed. After testing, this method is thread-safe.
(继承自 NetworkBase。)
受保护的方法SendAsync(Socket, Byte, Int32, Int32)
发送消息给套接字,直到完成的时候返回,经过测试,本方法是线程安全的。
Send a message to the socket until it returns when completed. After testing, this method is thread-safe.
(继承自 NetworkBase。)
受保护的方法SendBaseAndCheckReceive
[自校验] 发送字节数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send the byte data and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendBaseAndCheckReceiveAsync
[自校验] 发送字节数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send the byte data and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendBytesAndCheckReceive
[自校验] 发送字节数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send the byte data and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendBytesAndCheckReceiveAsync
[自校验] 发送字节数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send the byte data and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendStreamToSocket
发送一个流的所有数据到指定的网络套接字,需要指定发送的数据长度,支持按照百分比的进度报告
Send all the data of a stream to the specified network socket. You need to specify the length of the data to be sent. It supports the progress report in percentage.
(继承自 NetworkBase。)
受保护的方法SendStreamToSocketAsync
发送一个流的所有数据到指定的网络套接字,需要指定发送的数据长度,支持按照百分比的进度报告
Send all the data of a stream to the specified network socket. You need to specify the length of the data to be sent. It supports the progress report in percentage.
(继承自 NetworkBase。)
受保护的方法SendStringAndCheckReceive(Socket, Int32, String)
[自校验] 直接发送字符串数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-checking] Send string data directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendStringAndCheckReceive(Socket, Int32, String)
[自校验] 直接发送字符串数组并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send string array directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendStringAndCheckReceiveAsync(Socket, Int32, String)
[自校验] 直接发送字符串数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-checking] Send string data directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendStringAndCheckReceiveAsync(Socket, Int32, String)
[自校验] 直接发送字符串数组并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send string array directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
公共方法SetLoginAccount
设置当前的登录的账户名和密码信息,并启用账户验证的功能,账户名为空时设置不生效
Set the current login account name and password information, and enable the account verification function. The account name setting will not take effect when it is empty
(继承自 NetworkDoubleBase。)
公共方法代码示例SetPersistentConnection
在读取数据之前可以调用本方法将客户端设置为长连接模式,相当于跳过了ConnectServer的结果验证,对异形客户端无效,当第一次进行通信时再进行创建连接请求。
Before reading the data, you can call this method to set the client to the long connection mode, which is equivalent to skipping the result verification of ConnectServer, and it is invalid for the alien client. When the first communication is performed, the connection creation request is performed.
(继承自 NetworkDoubleBase。)
受保护的方法ThreadPoolSocketCheckTimeOut
检查网络套接字是否操作超时,传入的参数需要是HslTimeOut类型,封装socket操作。
Check if the operation of the network socket has timed out. The parameters passed in need to be of type HslTimeOut to encapsulate the socket operation.
(继承自 NetworkBase。)
公共方法ToString
Returns a string that represents the current object.
(重写 NetworkDeviceBaseToString.)
公共方法代码示例Write(String, Double)
写入double数据,返回是否成功
Write double data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, Double)
写入double数组,返回是否成功
Write double array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, Int16)
写入short数组,返回是否成功
Write short array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, Int32)
写入int数据,返回是否成功
Write int data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, Int32)
写入int[]数组,返回是否成功
Write int array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, Int64)
写入long数据,返回是否成功
Write long data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, Int64)
写入long数组,返回是否成功
Write long array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, Single)
写入float数据,返回是否成功
Write float data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, Single)
写入float数组,返回是否成功
Write float array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, String)
写入字符串信息,编码为ASCII
Write string information, encoded as ASCII
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, UInt16)
写入ushort数组,返回是否成功
Write ushort array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, UInt32)
写入uint数据,返回是否成功
Write uint data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, UInt32)
写入uint[]数组,返回是否成功
Write uint array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, UInt64)
写入ulong数据,返回是否成功
Write ulong data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, UInt64)
写入ulong数组,返回是否成功
Write ulong array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法Write(String, Boolean)
向线圈中写入bool数值,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x05
Write bool value to the coil and return whether the writing is successful. If the rich text address is not specified, the default function code is 0x05.
(重写 NetworkDeviceBaseWrite(String, Boolean).)
公共方法Write(String, Boolean)
向线圈中写入bool数组,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x0F
Write the bool array to the coil, and return whether the writing is successful. If the rich text address is not specified, the default function code is 0x0F.
(重写 NetworkDeviceBaseWrite(String, Boolean).)
公共方法代码示例Write(String, Byte)
将数据写入到Modbus的寄存器上去,需要指定起始地址和数据内容,如果富文本地址不指定,默认使用的功能码是 0x10
To write data to Modbus registers, you need to specify the start address and data content. If the rich text address is not specified, the default function code is 0x10
(重写 NetworkDeviceBaseWrite(String, Byte).)
公共方法Write(String, Int16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
(重写 NetworkDeviceBaseWrite(String, Int16).)
公共方法Write(String, UInt16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
(重写 NetworkDeviceBaseWrite(String, UInt16).)
公共方法代码示例Write(String, String, Int32)
写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为ASCII
Write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, it is filled with 0 and the encoding is ASCII.
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, String, Encoding)
写入字符串信息,需要指定的编码信息
Write string information, need to specify the encoding information
(继承自 NetworkDeviceBase。)
公共方法代码示例Write(String, String, Int32, Encoding)
写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为指定的编码信息
Write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, then the operation is complemented with 0 , you should specified the encoding information
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteT(T)
写入支持Hsl特性的数据,返回是否写入成功,该特性为HslDeviceAddressAttribute,详细参考api文档说明
Write data that supports the Hsl attribute, and return whether the write was successful. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details.
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, Double)
异步写入double数据,返回是否成功
Asynchronously write double data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, Double)
异步写入double数组,返回是否成功
Asynchronously write double array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, Int16)
异步写入short数组,返回是否成功
Asynchronously write short array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, Int32)
异步写入int数据,返回是否成功
Asynchronously write int data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, Int32)
异步写入int[]数组,返回是否成功
Asynchronously write int array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, Int64)
异步写入long数据,返回是否成功
Asynchronously write long data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, Int64)
异步写入long数组,返回是否成功
Asynchronously write long array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, Single)
异步写入float数据,返回是否成功
Asynchronously write float data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, Single)
异步写入float数组,返回是否成功
Asynchronously write float array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, String)
异步写入字符串信息,编码为ASCII
Asynchronously write string information, encoded as ASCII
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, UInt16)
异步写入ushort数组,返回是否成功
Asynchronously write ushort array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, UInt32)
异步写入uint数据,返回是否成功
Asynchronously write uint data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, UInt32)
异步写入uint[]数组,返回是否成功
Asynchronously write uint array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, UInt64)
异步写入ulong数据,返回是否成功
Asynchronously write ulong data, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, UInt64)
异步写入ulong数组,返回是否成功
Asynchronously write ulong array, return whether the write was successful
(继承自 NetworkDeviceBase。)
公共方法WriteAsync(String, Boolean)
向线圈中写入bool数值,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x05
Write bool value to the coil and return whether the writing is successful. If the rich text address is not specified, the default function code is 0x05.
(重写 NetworkDeviceBaseWriteAsync(String, Boolean).)
公共方法WriteAsync(String, Boolean)
向线圈中写入bool数组,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x0F
Write the bool array to the coil, and return whether the writing is successful. If the rich text address is not specified, the default function code is 0x0F.
(重写 NetworkDeviceBaseWriteAsync(String, Boolean).)
公共方法代码示例WriteAsync(String, Byte)
将数据写入到Modbus的寄存器上去,需要指定起始地址和数据内容,如果富文本地址不指定,默认使用的功能码是 0x10
To write data to Modbus registers, you need to specify the start address and data content. If the rich text address is not specified, the default function code is 0x10
(重写 NetworkDeviceBaseWriteAsync(String, Byte).)
公共方法WriteAsync(String, Int16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
(重写 NetworkDeviceBaseWriteAsync(String, Int16).)
公共方法WriteAsync(String, UInt16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
(重写 NetworkDeviceBaseWriteAsync(String, UInt16).)
公共方法WriteAsync(String, String, Int32)
异步写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为ASCII
Asynchronously write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, it is filled with 0 and the encoding is ASCII.
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsync(String, String, Encoding)
异步写入字符串信息,需要指定的编码信息
Asynchronously write string information, need to specify the encoding information
(继承自 NetworkDeviceBase。)
公共方法WriteAsync(String, String, Int32, Encoding)
异步写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为指定的编码信息
Asynchronously write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, then the operation is complemented with 0 , you should specified the encoding information
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteAsyncT(T)
异步写入支持Hsl特性的数据,返回是否写入成功,该特性为HslDeviceAddressAttribute,详细参考api文档说明
Asynchronously write data that supports the Hsl attribute, and return whether the write was successful. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details.
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteCustomerT
写入自定义类型的数据,该类型必须继承自IDataTransfer接口
Write data of a custom type, which must inherit from the IDataTransfer interface
(继承自 NetworkDeviceBase。)
公共方法代码示例WriteCustomerAsyncT
异步写入自定义类型的数据,该类型必须继承自IDataTransfer接口
Asynchronously write data of a custom type, which must inherit from the IDataTransfer interface
(继承自 NetworkDeviceBase。)
公共方法WriteMask
向设备写入掩码数据,使用0x16功能码,需要确认对方是否支持相关的操作,掩码数据的操作主要针对寄存器。
To write mask data to the server, using the 0x16 function code, you need to confirm whether the other party supports related operations. The operation of mask data is mainly directed to the register.
公共方法WriteMaskAsync
向设备写入掩码数据,使用0x16功能码,需要确认对方是否支持相关的操作,掩码数据的操作主要针对寄存器。
To write mask data to the server, using the 0x16 function code, you need to confirm whether the other party supports related operations. The operation of mask data is mainly directed to the register.
公共方法WriteOneRegister(String, Int16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
公共方法WriteOneRegister(String, UInt16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
公共方法WriteOneRegisterAsync(String, Int16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
公共方法WriteOneRegisterAsync(String, UInt16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
受保护的方法WriteStream
将缓冲区的数据写入到流里面去
Write the buffer data to the stream
(继承自 NetworkBase。)
受保护的方法WriteStreamAsync
将缓冲区的数据写入到流里面去
Write the buffer data to the stream
(继承自 NetworkBase。)
受保护的方法WriteStreamFromSocket
从套接字中接收所有的数据然后写入到指定的流当中去,需要指定数据的长度,支持按照百分比进行进度报告
Receives all data from the socket and writes it to the specified stream. The length of the data needs to be specified, and progress reporting is supported in percentage.
(继承自 NetworkBase。)
受保护的方法WriteStreamFromSocketAsync
从套接字中接收所有的数据然后写入到指定的流当中去,需要指定数据的长度,支持按照百分比进行进度报告
Receives all data from the socket and writes it to the specified stream. The length of the data needs to be specified, and progress reporting is supported in percentage.
(继承自 NetworkBase。)
Top
字段
  名称说明
受保护的字段CoreSocket
对客户端而言是的通讯用的套接字,对服务器来说是用于侦听的套接字
A communication socket for the client, or a listening socket for the server
(继承自 NetworkBase。)
受保护的字段fileCacheSize
文件传输的时候的缓存大小,直接影响传输的速度,值越大,传输速度越快,越占内存,默认为100K大小
The size of the cache during file transfer directly affects the speed of the transfer. The larger the value, the faster the transfer speed and the more memory it takes. The default size is 100K.
(继承自 NetworkBase。)
受保护的字段InteractiveLock
交互的混合锁,保证交互操作的安全性
Interactive hybrid locks to ensure the security of interactive operations
(继承自 NetworkDoubleBase。)
受保护的字段isPersistentConn
是否是长连接的状态
Whether it is a long connection state
(继承自 NetworkDoubleBase。)
受保护的字段IsSocketError
指示长连接的套接字是否处于错误的状态
Indicates if the long-connected socket is in the wrong state
(继承自 NetworkDoubleBase。)
受保护的字段isUseAccountCertificate
是否使用账号登录,这个账户登录的功能是HSL组件创建的服务器特有的功能。
Whether to log in using an account. The function of this account login is a server-specific function created by the HSL component.
(继承自 NetworkDoubleBase。)
受保护的字段LogMsgFormatBinary
设置日志记录报文是否二进制,如果为False,那就使用ASCII码
Set whether the log message is binary, if it is False, then use ASCII code
(继承自 NetworkDoubleBase。)
受保护的字段receiveTimeOut
接收数据的超时时间,单位:毫秒
Timeout for receiving data, unit: millisecond
(继承自 NetworkDoubleBase。)
Top
扩展方法
  名称说明
公共扩展器方法ToJsonString
获取当前对象的JSON格式表示的字符串。
Gets the string represented by the JSON format of the current object.
(由 HslExtension 定义。)
Top
备注
本客户端支持的标准的modbus协议,Modbus-Tcp及Modbus-Udp内置的消息号会进行自增,比如我们想要控制消息号在0-1000之间自增,不能超过一千,可以写如下的代码:
序号示例
// modbus-tcp和udp的例子是一样的,只是实例化方面不一样,对于rtu及ascii则没有消息号这一个功能
ModbusTcpNet modbusTcp = new ModbusTcpNet( "127.0.0.1", 502 );
// 如果是modbus-udp
ModbusUdpNet modbusUdp = new ModbusUdpNet( "127.0.0.1", 502 );

// 重置最大值,这样的话,消息号就在0-1000
modbusTcp.MessageId.ResetMaxValue( 1000 );

// 如果我们需要一直保持消息号在0,不需要增长的计数
modbusTcp.MessageId.IncreaseTick = 0;

// 同理,我们需要消息号保持在1000
modbusTcp.MessageId.ResetCurrentValue( 1000 );
modbusTcp.MessageId.IncreaseTick = 0;

// 如果消息号需要为1,3,5,7,9,......999
modbusTcp.MessageId.ResetStartValue( 1 );
modbusTcp.MessageId.ResetMaxValue( 999 );
modbusTcp.MessageId.IncreaseTick = 2;

// 更加详细的用法需要参考SoftIncrementCount类
重要事项 重要事项
地址共可以携带3个信息,最完整的表示方式"s=2;x=3;100",对应的modbus报文是 02 03 00 64 00 01 的前四个字节,站号,功能码,起始地址,下面举例
读取线圈
ReadCoil("100")表示读取线圈100的值,ReadCoil("s=2;100")表示读取站号为2,线圈地址为100的值
读取离散输入
ReadDiscrete("100")表示读取离散输入100的值,ReadDiscrete("s=2;100")表示读取站号为2,离散地址为100的值
读取寄存器
ReadInt16("100")表示读取寄存器100的值,ReadInt16("s=2;100")表示读取站号为2,寄存器100的值
读取输入寄存器
ReadInt16("x=4;100")表示读取输入寄存器100的值,ReadInt16("s=2;x=4;100")表示读取站号为2,输入寄存器100的值
对于写入来说也是一致的
写入线圈
WriteCoil("100",true)表示读取线圈100的值,WriteCoil("s=2;100",true)表示读取站号为2,线圈地址为100的值
写入寄存器
Write("100",(short)123)表示写寄存器100的值123,Write("s=2;100",(short)123)表示写入站号为2,寄存器100的值123
特殊说明部分:
01功能码
ReadBool("100")
02功能码
ReadBool("x=2;100")
03功能码
Read("100")
04功能码
Read("x=4;100")
05功能码
Write("100", True)
06功能码
Write("100", (short)100);Write("100", (ushort)100)
0F功能码
Write("100", new bool[]{True})
10功能码
写入寄存器的方法出去上述06功能码的示例,如果写一个short想用10功能码:Write("100", new short[]{100})
示例
基本的用法请参照下面的代码示例
Modbus示例
// 本类支持的读写操作提供了非常多的重载方法,总有你想要的方法
private ModbusTcpNet modbus = new ModbusTcpNet( "192.168.0.1" );   // 实例化
// 如果你的是rtu
private ModbusRtu modbusRtu = new ModbusRtu( 1 );// 实例化

// 方法的调用都是一模一样的。

private void CoilExample()
{
    // 读取线圈示例,使用01功能码
    bool coil100 = modbus.ReadCoil( "100" ).Content;

    // 判断是否读取成功
    OperateResult<bool> result_coil100 = modbus.ReadCoil( "100" );
    if(result_coil100.IsSuccess)
    {
        // success
        bool value = result_coil100.Content;
    }
    else
    {
        // failed
    }

    // 假设读取站号10的线圈100的值
    bool coil_station_ten_100 = modbus.ReadCoil( "s=10;100" ).Content;

    // =============================================================================================
    // 写入也是同理,线圈100写通,使用的是05功能码
    modbus.Write( "100", true );

    // 站号10的线圈写通
    modbus.Write( "s=10;100", true );

    // 想要判断是否写入成功
    if(modbus.Write( "s=10;100", true ).IsSuccess)
    {
        // success
    }
    else
    {
        // failed
    }



    // ===========================================================================================
    // 批量读写也是类似,批量的读取,使用01功能码
    bool[] coil10_19 = modbus.ReadCoil( "100", 10 ).Content;

    // 写入也是同理,使用的0F功能码
    modbus.Write( "100", new bool[] { true, false, true, false, false, false, true, false, false, false } );


    // 离散输入的数据读取同理
}


private void RegisterExample( )
{
    // 读取寄存器100的值,使用的03功能码
    short register100 = modbus.ReadInt16( "100" ).Content;

    // 批量读取寄存器100-109的值
    short[] register100_109 = modbus.ReadInt16( "100", 10 ).Content;

    // 写入寄存器100的值,注意,一定要强制转换short类型,使用的是06功能码
    modbus.Write( "100", (short)123 );

    // 批量写,使用的是10功能码
    modbus.Write( "100", new short[] { 123, -123, 4244 } );


    // ==============================================================================================
    // 以下是一些常规的操作,不再对是否成功的结果进行判断
    // 读取操作,除了第一个,其他都是03功能码
    bool coil100 = modbus.ReadCoil( "100" ).Content;          // 读取线圈100的通断,01功能码
    short short100 = modbus.ReadInt16( "100" ).Content;       // 读取寄存器100的short值
    ushort ushort100 = modbus.ReadUInt16( "100" ).Content;    // 读取寄存器100的ushort值
    int int100 = modbus.ReadInt32( "100" ).Content;           // 读取寄存器100-101的int值
    uint uint100 = modbus.ReadUInt32( "100" ).Content;        // 读取寄存器100-101的uint值
    float float100 = modbus.ReadFloat( "100" ).Content;       // 读取寄存器100-101的float值
    long long100 = modbus.ReadInt64( "100" ).Content;         // 读取寄存器100-103的long值
    ulong ulong100 = modbus.ReadUInt64( "100" ).Content;      // 读取寄存器100-103的ulong值
    double double100 = modbus.ReadDouble( "100" ).Content;    // 读取寄存器100-103的double值
    string str100 = modbus.ReadString( "100", 5 ).Content;    // 读取100到104共10个字符的字符串

    // 写入操作,第一个05功能码,第二第三是06功能码,后面是10功能码
    modbus.Write( "100", true );                              // 写入线圈100为通
    modbus.Write( "100", (short)12345 );                      // 写入寄存器100为12345
    modbus.Write( "100", (ushort)45678 );                     // 写入寄存器100为45678
    modbus.Write( "100", 123456789 );                         // 写入寄存器100-101为123456789
    modbus.Write( "100", (uint)123456778 );                   // 写入寄存器100-101为123456778
    modbus.Write( "100", 123.456 );                           // 写入寄存器100-101为123.456
    modbus.Write( "100", 12312312312414L );                   //写入寄存器100-103为一个大数据
    modbus.Write( "100", 12634534534543656UL );               // 写入寄存器100-103为一个大数据
    modbus.Write( "100", 123.456d );                          // 写入寄存器100-103为一个双精度的数据
    modbus.Write( "100", "K123456789" );
    modbus.Write( "100", "测试数据", Encoding.Unicode );      // 写入unicode编码的中文

    // ===============================================================================================
    // 读取输入寄存器,使用的04功能码
    short input_short100 = modbus.ReadInt16( "x=4;100" ).Content;    // 读取寄存器100的short值
    ushort input_ushort100 = modbus.ReadUInt16( "x=4;100" ).Content; // 读取寄存器100的ushort值
    int input_int100 = modbus.ReadInt32( "x=4;100" ).Content;        // 读取寄存器100-101的int值
    uint input_uint100 = modbus.ReadUInt32( "x=4;100" ).Content;     // 读取寄存器100-101的uint值
    float input_float100 = modbus.ReadFloat( "x=4;100" ).Content;    // 读取寄存器100-101的float值
    long input_long100 = modbus.ReadInt64( "x=4;100" ).Content;      // 读取寄存器100-103的long值
    ulong input_ulong100 = modbus.ReadUInt64( "x=4;100" ).Content;   // 读取寄存器100-103的ulong值
    double input_double100 = modbus.ReadDouble( "x=4;100" ).Content; // 读取寄存器100-103的double值
    string input_str100 = modbus.ReadString( "x=4;100", 5 ).Content; // 读取100到104共10个字符的字符串
}
参见