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

TcpDmtpSessionClient 类

抽象类TcpDmtpSessionClient定义了基于TCP的Dmtp会话客户端的基本行为。 它扩展了TcpSessionClientBase类，并实现了ITcpDmtpSessionClient接口。

Definition

命名空间： TouchSocket.Dmtp
程序集： TouchSocket.Dmtp (在 TouchSocket.Dmtp.dll 中) 版本：4.0.0-beta.143+5fcca7a4e70968794985dc3793adc50531308be6
C#
public abstract class TcpDmtpSessionClient : TcpSessionClientBase, 
	ITcpDmtpSessionClient, ITcpSession, IDependencyClient, IDependencyObject, IDisposableObject, 
	IDisposable, IClient, ILoggerObject, IResolverConfigObject, IConfigObject, 
	IPluginObject, IResolverObject, IOnlineClient, IClosableClient, ITcpListenableClient, 
	IDmtpActorObject, ISessionClient, IIdClient
Inheritance
Object    DisposableObject    SafetyDisposableObject    DependencyObject    ConfigObject    ResolverConfigObject    TcpSessionClientBase    TcpDmtpSessionClient
Implements
IDisposable, IConfigObject, IDependencyObject, IDisposableObject, ILoggerObject, IPluginObject, IResolverConfigObject, IResolverObject, IDmtpActorObject, ITcpDmtpSessionClient, IClient, IClosableClient, IDependencyClient, IIdClient, IOnlineClient, ISessionClient, ITcpListenableClient, ITcpSession

构造函数

TcpDmtpSessionClient 构造函数：初始化TcpDmtpSessionClient实例

属性

ClosedToken 获取一个 CancellationToken，用于指示客户端是否已关闭。
(继承自 TcpSessionClientBase。)
Config 配置项
(继承自 TcpSessionClientBase。)
DataHandlingAdapter 数据处理适配器
(继承自 TcpSessionClientBase。)
DisposedValue 标识该对象是否已被释放
(继承自 DisposableObject。)
DmtpActor 提供Dmtp协议的最基础功能件
Id 用于索引的Id
(继承自 TcpSessionClientBase。)
IP IP地址
(继承自 TcpSessionClientBase。)
IsClient 表示是否为客户端终端。当为时，表示是客户端。否则为服务器通讯终端。
(继承自 TcpSessionClientBase。)
LastReceivedTime 最后一次接收到数据的时间
(继承自 TcpSessionClientBase。)
LastSentTime 最后一次发送数据的时间
(继承自 TcpSessionClientBase。)
ListenOption 监听配置。

注意：一般情况下不要随意修改该值。


(继承自 TcpSessionClientBase。)
Logger 日志记录器
(继承自 ConfigObject。)
Online 判断是否在线
(重写 TcpSessionClientBaseOnline)
PluginManager 插件管理器
(继承自 TcpSessionClientBase。)
Port 端口号
(继承自 TcpSessionClientBase。)
Protocol 终端协议
(继承自 TcpSessionClientBase。)
Resolver 获取解析器实例。
(继承自 TcpSessionClientBase。)
Service 包含此辅助类的主服务器类
(继承自 TcpSessionClientBase。)
ServiceIP 接收此客户端的服务器IP地址
(继承自 TcpSessionClientBase。)
ServicePort 接收此客户端的服务器端口
(继承自 TcpSessionClientBase。)
Transport 获取底层传输对象
(继承自 TcpSessionClientBase。)
UseSsl 使用Ssl加密
(继承自 TcpSessionClientBase。)
VerifyTimeout 验证超时时间,默认为3000ms
VerifyToken 连接令箭

方法

CloneTo 将当前对象的依赖项克隆到目标对象中
(继承自 DependencyObject。)
CloseAsync 发送IDmtpActor关闭消息。
(重写 TcpSessionClientBaseCloseAsync(String, CancellationToken))
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。)
IdChanged 当Id更新的时候触发
(继承自 TcpSessionClientBase。)
MemberwiseCloneCreates a shallow copy of the current Object.
(继承自 Object。)
OnConnected 在完成握手连接时
OnConnecting 在验证Token时
OnCreateChannel 当创建通道时触发的事件处理方法 此方法主要用于在创建通道时，触发相关插件的调用
OnDmtpClosed 当Dmtp关闭以后。
OnDmtpClosing 当Dmtp即将被关闭时触发。

该触发条件有2种：

  1. 终端主动调用CloseAsync(String, CancellationToken)。
  2. 终端收到P0_Close的请求。

OnInitialized 当初始化完成时，执行在OnTcpConnecting(ConnectingEventArgs)之前。
(继承自 TcpSessionClientBase。)
OnRouting 在需要转发路由包时。
OnTcpClosed 客户端已断开连接。

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


(重写 TcpSessionClientBaseOnTcpClosed(ClosedEventArgs))
OnTcpClosing 即将断开连接(仅主动断开时有效)。

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


(重写 TcpSessionClientBaseOnTcpClosing(ClosingEventArgs))
OnTcpConnected 当客户端完整建立Tcp连接时触发。

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


(重写 TcpSessionClientBaseOnTcpConnected(ConnectedEventArgs))
OnTcpConnecting 客户端正在连接。

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


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

扩展方法

ChannelExisted 判断指定Id的通道是否已经存在
(由 DmtpActorExtension 定义。)
CreateChannel 在当前对点创建一个随机Id的通道
(由 DmtpActorExtension 定义。)
CreateChannel 在当前对点创建一个指定Id的通道
(由 DmtpActorExtension 定义。)
CreateChannel 在指定路由点创建一个随机Id的通道
(由 DmtpActorExtension 定义。)
CreateChannel 在指定路由点创建一个指定Id的通道
(由 DmtpActorExtension 定义。)
CreateChannelAsync 在当前对点创建一个随机Id的通道
(由 DmtpActorExtension 定义。)
CreateChannelAsync 在当前对点创建一个指定Id的通道
(由 DmtpActorExtension 定义。)
CreateChannelAsync 在指定路由点创建一个随机Id的通道
(由 DmtpActorExtension 定义。)
CreateChannelAsync 在指定路由点创建一个指定Id的通道
(由 DmtpActorExtension 定义。)
CreateTargetDmtpRpcActor 新创建一个直接向目标地址请求的IDmtpRpcActor客户端。
(由 DmtpRpcActorExtension 定义。)
GetDmtpFileTransferActor 从IDmtpActorObject中获取能实现文件传输的IDmtpFileTransferActor
(由 DmtpFileTransferActorExtension 定义。)
GetDmtpRedisActor 获取IDmtpRedisActor
(由 DmtpRedisActorExtensions 定义。)
GetDmtpRemoteStreamActor 从IDmtpActorObject中获取IDmtpRemoteStreamActor
(由 DmtpRemoteStreamExtension 定义。)
GetDmtpRouterPackageActor 从IDmtpActorObject中获取IDmtpRouterPackageActor
(由 DmtpRouterPackageExtension 定义。)
GetDmtpRpcActor 从IDmtpActorObject中获取IDmtpRpcActor，以实现Rpc调用功能。
(由 DmtpRpcActorExtension 定义。)
GetDmtpRpcActorTDmtpRpcActor 从IDmtpActorObject中获取继承实现IDmtpRpcActor的功能件，以实现Rpc调用功能。
(由 DmtpRpcActorExtension 定义。)
GetJsonRpcActionClient 获取基于会话内部的双工JsonRpc端
(由 JsonRpcClientExtension 定义。)
GetRemoteAccessActor 获取远程访问的IDmtpRemoteAccessActor
(由 DmtpRemoteAccessExtension 定义。)
Map 将源对象的属性映射到目标对象的属性中。
(由 Mapper 定义。)
Map 将源对象映射到目标类型的实例。
(由 Mapper 定义。)
MapTTarget 将源对象映射到指定目标类型的新实例。
(由 Mapper 定义。)
PingAsync 向当前对点发送一个Ping报文，并且等待回应。
(由 DmtpActorExtension 定义。)
PingAsync 向指定路由点发送一个Ping报文，并且等待回应。
(由 DmtpActorExtension 定义。)
SafeDispose 安全性释放（不用判断对象是否为空）。不会抛出任何异常。

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


(由 SystemExtension 定义。)
SafeDispose 安全性释放（不用判断对象是否为空）。不会抛出任何异常。
(由 SystemExtension 定义。)
SendAsync 异步发送空数据
(由 DmtpActorExtension 定义。)
SendAsync 异步发送估计大小小于64K的IPackage。 此方法重载允许指定自定义最大传输单元大小。
(由 DmtpActorExtension 定义。)
SendAsync 异步发送数据
(由 DmtpActorExtension 定义。)
SendAsync 异步发送数据包。 此方法扩展了IDmtpActorObject接口，使其具有发送数据包的能力。
(由 DmtpActorExtension 定义。)
ToJsonString 转换为Json
(由 SerializeConvert 定义。)
TrySendAsync 异步尝试发送数据给指定的客户端。
(由 DmtpActorExtension 定义。)
TrySendAsync 异步尝试发送数据。
(由 DmtpActorExtension 定义。)
TrySendAsync 异步尝试发送一个估计大小小于64K的IPackage。
(由 DmtpActorExtension 定义。)
TrySendAsync 异步尝试发送数据包。 此方法通过指定的协议将数据包发送到客户端。 它使用估计的最大数据包大小来优化内存申请。
(由 DmtpActorExtension 定义。)
TrySubscribeChannel 尝试订阅已存在的通道。
(由 DmtpActorExtension 定义。)

参见