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

TcpDmtpClient 类

TcpDmtpClient 类是部分类,实现了 ITcpDmtpClient 接口,用于提供基于 TCP 协议的客户端功能。 继承自 TcpClientBase,复用基础的 TCP 客户端功能。

Definition

命名空间: TouchSocket.Dmtp
程序集: TouchSocket.Dmtp (在 TouchSocket.Dmtp.dll 中) 版本:3.0.0+ccaf96084d09f972257496d1dd63b8ba3c1e44f0
C#
public class TcpDmtpClient : TcpClientBase, 
	ITcpDmtpClient, IDmtpClient, IDmtpActorObject, IClient, IDependencyObject, 
	IDisposableObject, IDisposable, ILoggerObject, IClosableClient, ISetupConfigObject, 
	IResolverConfigObject, IConfigObject, IPluginObject, IResolverObject, IConnectableClient, 
	IIdClient, IOnlineClient, ITcpSession, ITcpConnectableClient
Inheritance
Object    DisposableObject    DependencyObject    ConfigObject    ResolverConfigObject    SetupConfigObject    TcpClientBase    TcpDmtpClient
Implements
IDisposable, IConfigObject, IDependencyObject, IDisposableObject, ILoggerObject, IPluginObject, IResolverConfigObject, IResolverObject, ISetupConfigObject, IDmtpActorObject, IDmtpClient, ITcpDmtpClient, IClient, IClosableClient, IConnectableClient, IIdClient, IOnlineClient, ITcpConnectableClient, ITcpSession

构造函数

TcpDmtpClient 初始化TcpDmtpClient类的新实例

属性

Config 配置项
(继承自 SetupConfigObject。)
DataHandlingAdapter 数据处理适配器
(继承自 TcpClientBase。)
DisposedValue 标识该对象是否已被释放
(继承自 DisposableObject。)
DmtpActor 提供Dmtp协议的最基础功能件
Id 用于索引的Id
IP IP地址
(继承自 TcpClientBase。)
IsClient 表示是否为客户端终端。当为时,表示是客户端。否则为服务器通讯终端。
(继承自 TcpClientBase。)
LastReceivedTime 最后一次接收到数据的时间
(继承自 TcpClientBase。)
LastSentTime 最后一次发送数据的时间
(继承自 TcpClientBase。)
Logger 日志记录器
(继承自 ConfigObject。)
MainSocket 主通信器
(继承自 TcpClientBase。)
Online 判断是否在线
(重写 TcpClientBaseOnline)
PluginManager 插件管理器
(继承自 SetupConfigObject。)
Port 端口号
(继承自 TcpClientBase。)
Protocol 终端协议
(继承自 TcpClientBase。)
RemoteIPHost
(继承自 TcpClientBase。)
Resolver 获取解析器实例。
(继承自 SetupConfigObject。)
UseSsl 使用Ssl加密
(继承自 TcpClientBase。)

方法

Abort 中止连接。
(继承自 TcpClientBase。)
CloneTo 将当前对象的依赖项克隆到目标对象中
(继承自 DependencyObject。)
CloseAsync 发送IDmtpActor关闭消息。
(重写 TcpClientBaseCloseAsync(String))
ConnectAsync 异步连接
Dispose 释放资源。内部已经处理了SuppressFinalize(Object)
(继承自 DisposableObject。)
Dispose(Boolean) 处置资源
(重写 TcpClientBaseDispose(Boolean))
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 加载配置
(重写 SetupConfigObjectLoadConfig(TouchSocketConfig))
MemberwiseCloneCreates a shallow copy of the current Object.
(继承自 Object。)
OnDmtpClosed 当Dmtp关闭以后。
OnDmtpClosing 当Dmtp即将被关闭时触发。

该触发条件有2种:

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

OnDmtpCreatedChannel 当创建通道时触发的事件处理程序
OnDmtpHandshaked 在完成握手连接时
OnDmtpHandshaking 即将握手连接时
OnDmtpRouting 当需要转发路由包时
OnTcpClosed 在连接断开时触发。

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


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

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


(重写 TcpClientBaseOnTcpClosing(ClosingEventArgs))
OnTcpConnected 建立Tcp连接时触发。

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


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

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


(重写 TcpClientBaseOnTcpConnecting(ConnectingEventArgs))
OnTcpReceived 当收到适配器处理的数据时。
(重写 TcpClientBaseOnTcpReceived(ReceivedDataEventArgs))
OnTcpReceiving 当收到原始数据时,触发相关插件进行处理。
(重写 TcpClientBaseOnTcpReceiving(ByteBlock))
OnTcpSending 当即将发送时,如果覆盖父类方法,则不会触发插件。
(继承自 TcpClientBase。)
ProtectedClearReceiver
(继承自 TcpClientBase。)
ProtectedCreateReceiver
(继承自 TcpClientBase。)
ProtectedDefaultSendAsync 异步发送数据,保护方法。 此方法用于在已建立的TCP连接上异步发送数据。 它首先检查当前实例是否已被弃用,然后检查客户端是否已连接。 如果这些检查通过,它将调用OnTcpSending事件处理程序进行预发送处理, 最后通过TCP核心发送数据。
(继承自 TcpClientBase。)
ProtectedSendAsync(IListArraySegmentByte) 异步发送数据。 如果数据处理适配器不存在或无法拼接发送,则将所有传输字节合并到一个连续的内存块中发送。 如果数据处理适配器存在且支持拼接发送,则直接发送传输字节列表。
(继承自 TcpClientBase。)
ProtectedSendAsync(IRequestInfo) 异步发送请求信息的受保护方法。 此方法首先检查当前对象是否能够发送请求信息,如果不能,则抛出异常。 如果可以发送,它将使用数据处理适配器来异步发送输入请求。
(继承自 TcpClientBase。)
ProtectedSendAsync(ReadOnlyMemoryByte) 异步发送数据,通过适配器模式灵活处理数据发送。
(继承自 TcpClientBase。)
RemoveValueTValue 移除属性值。
(继承自 DependencyObject。)
ResetIdAsync 重新设置Id
SetAdapter 设置适配器。
(继承自 TcpClientBase。)
SetupAsync 异步配置设置项
(继承自 SetupConfigObject。)
SetValueTValue 设置依赖注入的值,如果值已经存在,将被覆盖。
(继承自 DependencyObject。)
TcpConnectAsync 异步连接服务器
(继承自 TcpClientBase。)
ThrowIfConfigIsNull 如果Config为空,则抛出ArgumentNullException的异常。
(继承自 ConfigObject。)
ThrowIfDisposed 判断当前对象是否已经被释放。 如果已经被释放,则抛出ObjectDisposedException异常。
(继承自 DisposableObject。)
ToStringReturns a string that represents the current object.
(继承自 Object。)
TryGetValueTValue 尝试获取依赖注入的值,当没有注入时,会返回
(继承自 DependencyObject。)
TryRemoveValueTValue 尝试重置属性值,如果没有这个值,则返回
(继承自 DependencyObject。)

扩展方法

ChannelExisted 判断指定Id的通道是否已经存在
(由 DmtpActorExtension 定义。)
CloseWithTLV 使用TLV格式关闭TCP会话
(由 TLVClientExtensions 定义。)
CloseWithTLVAsync 发送TLV的Close报文,然后关闭当前客户端
(由 TLVClientExtensions 定义。)
Connect 同步执行连接操作。
(由 ClientExtension 定义。)
ConnectAsync 异步连接
(由 ClientExtension 定义。)
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 新创建一个直接向目标地址请求的IRpcClient客户端。
(由 DmtpRpcActorExtension 定义。)
GetDmtpFileTransferActorIDmtpActorObject中获取能实现文件传输的IDmtpFileTransferActor
(由 DmtpFileTransferActorExtension 定义。)
GetDmtpRedisActor 获取IDmtpRedisActor
(由 DmtpRedisActorExtensions 定义。)
GetDmtpRemoteStreamActorIDmtpActorObject中获取IDmtpRemoteStreamActor
(由 DmtpRemoteStreamExtension 定义。)
GetDmtpRouterPackageActorIDmtpActorObject中获取IDmtpRouterPackageActor
(由 DmtpRouterPackageExtension 定义。)
GetDmtpRpcActorIDmtpActorObject中获取IDmtpRpcActor,以实现Rpc调用功能。
(由 DmtpRpcActorExtension 定义。)
GetDmtpRpcActorTDmtpRpcActorIDmtpActorObject中获取继承实现IDmtpRpcActor的功能件,以实现Rpc调用功能。
(由 DmtpRpcActorExtension 定义。)
GetRemoteAccessActor 获取远程访问的IDmtpRemoteAccessActor
(由 DmtpRemoteAccessExtension 定义。)
Map
(由 Mapper 定义。)
Map
(由 Mapper 定义。)
MapTTarget
(由 Mapper 定义。)
Ping 向当前对点发送一个Ping报文,并且等待回应。
(由 DmtpActorExtension 定义。)
Ping 向指定路由点发送一个Ping报文,并且等待回应。
(由 DmtpActorExtension 定义。)
PingAsync 向当前对点发送一个Ping报文,并且等待回应。
(由 DmtpActorExtension 定义。)
PingAsync 向指定路由点发送一个Ping报文,并且等待回应。
(由 DmtpActorExtension 定义。)
PingWithTLV 发送Tag为Ping的报文,然后等待Pong回应。

当适配器不是TLVDataHandlingAdapter时,会抛出异常。


(由 TLVClientExtensions 定义。)
SafeDispose 安全性释放(不用判断对象是否为空)。不会抛出任何异常。

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


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

参见