TcpSessionClientBase 类

具有调试显示属性的抽象基类，用于TCP会话客户端。

Definition

命名空间： TouchSocket.Sockets
程序集： TouchSocket (在 TouchSocket.dll 中) 版本：3.0.0+ccaf96084d09f972257496d1dd63b8ba3c1e44f0

C#

public abstract class TcpSessionClientBase : ResolverConfigObject, 
	ITcpSession, IClient, IDependencyObject, IDisposableObject, IDisposable, 
	ILoggerObject, IResolverConfigObject, IConfigObject, IPluginObject, IResolverObject, 
	IOnlineClient, IClosableClient, ITcpListenableClient, IIdClient

VB

Public MustInherit Class TcpSessionClientBase
	Inherits ResolverConfigObject
	Implements ITcpSession, IClient, IDependencyObject, IDisposableObject, 
	IDisposable, ILoggerObject, IResolverConfigObject, IConfigObject, IPluginObject, 
	IResolverObject, IOnlineClient, IClosableClient, ITcpListenableClient, IIdClient

F#

[<AbstractClassAttribute>]
type TcpSessionClientBase = 
    class
        inherit ResolverConfigObject
        interface ITcpSession
        interface IClient
        interface IDependencyObject
        interface IDisposableObject
        interface IDisposable
        interface ILoggerObject
        interface IResolverConfigObject
        interface IConfigObject
        interface IPluginObject
        interface IResolverObject
        interface IOnlineClient
        interface IClosableClient
        interface ITcpListenableClient
        interface IIdClient
    end

Inheritance: Object DisposableObject DependencyObject ConfigObject ResolverConfigObject TcpSessionClientBase

Derived: TouchSocket.DmtpTcpDmtpSessionClient
TouchSocket.HttpHttpSessionClient
TouchSocket.ModbusModbusRtuOverTcpSlaveSessionClient
TouchSocket.ModbusModbusTcpSlaveSessionClient
TouchSocket.SocketsNatSessionClient
TouchSocket.SocketsTcpSessionClient
更多 Less

Implements: IDisposable, IConfigObject, IDependencyObject, IDisposableObject, ILoggerObject, IPluginObject, IResolverConfigObject, IResolverObject, IClient, IClosableClient, IIdClient, IOnlineClient, ITcpListenableClient, ITcpSession

备注

此类提供了基础结构，用于支持TCP会话的客户端，包括ID、IP和端口信息。它实现了与TCP会话、客户端标识和解析器配置相关的接口。

构造函数

TcpSessionClientBase

TcpSessionClientBase 类的构造函数。

属性

Config	配置项 (重写 ConfigObjectConfig)
DataHandlingAdapter	数据处理适配器
DisposedValue	标识该对象是否已被释放 (继承自 DisposableObject。)
Id	用于索引的Id
IP	IP地址
IsClient	表示是否为客户端终端。当为时，表示是客户端。否则为服务器通讯终端。
LastReceivedTime	最后一次接收到数据的时间
LastSentTime	最后一次发送数据的时间
ListenOption	监听配置。注意：一般情况下不要随意修改该值。
Logger	日志记录器 (继承自 ConfigObject。)
MainSocket	主通信器
Online	判断是否在线
PluginManager	插件管理器 (重写 ResolverConfigObjectPluginManager)
Port	端口号
Protocol	终端协议
Resolver	获取解析器实例。 (重写 ResolverConfigObjectResolver)
Service	包含此辅助类的主服务器类
ServiceIP	接收此客户端的服务器IP地址
ServicePort	接收此客户端的服务器端口
UseSsl	使用Ssl加密

方法

Abort	中止当前操作。
CloneTo	将当前对象的依赖项克隆到目标对象中 (继承自 DependencyObject。)
CloseAsync	关闭客户端。
Dispose	释放资源。内部已经处理了SuppressFinalize(Object) (继承自 DisposableObject。)
Dispose(Boolean)	处置资源 (重写 DependencyObjectDispose(Boolean))
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。)
IdChanged	当Id更新的时候触发
MemberwiseClone	Creates a shallow copy of the current Object. (继承自 Object。)
OnInitialized	当初始化完成时，执行在OnTcpConnecting(ConnectingEventArgs)之前。
OnTcpClosed	客户端已断开连接。覆盖父类方法，将不会触发ITcpClosedPlugin插件。
OnTcpClosing	即将断开连接(仅主动断开时有效)。覆盖父类方法，将不会触发ITcpClosingPlugin插件。
OnTcpConnected	当客户端完整建立Tcp连接时触发。覆盖父类方法，将不会触发ITcpConnectedPlugin插件。
OnTcpConnecting	客户端正在连接。覆盖父类方法，将不会触发ITcpConnectingPlugin插件。
OnTcpReceived	当收到适配器处理的数据时。
OnTcpReceiving	当收到原始数据
OnTcpSending	在数据即将通过TCP发送时触发，此方法用于通过插件机制拦截发送行为。如果子类覆盖了此方法，则不会触发插件。
ProtectedClearReceiver	清除接收器对象。
ProtectedCreateReceiver	创建或获取接收器对象。
ProtectedDefaultSendAsync	异步发送数据，保护方法。此方法用于在已建立的TCP连接上异步发送数据。它首先检查当前实例是否已被处置，然后检查客户端是否已连接。如果这些检查通过，它将调用OnTcpSending事件处理程序进行预发送处理，最后通过TCP核心组件实际发送数据。
ProtectedResetIdAsync	直接重置内部Id。
ProtectedSendAsync(IListArraySegmentByte)	异步发送字节传输列表。
ProtectedSendAsync(IRequestInfo)	异步发送请求信息。
ProtectedSendAsync(ReadOnlyMemoryByte)	异步发送只读内存数据。
ProtectedTryGetClient	尝试通过Id获得对应的客户端
RemoveValueTValue	移除属性值。 (继承自 DependencyObject。)
ResetIdAsync	重新设置Id
SetAdapter	设置数据处理适配器。
SetValueTValue	设置依赖注入的值，如果值已经存在，将被覆盖。 (继承自 DependencyObject。)
ThrowIfConfigIsNull	如果Config为空，则抛出ArgumentNullException的异常。 (继承自 ConfigObject。)
ThrowIfDisposed	判断当前对象是否已经被释放。如果已经被释放，则抛出ObjectDisposedException异常。 (继承自 DisposableObject。)
ToString	Returns a string that represents the current object. (继承自 Object。)
TryGetValueTValue	尝试获取依赖注入的值，当没有注入时，会返回。 (继承自 DependencyObject。)
TryRemoveValueTValue	尝试重置属性值，如果没有这个值，则返回。 (继承自 DependencyObject。)

扩展方法

CloseWithTLV	使用TLV格式关闭TCP会话 (由 TLVClientExtensions 定义。)
CloseWithTLVAsync	发送TLV的Close报文，然后关闭当前客户端 (由 TLVClientExtensions 定义。)
Map	(由 Mapper 定义。)
Map	(由 Mapper 定义。)
MapTTarget	(由 Mapper 定义。)
PingWithTLV	发送Tag为Ping的报文，然后等待Pong回应。当适配器不是TLVDataHandlingAdapter时，会抛出异常。 (由 TLVClientExtensions 定义。)
SafeDispose	安全性释放（不用判断对象是否为空）。不会抛出任何异常。内部会判断DisposedValue的值，如果为，则不会再执行Dispose。 (由 SystemExtension 定义。)
SafeDispose	安全性释放（不用判断对象是否为空）。不会抛出任何异常。 (由 SystemExtension 定义。)
ToJsonString	转换为Json (由 SerializeConvert 定义。)

参见

引用

TouchSocket.Sockets 命名空间