WebSocketDmtpClient 类

WebSocketDmtpClient 类，继承自 SetupConfigObject 并实现了 IWebSocketDmtpClient 接口。该类负责 WebSocket 客户端的配置和管理，提供与 Dmtp 协议相关的功能。

Definition

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

C#

public class WebSocketDmtpClient : SetupClientWebSocket, 
	IWebSocketDmtpClient, IDmtpClient, IDmtpActorObject, IResolverObject, IDependencyClient, 
	IDependencyObject, IDisposableObject, IDisposable, IClient, ILoggerObject, 
	IClosableClient, ISetupConfigObject, IResolverConfigObject, IConfigObject, IPluginObject, 
	IConnectableClient, IIdClient, IOnlineClient, ITcpConnectableClient

VB

Public Class WebSocketDmtpClient
	Inherits SetupClientWebSocket
	Implements IWebSocketDmtpClient, IDmtpClient, IDmtpActorObject, IResolverObject, 
	IDependencyClient, IDependencyObject, IDisposableObject, IDisposable, IClient, 
	ILoggerObject, IClosableClient, ISetupConfigObject, IResolverConfigObject, IConfigObject, 
	IPluginObject, IConnectableClient, IIdClient, IOnlineClient, ITcpConnectableClient

F#

type WebSocketDmtpClient = 
    class
        inherit SetupClientWebSocket
        interface IWebSocketDmtpClient
        interface IDmtpClient
        interface IDmtpActorObject
        interface IResolverObject
        interface IDependencyClient
        interface IDependencyObject
        interface IDisposableObject
        interface IDisposable
        interface IClient
        interface ILoggerObject
        interface IClosableClient
        interface ISetupConfigObject
        interface IResolverConfigObject
        interface IConfigObject
        interface IPluginObject
        interface IConnectableClient
        interface IIdClient
        interface IOnlineClient
        interface ITcpConnectableClient
    end

Inheritance: Object DisposableObject SafetyDisposableObject DependencyObject ConfigObject ResolverConfigObject SetupConfigObject SetupClientWebSocket WebSocketDmtpClient

Implements: IDisposable, IConfigObject, IDependencyObject, IDisposableObject, ILoggerObject, IPluginObject, IResolverConfigObject, IResolverObject, ISetupConfigObject, IDmtpActorObject, IDmtpClient, IWebSocketDmtpClient, IClient, IClosableClient, IConnectableClient, IDependencyClient, IIdClient, IOnlineClient, ITcpConnectableClient

构造函数

WebSocketDmtpClient

初始化WebSocketDmtpClient类的新实例。

属性

ClientWebSocket	通讯实际客户端 (继承自 SetupClientWebSocket。)
ClosedToken	获取一个 CancellationToken，用于指示客户端是否已关闭。 (继承自 SetupClientWebSocket。)
Config	配置项 (继承自 SetupConfigObject。)
DisposedValue	标识该对象是否已被释放 (继承自 DisposableObject。)
DmtpActor	提供Dmtp协议的最基础功能件
Id	用于索引的Id
IsClient	表示是否为客户端终端。当为时，表示是客户端。否则为服务器通讯终端。
LastReceivedTime	(继承自 SetupClientWebSocket。)
LastSentTime	(继承自 SetupClientWebSocket。)
Logger	日志记录器 (继承自 ConfigObject。)
Online	判断是否在线 (重写 SetupClientWebSocketOnline)
PluginManager	插件管理器 (继承自 SetupConfigObject。)
Protocol	(继承自 SetupClientWebSocket。)
RemoteIPHost	(继承自 SetupClientWebSocket。)
Resolver	获取解析器实例。 (继承自 SetupConfigObject。)

方法

CloneTo	将当前对象的依赖项克隆到目标对象中 (继承自 DependencyObject。)
CloseAsync	关闭客户端。 (重写 SetupClientWebSocketCloseAsync(String, CancellationToken))
ConnectAsync	异步连接 (重写 SetupClientWebSocketConnectAsync(CancellationToken))
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	加载配置 (重写 SetupConfigObjectLoadConfig(TouchSocketConfig))
MemberwiseClone	Creates a shallow copy of the current Object. (继承自 Object。)
OnConnected	在完成握手连接时
OnConnecting	即将握手连接时
OnCreateChannel	当创建通道时触发的事件处理程序
OnDmtpClosed	已断开连接。
OnDmtpClosing	当Dmtp即将被关闭时触发。该触发条件有2种：终端主动调用CloseAsync(String, CancellationToken)。终端收到P0_Close的请求。
OnRouting	当需要转发路由包时
OnWebSocketClosed	已断开连接。 (重写 SetupClientWebSocketOnWebSocketClosed(ClosedEventArgs))
OnWebSocketReceived	(重写 SetupClientWebSocketOnWebSocketReceived(WebSocketReceiveResult, ReadOnlySequenceByte))
ProtectedSendAsync	发送数据 (继承自 SetupClientWebSocket。)
RemoveValueTValue	移除属性值。 (继承自 DependencyObject。)
ResetIdAsync	重新设置Id
SafetyDispose	线程安全模式的释放，无论是IDisposable还是GC执行，都只会触发一次 (继承自 SetupClientWebSocket。)
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。)

扩展方法

ChannelExisted	判断指定Id的通道是否已经存在 (由 DmtpActorExtension 定义。)
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	新创建一个直接向目标地址请求的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 定义。)
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 定义。)
Setup	同步配置方法。使用给定的配置对象进行设置。 (由 SetupConfigObjectExtension 定义。)
ToJsonString	转换为Json (由 SerializeConvert 定义。)
TryConnect	同步执行连接操作。不会抛出异常。 (由 ClientExtension 定义。)
TryConnectAsync	尝试连接。不会抛出异常。 (由 ClientExtension 定义。)
TrySendAsync	异步尝试发送数据给指定的客户端。 (由 DmtpActorExtension 定义。)
TrySendAsync	异步尝试发送数据。 (由 DmtpActorExtension 定义。)
TrySendAsync	异步尝试发送一个估计大小小于64K的IPackage。 (由 DmtpActorExtension 定义。)
TrySendAsync	异步尝试发送数据包。此方法通过指定的协议将数据包发送到客户端。它使用估计的最大数据包大小来优化内存申请。 (由 DmtpActorExtension 定义。)
TrySubscribeChannel	尝试订阅已存在的通道。 (由 DmtpActorExtension 定义。)

参见

引用

TouchSocket.Dmtp 命名空间