SerialPortClient 类

串口客户端基类

Definition

命名空间： TouchSocket.SerialPorts
程序集： TouchSocket.SerialPorts (在 TouchSocket.SerialPorts.dll 中) 版本：4.0.0-beta.143+5fcca7a4e70968794985dc3793adc50531308be6

C#

public class SerialPortClient : SerialPortClientBase, 
	ISerialPortClient, ISerialPortSession, ISetupConfigObject, IResolverConfigObject, IConfigObject, 
	IDependencyObject, IDisposableObject, IDisposable, ILoggerObject, IPluginObject, 
	IResolverObject, IDependencyClient, IClient, IOnlineClient, IClosableClient, 
	IConnectableClient, IClientSender, ISender, IRequestInfoSender, IReceiverClient<IReceiverResult>

VB

Public Class SerialPortClient
	Inherits SerialPortClientBase
	Implements ISerialPortClient, ISerialPortSession, ISetupConfigObject, IResolverConfigObject, 
	IConfigObject, IDependencyObject, IDisposableObject, IDisposable, ILoggerObject, 
	IPluginObject, IResolverObject, IDependencyClient, IClient, IOnlineClient, 
	IClosableClient, IConnectableClient, IClientSender, ISender, IRequestInfoSender, 
	IReceiverClient(Of IReceiverResult)

F#

type SerialPortClient = 
    class
        inherit SerialPortClientBase
        interface ISerialPortClient
        interface ISerialPortSession
        interface ISetupConfigObject
        interface IResolverConfigObject
        interface IConfigObject
        interface IDependencyObject
        interface IDisposableObject
        interface IDisposable
        interface ILoggerObject
        interface IPluginObject
        interface IResolverObject
        interface IDependencyClient
        interface IClient
        interface IOnlineClient
        interface IClosableClient
        interface IConnectableClient
        interface IClientSender
        interface ISender
        interface IRequestInfoSender
        interface IReceiverClient<IReceiverResult>
    end

Inheritance: Object DisposableObject SafetyDisposableObject DependencyObject ConfigObject ResolverConfigObject SetupConfigObject SerialPortClientBase SerialPortClient

构造函数

SerialPortClient

初始化 SerialPortClient 类的一个新实例

属性

Closed	断开连接
ClosedToken	获取一个 CancellationToken，用于指示客户端是否已关闭。 (继承自 SerialPortClientBase。)
Closing	即将断开连接(仅主动断开时有效)。
Config	配置项 (继承自 SetupConfigObject。)
Connected	成功打开串口
Connecting	准备连接串口的时候
DisposedValue	标识该对象是否已被释放 (继承自 DisposableObject。)
IsClient	表示是否为客户端终端。当为时，表示是客户端。否则为服务器通讯终端。 (继承自 SerialPortClientBase。)
LastReceivedTime	最后一次接收到数据的时间 (继承自 SerialPortClientBase。)
LastSentTime	最后一次发送数据的时间 (继承自 SerialPortClientBase。)
Logger	日志记录器 (继承自 ConfigObject。)
Online	判断是否在线 (继承自 SerialPortClientBase。)
PluginManager	插件管理器 (继承自 SetupConfigObject。)
ProtectedDataHandlingAdapter	(继承自 SerialPortClientBase。)
Protocol	终端协议 (继承自 SerialPortClientBase。)
Received	接收到数据
Resolver	获取解析器实例。 (继承自 SetupConfigObject。)

方法

ClearReceiver	移除同步数据接收器
CloneTo	将当前对象的依赖项克隆到目标对象中 (继承自 DependencyObject。)
CloseAsync	关闭客户端。 (继承自 SerialPortClientBase。)
ConnectAsync	异步连接
CreateReceiver	创建一个同步数据接收器实例。
Dispose	释放资源。内部已经处理了SuppressFinalize(Object) (继承自 DisposableObject。)
Dispose(Boolean)	处置资源 (继承自 SafetyDisposableObject。)
Equals	Determines whether the specified object is equal to the current object. (继承自 Object。)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (继承自 Object。)
GetHashCode	Serves as the default hash function. (继承自 Object。)
GetType	Gets the Type of the current instance. (继承自 Object。)
GetValueTValue	获取依赖注入的值，当没有注入时，会返回默认行为的值。 (继承自 DependencyObject。)
HasValueTValue	判断在当前对象中是否有已设置的属性值。 (继承自 DependencyObject。)
LoadConfig	加载配置 (继承自 SetupConfigObject。)
MemberwiseClone	Creates a shallow copy of the current Object. (继承自 Object。)
OnSerialClosed	断开连接。在客户端未设置连接状态时，不会触发 (重写 SerialPortClientBaseOnSerialClosed(ClosedEventArgs))
OnSerialClosing	即将断开连接(仅主动断开时有效)。 (重写 SerialPortClientBaseOnSerialClosing(ClosingEventArgs))
OnSerialConnected	已经建立连接 (重写 SerialPortClientBaseOnSerialConnected(ConnectedEventArgs))
OnSerialConnecting	准备连接的时候，此时并未建立连接 (重写 SerialPortClientBaseOnSerialConnecting(ConnectingEventArgs))
OnSerialReceived	当收到适配器处理的数据时。 (重写 SerialPortClientBaseOnSerialReceived(ReceivedDataEventArgs))
OnSerialReceiving	当收到原始数据时 (继承自 SerialPortClientBase。)
OnSerialSending	在序列化发送前调用的虚拟方法。 (继承自 SerialPortClientBase。)
ProtectedClearReceiver	清除接收器对象 (继承自 SerialPortClientBase。)
ProtectedCreateReceiver	创建或获取一个接收器对象。 (继承自 SerialPortClientBase。)
ProtectedSendAsync(IRequestInfo, CancellationToken)	异步发送请求信息的受保护方法。此方法首先检查当前对象是否能够发送请求信息，如果不能，则抛出异常。如果可以发送，它将使用数据处理适配器来异步发送输入请求。 (继承自 SerialPortClientBase。)
ProtectedSendAsync(ReadOnlyMemoryByte, CancellationToken)	异步发送数据，通过适配器模式灵活处理数据发送。 (继承自 SerialPortClientBase。)
ReceiveLoopAsync	数据接收主循环，负责从传输层读取数据并分发给适配器或插件。 (继承自 SerialPortClientBase。)
RemoveValueTValue	移除属性值。 (继承自 DependencyObject。)
SafetyDispose	线程安全模式的释放，无论是IDisposable还是GC执行，都只会触发一次 (继承自 SerialPortClientBase。)
SendAsync(IRequestInfo, CancellationToken)	异步发送数据。该发送会经过适配器封装，具体封装内容由适配器决定。
SendAsync(ReadOnlyMemoryByte, CancellationToken)	异步发送数据。该发送会经过适配器封装，具体封装内容由适配器决定。
SerialPortConnectAsync	异步连接到串口设备。 (继承自 SerialPortClientBase。)
SetAdapter	设置数据处理适配器。 (继承自 SerialPortClientBase。)
SetupAsync	异步配置设置项 (继承自 SetupConfigObject。)
SetValueTValue	设置依赖注入的值，如果值已经存在，将被覆盖。 (继承自 DependencyObject。)
ThrowIfConfigIsNull	如果Config为空，则抛出ArgumentNullException的异常。 (继承自 ConfigObject。)
ThrowIfDisposed	判断当前对象是否已经被释放。如果已经被释放，则抛出ObjectDisposedException异常。 (继承自 DisposableObject。)
ToString	Returns a string that represents the current object. (继承自 Object。)
TryGetValueTValue	尝试获取依赖注入的值，当没有注入时，会返回。 (继承自 DependencyObject。)
TryRemoveValueTValue	尝试重置属性值，如果没有这个值，则返回。 (继承自 DependencyObject。)

扩展方法

Connect	同步执行连接操作。 (由 ClientExtension 定义。)
ConnectAsync	异步连接 (由 ClientExtension 定义。)
CreateWaitingClient	创建一个等待客户端，用于处理串口通信中的接收操作。 (由 WaitingClientExtension 定义。)
Map	将源对象的属性映射到目标对象的属性中。 (由 Mapper 定义。)
Map	将源对象映射到目标类型的实例。 (由 Mapper 定义。)
MapTTarget	将源对象映射到指定目标类型的新实例。 (由 Mapper 定义。)
SafeDispose	安全性释放（不用判断对象是否为空）。不会抛出任何异常。内部会判断DisposedValue的值，如果为，则不会再执行Dispose。 (由 SystemExtension 定义。)
SafeDispose	安全性释放（不用判断对象是否为空）。不会抛出任何异常。 (由 SystemExtension 定义。)
Setup	同步配置方法。使用给定的配置对象进行设置。 (由 SetupConfigObjectExtension 定义。)
ToJsonString	转换为Json (由 SerializeConvert 定义。)
TryConnect	同步执行连接操作。不会抛出异常。 (由 ClientExtension 定义。)
TryConnectAsync	尝试连接。不会抛出异常。 (由 ClientExtension 定义。)

参见

引用

TouchSocket.SerialPorts 命名空间