一款简单易用的基础网络通讯组件库。

ModbusTcpMaster 类

基于Tcp协议的Modbus客户端

Definition

命名空间： TouchSocket.Modbus
程序集： TouchSocket.Modbus (在 TouchSocket.Modbus.dll 中) 版本：4.0.0-beta.143+5fcca7a4e70968794985dc3793adc50531308be6
C#
public class ModbusTcpMaster : TcpClientBase, 
	IModbusTcpMaster, ISetupConfigObject, IResolverConfigObject, IConfigObject, IDependencyObject, 
	IDisposableObject, IDisposable, ILoggerObject, IPluginObject, IResolverObject, 
	IDependencyClient, IClient, ITcpSession, IOnlineClient, IClosableClient, 
	IIgnoreSlaveIdModbusMaster, IModbusMaster, ITcpConnectableClient, IConnectableClient
Inheritance
Object    DisposableObject    SafetyDisposableObject    DependencyObject    ConfigObject    ResolverConfigObject    SetupConfigObject    TcpClientBase    ModbusTcpMaster
Implements
IDisposable, IConfigObject, IDependencyObject, IDisposableObject, ILoggerObject, IPluginObject, IResolverConfigObject, IResolverObject, ISetupConfigObject, IIgnoreSlaveIdModbusMaster, IModbusMaster, IModbusTcpMaster, IClient, IClosableClient, IConnectableClient, IDependencyClient, IOnlineClient, ITcpConnectableClient, ITcpSession

构造函数

ModbusTcpMaster 基于Tcp协议的Modbus客户端

属性

ClosedToken 获取一个 CancellationToken，用于指示客户端是否已关闭。
(继承自 TcpClientBase。)
Config 配置项
(继承自 SetupConfigObject。)
DataHandlingAdapter 数据处理适配器
(继承自 TcpClientBase。)
DisposedValue 标识该对象是否已被释放
(继承自 DisposableObject。)
IP IP地址
(继承自 TcpClientBase。)
IsClient 表示是否为客户端终端。当为时，表示是客户端。否则为服务器通讯终端。
(继承自 TcpClientBase。)
LastReceivedTime 最后一次接收到数据的时间
(继承自 TcpClientBase。)
LastSentTime 最后一次发送数据的时间
(继承自 TcpClientBase。)
Logger 日志记录器
(继承自 ConfigObject。)
Online 判断是否在线
(继承自 TcpClientBase。)
PluginManager 插件管理器
(继承自 SetupConfigObject。)
Port 端口号
(继承自 TcpClientBase。)
Protocol 终端协议
(继承自 TcpClientBase。)
RemoteIPHost 远程IPHost
(继承自 TcpClientBase。)
Resolver 获取解析器实例。
(继承自 SetupConfigObject。)
Transport 获取当前TCP传输层对象。
(继承自 TcpClientBase。)
UseSsl 使用Ssl加密
(继承自 TcpClientBase。)

方法

AuthenticateAsync
(继承自 TcpClientBase。)
CloneTo 将当前对象的依赖项克隆到目标对象中
(继承自 DependencyObject。)
CloseAsync 关闭客户端。
(继承自 TcpClientBase。)
ConnectAsync 异步连接
Dispose 释放资源。内部已经处理了SuppressFinalize(Object)
(继承自 DisposableObject。)
Dispose(Boolean) 处置资源
(继承自 SafetyDisposableObject。)
EqualsDetermines whether the specified object is equal to the current object.
(继承自 Object。)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(继承自 Object。)
GetHashCodeServes as the default hash function.
(继承自 Object。)
GetTypeGets the Type of the current instance.
(继承自 Object。)
GetValueTValue 获取依赖注入的值，当没有注入时，会返回默认行为的值。
(继承自 DependencyObject。)
HasValueTValue 判断在当前对象中是否有已设置的属性值。
(继承自 DependencyObject。)
LoadConfig 加载配置
(继承自 SetupConfigObject。)
MemberwiseCloneCreates a shallow copy of the current Object.
(继承自 Object。)
OnTcpClosed 在连接断开时触发。

如果重写此方法，则不会触发ITcpClosedPlugin插件。


(继承自 TcpClientBase。)
OnTcpClosing 即将断开连接(仅主动断开时有效)。

覆盖父类方法，将不会触发ITcpClosingPlugin插件。


(继承自 TcpClientBase。)
OnTcpConnected 建立Tcp连接时触发。

覆盖父类方法，将不会触发ITcpConnectedPlugin插件。


(继承自 TcpClientBase。)
OnTcpConnecting 准备连接的时候，此时已初始化Socket，但是并未建立Tcp连接。

覆盖父类方法，将不会触发ITcpConnectingPlugin插件。


(重写 TcpClientBaseOnTcpConnecting(ConnectingEventArgs))
OnTcpReceived 当收到适配器处理的数据时。
(重写 TcpClientBaseOnTcpReceived(ReceivedDataEventArgs))
OnTcpReceiving 当收到原始数据时，触发相关插件进行处理。
(继承自 TcpClientBase。)
OnTcpSending 当即将发送时，如果覆盖父类方法，则不会触发插件。
(继承自 TcpClientBase。)
ProtectedClearReceiver 清除内部接收器。
(继承自 TcpClientBase。)
ProtectedCreateReceiver 创建内部接收器。
(继承自 TcpClientBase。)
ProtectedSendAsync(IRequestInfo, CancellationToken) 异步发送请求信息的受保护方法。 此方法首先检查当前对象是否能够发送请求信息，如果不能，则抛出异常。 如果可以发送，它将使用数据处理适配器来异步发送输入请求。
(继承自 TcpClientBase。)
ProtectedSendAsync(ReadOnlyMemoryByte, CancellationToken) 异步发送数据，通过适配器模式灵活处理数据发送。
(继承自 TcpClientBase。)
ReceiveLoopAsync 数据接收主循环，负责从传输层读取数据并分发给适配器或插件。
(继承自 TcpClientBase。)
RemoveValueTValue 移除属性值。
(继承自 DependencyObject。)
SafetyDispose 线程安全模式的释放，无论是IDisposable还是GC执行，都只会触发一次
(继承自 TcpClientBase。)
SendModbusRequestAsync 异步发送Modbus请求
SetAdapter 设置适配器。
(继承自 TcpClientBase。)
SetupAsync 异步配置设置项
(继承自 SetupConfigObject。)
SetValueTValue 设置依赖注入的值，如果值已经存在，将被覆盖。
(继承自 DependencyObject。)
TcpConnectAsync 异步连接服务器
(继承自 TcpClientBase。)
ThrowIfClientNotConnected 如果TCP客户端未连接，则抛出异常。
(继承自 TcpClientBase。)
ThrowIfConfigIsNull 如果Config为空，则抛出ArgumentNullException的异常。
(继承自 ConfigObject。)
ThrowIfDisposed 判断当前对象是否已经被释放。 如果已经被释放，则抛出ObjectDisposedException异常。
(继承自 DisposableObject。)
ToStringReturns a string that represents the current object.
(继承自 Object。)
TryGetValueTValue 尝试获取依赖注入的值，当没有注入时，会返回。
(继承自 DependencyObject。)
TryRemoveValueTValue 尝试重置属性值，如果没有这个值，则返回。
(继承自 DependencyObject。)

扩展方法

Connect 同步执行连接操作。
(由 ClientExtension 定义。)
ConnectAsync 异步连接
(由 ClientExtension 定义。)
CreateModbusObjectTModbusObject 创建一个Modbus对象类型。
(由 ModbusMasterProExtension 定义。)
Map 将源对象的属性映射到目标对象的属性中。
(由 Mapper 定义。)
Map 将源对象映射到目标类型的实例。
(由 Mapper 定义。)
MapTTarget 将源对象映射到指定目标类型的新实例。
(由 Mapper 定义。)
ReadCoils 忽略站点（默认站号为1）读取线圈（FC1），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadCoils 从指定站点读取线圈（FC1），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadCoils 从指定站点读取线圈（FC1）。
(由 ModbusMasterExtension 定义。)
ReadCoilsAsync 异步忽略站点（默认站号为1）读取线圈（FC1），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadCoilsAsync 异步从指定站点读取线圈（FC1），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadCoilsAsync 异步从指定站点读取线圈（FC1）。
(由 ModbusMasterExtension 定义。)
ReadDiscreteInputs 忽略站点（默认站号为1）读离散输入状态（FC2），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadDiscreteInputs 从指定站点读离散输入状态（FC2），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadDiscreteInputs 从指定站点读离散输入状态（FC2）。
(由 ModbusMasterExtension 定义。)
ReadDiscreteInputsAsync 异步忽略站点（默认站号为1）读离散输入状态（FC2），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadDiscreteInputsAsync 异步从指定站点读离散输入状态（FC2），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadDiscreteInputsAsync 异步从指定站点读离散输入状态（FC2）。
(由 ModbusMasterExtension 定义。)
ReadHoldingRegisters 忽略站点（默认站号为1）读保持寄存器（FC3），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadHoldingRegisters 从指定站点读保持寄存器（FC3），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadHoldingRegisters 从指定站点读保持寄存器（FC3）。
(由 ModbusMasterExtension 定义。)
ReadHoldingRegistersAsync 异步忽略站点（默认站号为1）读保持寄存器（FC3），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadHoldingRegistersAsync 异步从指定站点读保持寄存器（FC3），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadHoldingRegistersAsync 异步从指定站点读保持寄存器（FC3）。
(由 ModbusMasterExtension 定义。)
ReadInputRegisters 忽略站点（默认站号为1）读输入寄存器（FC4），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadInputRegisters 从指定站点读输入寄存器（FC4），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadInputRegisters 从指定站点读输入寄存器（FC4）。
(由 ModbusMasterExtension 定义。)
ReadInputRegistersAsync 异步忽略站点（默认站号为1）读输入寄存器（FC4），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadInputRegistersAsync 异步从指定站点读输入寄存器（FC4），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadInputRegistersAsync 异步从指定站点读输入寄存器（FC4）。
(由 ModbusMasterExtension 定义。)
ReadWriteMultipleRegisters 读写多个寄存器（FC23），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadWriteMultipleRegisters 读写多个寄存器（FC23），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadWriteMultipleRegisters 读写多个寄存器（FC23）
(由 ModbusMasterExtension 定义。)
ReadWriteMultipleRegistersAsync 读写多个寄存器（FC23），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
ReadWriteMultipleRegistersAsync 读写多个寄存器（FC23），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
ReadWriteMultipleRegistersAsync 读写多个寄存器（FC23）
(由 ModbusMasterExtension 定义。)
SafeDispose 安全性释放（不用判断对象是否为空）。不会抛出任何异常。

内部会判断DisposedValue的值，如果为，则不会再执行Dispose。


(由 SystemExtension 定义。)
SafeDispose 安全性释放（不用判断对象是否为空）。不会抛出任何异常。
(由 SystemExtension 定义。)
SendModbusRequest 向Modbus从机设备发送一个Modbus请求。
(由 ModbusMasterExtension 定义。)
SendModbusRequestAsync
(由 ModbusMasterExtension 定义。)
Setup 同步配置方法。 使用给定的配置对象进行设置。
(由 SetupConfigObjectExtension 定义。)
ToJsonString 转换为Json
(由 SerializeConvert 定义。)
TryConnect 同步执行连接操作。不会抛出异常。
(由 ClientExtension 定义。)
TryConnectAsync 尝试连接。不会抛出异常。
(由 ClientExtension 定义。)
WriteMultipleCoils 忽略站点（默认站号为1）写入多个线圈（FC15），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
WriteMultipleCoils 向指定站点写入多个线圈（FC15），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
WriteMultipleCoils 向指定站点写入多个线圈（FC15）。
(由 ModbusMasterExtension 定义。)
WriteMultipleCoilsAsync 异步忽略站点（默认站号为1）写入多个线圈（FC15），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
WriteMultipleCoilsAsync 异步向指定站点写入多个线圈（FC15），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
WriteMultipleCoilsAsync 异步向指定站点写入多个线圈（FC15）。
(由 ModbusMasterExtension 定义。)
WriteMultipleRegisters 忽略站点（默认站号为1）写入多个寄存器（FC16），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
WriteMultipleRegisters 向指定站点写入多个寄存器（FC16），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
WriteMultipleRegisters 向指定站点写入多个寄存器（FC16）。
(由 ModbusMasterExtension 定义。)
WriteMultipleRegistersAsync 异步忽略站点（默认站号为1）写入多个寄存器（FC16），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
WriteMultipleRegistersAsync 异步向指定站点写入多个寄存器（FC16），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
WriteMultipleRegistersAsync 异步向指定站点写入多个寄存器（FC16）。
(由 ModbusMasterExtension 定义。)
WriteSingleCoil 忽略站点（默认站号为1）写入单个线圈（FC5），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
WriteSingleCoil 向指定站点写入单个线圈（FC5），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
WriteSingleCoil 向指定站点写入单个线圈（FC5）。
(由 ModbusMasterExtension 定义。)
WriteSingleCoilAsync 异步忽略站点（默认站号为1）写入单个线圈（FC5），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
WriteSingleCoilAsync 异步向指定站点写入单个线圈（FC5），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
WriteSingleCoilAsync 异步向指定站点写入单个线圈（FC5）。
(由 ModbusMasterExtension 定义。)
WriteSingleRegister 忽略站点（默认站号为1）写入单个寄存器（FC6），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
WriteSingleRegister 向指定站点写入单个寄存器（FC6），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
WriteSingleRegister 向指定站点写入单个寄存器（FC6）
(由 ModbusMasterExtension 定义。)
WriteSingleRegister 向指定站点写入单个寄存器（FC6）
(由 ModbusMasterExtension 定义。)
WriteSingleRegisterAsync 异步忽略站点（默认站号为1）写入单个寄存器（FC6），默认超时时间为1000ms。
(由 ModbusIgnoreSlaveMasterExtension 定义。)
WriteSingleRegisterAsync 异步向指定站点写入单个寄存器（FC6），默认超时时间为1000ms。
(由 ModbusMasterExtension 定义。)
WriteSingleRegisterAsync 异步向指定站点写入单个寄存器（FC6）
(由 ModbusMasterExtension 定义。)
WriteSingleRegisterAsync 异步向指定站点写入单个寄存器（FC6）
(由 ModbusMasterExtension 定义。)

参见