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

TouchSocket.Sockets 命名空间

 

ByteBlockEventArgs 字节事件参数类,用于在插件之间传递字节块数据
CheckClearPluginTClient 检查清理连接插件。服务器与客户端均适用。
ClientExtension 客户端扩展类
ClientFactoryTClient 客户端工厂的基类,用于创建特定类型的客户端对象。
ClientNotConnectedException 未连接异常
ClientNotFindException 没有找到Id对应的客户端
ClientSslOption 客户端Ssl验证
ClosedEventArgs 断开连接事件参数
ClosingEventArgs 即将断开连接事件参数
ConnectableClientFactoryTClient 适用于可连接客户端的连接工厂。
ConnectableService 表示可连接的服务器基类
ConnectableServiceTClient ConnectableService 类为实现与客户端的连接提供了一个框架。 这个抽象类以泛型的形式定义,允许继承该类的服务处理特定类型的客户端。
ConnectedEventArgs 表示连接事件的参数类,继承自PluginEventArgs。
ConnectingEventArgs 即将连接事件的参数类,继承自MsgPermitEventArgs。 用于处理即将连接事件时传递的信息。
DisconnectEventArgs DisconnectEventArgs
已过时。
HeartbeatPlugin 心跳插件的基类,定义了心跳插件的基本结构和功能。
HeartbeatPluginExtension 心跳插件扩展类
HttpConfigExtensions HttpConfigExtensions
IdChangedEventArgs Id变更事件参数类,用于插件内部Id发生变化时传递相关信息
IPHost IP解析映射
JsonRpcConfigExtension JsonRpcConfigExtension
KeepAliveValue 保活机制
NatServiceTClient Tcp端口转发服务器
NatSessionClient 端口转发辅助类,继承自TcpSessionClient
NatTargetClient 封装类,用于处理NAT穿透后的目标客户端连接。
NormalUdpDataHandlingAdapter 常规UDP数据处理适配器
ReceivedDataEventArgs 接收数据事件参数类,继承自ByteBlockEventArgs 用于封装接收到的数据和相关的请求信息
ReconnectionPluginTClient 重连插件
SenderExtension 发送者扩展类
SendingEventArgs SendingEventArgs 类,继承自 PluginEventArgs,用于封装待发送数据的内存块。
ServiceBase 服务器基类
ServiceExtension 提供针对服务的一系列扩展方法。
ServiceSslOption 服务器Ssl设置
ServiceStateEventArgs 服务器状态事件参数
SocketClientSupports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
已过时。
SocketExtension Socket的扩展方法类
SocketPluginManagerExtension 定义一个静态类SocketPluginManagerExtension,用于扩展Socket插件管理功能
SslOption Ssl配置
TcpClient 表示一个TCP客户端,继承自TcpClientBase并实现了ITcpClient接口。 该类提供了与远程服务器建立TCP连接的功能。
TcpClientBase TcpClientBase类是作为一个抽象基类设计的,它继承自SetupConfigObject,并实现了ITcpSession接口。 这个类的主要目的是为TCP会话相关的操作提供一个基础框架,同时整合了配置设定的功能。
TcpClientFactory 适用于基于TcpClient的连接工厂。
TcpClientFactoryTClient 适用于Tcp客户端的连接工厂。
TcpClientSlim 轻量级Tcp客户端
已过时。
TcpCommandLinePlugin Tcp命令行插件。
TcpDataAdapterTester Tcp数据处理适配器测试
TcpListenOption 监听配置
TcpNetworkMonitor Tcp网络监听器
TcpService Tcp服务类,继承自TcpServiceTClient,实现ITcpService接口。 该类用于提供基于TCP协议的服务。
TcpServiceTClient 抽象类TcpServiceTClient为基于TCP协议的服务提供基础实现。 它扩展了TcpServiceBaseTClient并实现了ITcpServiceTClient接口,其中TClient是TcpSessionClient的一个派生类。 该类旨在为具体的服务类提供一个框架,定义了与TCP客户端会话管理相关的基本功能。
TcpServiceBaseTClient 提供基于TCP的服务基类,用于管理和操作TCP客户端会话。
TcpSessionClient 定义了一个抽象类TcpSessionClient,用于处理TCP会话客户端的连接和数据传输。 它继承自TcpSessionClientBase类,并实现了ITcpSessionClient接口。 该类提供了基础的TCP会话管理功能,包括客户端的标识(Id)、IP地址(IP)和端口号(Port)。 使用DebuggerDisplay属性,可以在调试工具中更清晰地展示每个实例的Id、IP地址和端口号。 继承此类的子类通常需要实现或重写一些方法和属性,以适应特定的业务逻辑和数据处理需求。
TcpSessionClientBase 具有调试显示属性的抽象基类,用于TCP会话客户端。
TLVClientExtensions TLVClientExtensions
TLVDataFrame TLVDataFrame
TLVDataFrameExtensions TLVDataFrameExtensions
TLVDataHandlingAdapter TLVDataHandlingAdapter.

数据格式如下:

  • Tag,ushort类型,大端序
  • Length,byte/ushort/int32类型,大端序
  • Value,byte[]类型

TLVPlugin TLV插件
TouchSocketConfigExtension 触摸套接字配置扩展类
TouchSocketUtility TouchSocketUtility
UdpDataAdapterTester Udp数据处理适配器测试
UdpDataHandlingAdapter Udp数据处理适配器
UdpNetworkMonitor Udp监听器
UdpPackage UDP数据包
UdpPackageAdapter UDP数据包的适配器
UdpReceivedDataEventArgs UdpReceivedDataEventArgs 类,继承自 ReceivedDataEventArgs 类 用于封装 UDP 接收到的数据及相关信息
UdpSendingEventArgs 提供与UDP发送操作相关的事件处理方法。
UdpSession UdpSession 类,继承自 UdpSessionBase 并实现 IUdpSession 接口。 这个类提供了与 UDP 会话相关的操作和属性,是 UDP 会话管理的核心组件。
UdpSessionBase UdpSessionBase 类是 UDP 会话的基础抽象类,继承自 ServiceBase 类,并实现了 IUdpSessionBase 接口。 它提供了 UDP 会话管理的基本功能,包括创建和关闭会话等。
WaitingClientExtension 定义一个静态扩展类,用于处理等待客户端操作的扩展方法
WaitingOptions 等待设置
WebApiConfigExtensions WebApiConfigExtensions
WebSocketConfigExtension WebSocketConfigExtensions
XmlRpcConfigExtensions XmlRpcConfigExtensions

结构

ClientFactoryResultTClient 客户端工厂结果
Protocol 协议类
ResponsedData 响应数据。
UdpFrame UDP数据帧
ValueTLVDataFrame 以1个字节表示Length的TLV

接口

IClient 终端接口
IClientCollectionTClient 客户端集合类
IClientSender 客户端发送接口
IClosableClient 具有关闭动作的对象。
IConnectableClient 定义可连接客户端的行为。
IConnectableService 表示可连接的服务器基类接口
IConnectableServiceTClient 表示可连接的泛型服务器基类接口
IIdChangedPlugin 定义了一个插件接口IIdChangedPlugin,继承自IPlugin。 该接口用于通知实现该接口的插件,某个ID发生了更改。
IIdClient 具有Id的客户端
IIdRequestInfoSender 定义了一个接口,用于异步发送标识符和请求信息
IIdSender 定义了一个接口,用于向特定客户端发送数据
INatServiceTClient 定义了一个支持NAT(网络地址转换)服务的接口,用于扩展ITcpServiceBase服务以支持NAT穿透功能。
INatSessionClient 定义了INatSessionClient接口。 该接口专门用于处理需要网络地址转换(Nat)支持的TCP会话客户端操作。
IOnlineClient 标识在线状态的对象
IReceiverTResult 定义了接收操作结果的接收者接口。 此接口继承自 IDisposableObject,表明接收者对象应该支持释放操作。
IReceiverClientTResult 定义了一个泛型接口,用于创建和管理同步数据接收器客户端
IReceiverResult 接收结果接口,定义了接收操作完成后所需满足的方法和属性
IRequestInfoSender 定义异步请求信息发送器的接口。
ISender 具有发送功能的接口
IServerStartedPlugin 定义了一个插件接口IServerStartedPlugin,该接口继承自IPlugin。 该接口的目的是为那些需要在服务器启动时执行特定操作的插件提供一个标识。
IServerStopedPlugin 定义了一个接口,用于标识和处理服务器停止时的插件行为。
IServiceBase 服务器接口
ISessionClient 定义会话客户端接口,继承自IClient, IIdClient, IClosableClient接口
ISocketClient已过时。
ITcpClient 定义了一个接口,该接口继承了多个与TCP客户端相关的接口,用于统一和扩展TCP客户端的功能。
ITcpClientBase已过时。
ITcpClosedPlugin 定义了一个ITcpClosedPlugin接口,该接口继承自IPlugin接口。 这个接口的目的是为插件提供一种标识,表明该插件支持处理TCP连接关闭时的操作。
ITcpClosingPlugin 定义了即将断开TCP连接时的插件接口。 该接口仅在主动断开连接时有效。
ITcpConnectableClient 定义了ITcpConnectableClient接口,该接口继承自IConnectableClient接口, 用于特化基于TCP协议的客户端操作。
ITcpConnectedPlugin 定义了ITcpConnectedPlugin接口,它是通过TCP连接的插件应实现的接口。 这个接口扩展了IPlugin接口,增加了与TCP连接相关的功能和要求。
ITcpConnectingPlugin 定义了基于TCP连接前的插件接口,继承自IPlugin接口。 该接口提供了特定于TCP连接操作的额外功能和要求。
ITcpDisconnectedPlugin ITcpDisconnectedPlugin
已过时。
ITcpDisconnectedPluginT ITcpDisconnectedPlugin
已过时。
ITcpDisconnectingPlugin ITcpDisconnectingPlugin
已过时。
ITcpDisconnectingPluginT ITcpDisconnectingPlugin
已过时。
ITcpListenableClient 定义一个接口,用于支持TCP监听的客户端操作。
ITcpReceivedPlugin 定义了一个ITcpReceivedPlugin接口,该接口继承自IPlugin接口。 用于处理TCP接收数据的插件,提供了一种扩展机制,允许开发人员实现自定义的数据处理逻辑。
ITcpReceivingPlugin 定义了一个接口,用于通过TCP进行接收操作的插件。 继承自IPlugin接口,表示这是一个插件的一部分,专注于接收TCP数据。
ITcpSendingPlugin 定义了一个ITcpSendingPlugin接口,该接口继承自IPlugin接口。 用于标识插件在系统中负责TCP发送功能。
ITcpService 定义了ITcpService接口,该接口继承自泛型版本的ITcpService接口,其中泛型参数为TcpSessionClient。 这个接口的存在是为了提供一种约束或模板,用于指导实现者如何构建TCP服务。 它规定了TCP服务的基本功能和行为,但不关心这些功能的具体实现细节。
ITcpServiceTClient 定义了一个泛型接口 ITcpService{TClient},用于处理 TCP 服务的核心功能。
ITcpServiceBase 定义了基于TCP协议的服务基础接口。
ITcpServiceBaseTClient 定义了ITcpServiceBase接口,它是连接服务的基接口,专门处理TCP服务。 该接口继承自IConnectableServiceTClient和ITcpServiceBase,约束TClient必须实现ITcpListenableClient, IClient, IIdClient接口。
ITcpSession 定义了一个ITcpSession接口,该接口继承自IClient, IResolverConfigObject, IOnlineClient, IClosableClient等多个接口。 该接口的目的是为TCP会话提供一组标准的方法和属性,以实现TCP会话的创建、管理和关闭等功能。
ITcpSessionClient 定义 ITcpSessionClient 接口,继承自多个接口,以支持 TCP 会话客户端的功能。
ITLVDataFrame ITLVDataFrame
IUdpClientSender 具有Udp终结点的发送
IUdpReceivedPlugin 定义了一个UDP接收插件接口,该接口继承自IPlugin。
IUdpReceiverResult 表示UDP接收结果的接口,继承自通用的接收结果接口。 该接口提供了特定于UDP接收操作的功能。
IUdpRequestInfoSender 定义UDP请求信息发送接口。
IUdpSendingPlugin 定义了一个UDP发送插件接口,继承自IPlugin接口。 该接口为实现UDP数据发送功能的插件提供了一套标准的方法和属性。
IUdpSession 定义一个UDP会话接口,该接口继承自多个与UDP通信相关的接口。 整合了UDP会话的基础功能、客户端发送功能、UDP客户端发送特性和接收客户端特性。
IUdpSessionBase 定义了一个基于UDP的会话接口,该接口继承自通用服务接口IServiceBase和客户端接口IClient。
IWaitingClientTClient, TResult 定义了等待客户端的接口,该客户端既支持发送操作,又能在异步操作中等待结果。

委托

ClosedEventHandlerTClient 客户端已断开连接
ClosingEventHandlerTClient 客户端即将断开连接
ConnectedEventHandlerTClient 客户端已连接
ConnectingEventHandlerTClient 客户端正在连接
ReceivedEventHandlerTClient 接收数据事件
TryOutEventHandlerTClient 尝试获取客户端实例
UdpReceivedEventHandlerTClient UDP数据接收事件

枚举

CheckClearType 检查清理类型
ServerState 服务器状态