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

WebSocketDmtpService 类

WebSocketDmtpService 类,继承自 ConnectableService,并实现 IWebSocketDmtpService 接口。 该类用于处理WebSocket的连接和服务。

Definition

命名空间: TouchSocket.Dmtp.AspNetCore
程序集: TouchSocket.AspNetCore (在 TouchSocket.AspNetCore.dll 中) 版本:4.0.0-beta.143+5fcca7a4e70968794985dc3793adc50531308be6
C#
public class WebSocketDmtpService : ConnectableService<WebSocketDmtpSessionClient>, 
	IWebSocketDmtpService, IDmtpService, IConnectableService<WebSocketDmtpSessionClient>, IConnectableService, 
	IServiceBase, ISetupConfigObject, IResolverConfigObject, IConfigObject, IDependencyObject, 
	IDisposableObject, IDisposable, ILoggerObject, IPluginObject, IResolverObject
Inheritance
Object    DisposableObject    SafetyDisposableObject    DependencyObject    ConfigObject    ResolverConfigObject    SetupConfigObject    ServiceBase    ConnectableService    ConnectableServiceWebSocketDmtpSessionClient    WebSocketDmtpService
Implements
IDisposable, IConfigObject, IDependencyObject, IDisposableObject, ILoggerObject, IPluginObject, IResolverConfigObject, IResolverObject, ISetupConfigObject, IWebSocketDmtpService, IDmtpService, IConnectableService, IConnectableServiceWebSocketDmtpSessionClient, IServiceBase

构造函数

WebSocketDmtpService 构造函数,初始化服务器状态为运行中。

属性

Clients 客户端集合属性,返回一个客户端集合对象,该对象管理所有连接的客户端。
(重写 ConnectableServiceTClientClients)
Config 配置项
(继承自 SetupConfigObject。)
Count 获取已连接的客户端数量
(重写 ConnectableServiceCount)
DisposedValue 标识该对象是否已被释放
(继承自 DisposableObject。)
Logger 日志记录器
(继承自 ConfigObject。)
MaxCount 获取已配置的最大可连接数量
(继承自 ConnectableService。)
PluginManager 插件管理器
(继承自 SetupConfigObject。)
Resolver 获取解析器实例。
(继承自 SetupConfigObject。)
ServerName 服务器名称
(继承自 ServiceBase。)
ServerState 服务器状态
(重写 ServiceBaseServerState)
VerifyToken 

方法

ClearAsync 异步清除所有客户端。
(重写 ConnectableServiceClearAsync)
ClientExists 根据Id判断对应的客户端是否存在
(重写 ConnectableServiceClientExists(String))
ClientInitialized 客户端实例初始化完成。
(继承自 ConnectableServiceTClient。)
CloneTo 将当前对象的依赖项克隆到目标对象中
(继承自 DependencyObject。)
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。)
GetClients 获取所有客户端实例的集合。
(继承自 ConnectableServiceTClient。)
GetHashCodeServes as the default hash function.
(继承自 Object。)
GetIds 获取已连接的所有客户端Id集合
(重写 ConnectableServiceGetIds)
GetNextNewId 尝试获取下一个新的标识符。
(继承自 ConnectableService。)
GetTypeGets the Type of the current instance.
(继承自 Object。)
GetValueTValue 获取依赖注入的值,当没有注入时,会返回默认行为的值。
(继承自 DependencyObject。)
HasValueTValue 判断在当前对象中是否有已设置的属性值。
(继承自 DependencyObject。)
LoadConfig 加载配置
(继承自 ConnectableService。)
MemberwiseCloneCreates a shallow copy of the current Object.
(继承自 Object。)
NewClient 创建新的WebSocketDmtpSessionClient对象。该操作未实现。
(重写 ConnectableServiceTClientNewClient)
RemoveValueTValue 移除属性值。
(继承自 DependencyObject。)
ResetIdAsync 重置指定客户端的Id
(重写 ConnectableServiceResetIdAsync(String, String, CancellationToken))
SafetyDispose 线程安全模式的释放,无论是IDisposable还是GC执行,都只会触发一次
(继承自 SetupConfigObject。)
SetupAsync 异步配置设置项
(继承自 SetupConfigObject。)
SetValueTValue 设置依赖注入的值,如果值已经存在,将被覆盖。
(继承自 DependencyObject。)
StartAsync 异步启动服务。该操作不支持,并抛出异常。
(重写 ServiceBaseStartAsync)
StopAsync 异步停止服务。该操作不支持,并抛出异常。
(重写 ServiceBaseStopAsync(CancellationToken))
SwitchClientAsync 从WebSocket获取新客户端。
ThrowIfConfigIsNull 如果Config为空,则抛出ArgumentNullException的异常。
(继承自 ConfigObject。)
ThrowIfDisposed 判断当前对象是否已经被释放。 如果已经被释放,则抛出ObjectDisposedException异常。
(继承自 DisposableObject。)
ToStringReturns a string that represents the current object.
(继承自 Object。)
TryGetValueTValue 尝试获取依赖注入的值,当没有注入时,会返回
(继承自 DependencyObject。)
TryRemoveValueTValue 尝试重置属性值,如果没有这个值,则返回
(继承自 DependencyObject。)

扩展方法

GetClientWebSocketDmtpSessionClient 从连接服务中获取指定ID的客户端。
(由 ServiceExtension 定义。)
Map 将源对象的属性映射到目标对象的属性中。
(由 Mapper 定义。)
Map 将源对象映射到目标类型的实例。
(由 Mapper 定义。)
MapTTarget 将源对象映射到指定目标类型的新实例。
(由 Mapper 定义。)
SafeDispose 安全性释放(不用判断对象是否为空)。不会抛出任何异常。

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


(由 SystemExtension 定义。)
SafeDispose 安全性释放(不用判断对象是否为空)。不会抛出任何异常。
(由 SystemExtension 定义。)
Setup 同步配置方法。 使用给定的配置对象进行设置。
(由 SetupConfigObjectExtension 定义。)
ToJsonString 转换为Json
(由 SerializeConvert 定义。)
TryGetClientWebSocketDmtpSessionClient 尝试从可连接服务中获取与指定ID匹配的客户端。
(由 ServiceExtension 定义。)

参见