public class WebSocketClient : WebSocketClientBase,
IWebSocketClient, IClient, IDependencyObject, IDisposableObject, IDisposable,
ILoggerObject, IClosableClient, ISetupConfigObject, IResolverConfigObject, IConfigObject,
IPluginObject, IResolverObject, ITcpConnectableClient, IConnectableClient, IWebSocket,
IOnlineClientPublic Class WebSocketClient
Inherits WebSocketClientBase
Implements IWebSocketClient, IClient, IDependencyObject, IDisposableObject,
IDisposable, ILoggerObject, IClosableClient, ISetupConfigObject, IResolverConfigObject,
IConfigObject, IPluginObject, IResolverObject, ITcpConnectableClient, IConnectableClient,
IWebSocket, IOnlineClienttype WebSocketClient =
class
inherit WebSocketClientBase
interface IWebSocketClient
interface IClient
interface IDependencyObject
interface IDisposableObject
interface IDisposable
interface ILoggerObject
interface IClosableClient
interface ISetupConfigObject
interface IResolverConfigObject
interface IConfigObject
interface IPluginObject
interface IResolverObject
interface ITcpConnectableClient
interface IConnectableClient
interface IWebSocket
interface IOnlineClient
end| WebSocketClient | 初始化 WebSocketClient 类的一个新实例 |
| AllowAsyncRead | 允许异步Read读取 |
| Client | 使用的Http客户端 |
| Closed | 当WebSocket断开时触发。 |
| Closing | 当WebSocket收到Close报文时触发。 |
| Config |
配置项
(继承自 SetupConfigObject。) |
| DataHandlingAdapter |
数据处理适配器
(继承自 TcpClientBase。) |
| DisposedValue |
标识该对象是否已被释放
(继承自 DisposableObject。) |
| Handshaked | 表示完成握手后。 |
| Handshaking | 表示在即将握手连接时。 |
| IP |
IP地址
(继承自 TcpClientBase。) |
| IsClient |
表示是否为客户端终端。当为时，表示是客户端。否则为服务器通讯终端。
(继承自 TcpClientBase。) |
| LastReceivedTime |
最后一次接收到数据的时间
(继承自 TcpClientBase。) |
| LastSentTime |
最后一次发送数据的时间
(继承自 TcpClientBase。) |
| Logger |
日志记录器
(继承自 ConfigObject。) |
| MainSocket |
主通信器
(继承自 TcpClientBase。) |
| Online |
判断是否在线
(继承自 WebSocketClientBase。) |
| PluginManager |
插件管理器
(继承自 SetupConfigObject。) |
| Port |
端口号
(继承自 TcpClientBase。) |
| Protocol |
终端协议
(继承自 TcpClientBase。) |
| Received | 收到WebSocket数据 |
| RemoteIPHost | (继承自 TcpClientBase。) |
| Resolver |
获取解析器实例。
(继承自 SetupConfigObject。) |
| UseSsl |
使用Ssl加密
(继承自 TcpClientBase。) |
| Version | WebSocket版本 |
| WebSocket |
实际通讯的WebSocket。
(继承自 WebSocketClientBase。) |
| Abort |
中止连接。
(继承自 TcpClientBase。) |
| CloneTo |
将当前对象的依赖项克隆到目标对象中
(继承自 DependencyObject。) |
| CloseAsync |
关闭客户端。
(继承自 TcpClientBase。) |
| ConnectAsync | (继承自 WebSocketClientBase。) |
| Dispose |
释放资源。内部已经处理了SuppressFinalize(Object) (继承自 DisposableObject。) |
| Dispose(Boolean) |
处置资源
(继承自 HttpClientBase。) |
| 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 |
加载配置
(继承自 SetupConfigObject。) |
| MemberwiseClone | Creates a shallow copy of the current Object. (继承自 Object。) |
| OnTcpClosed |
在连接断开时触发。
如果重写此方法，则不会触发ITcpClosedPlugin插件。 (继承自 WebSocketClientBase。) |
| OnTcpClosing |
即将断开连接(仅主动断开时有效)。
覆盖父类方法，将不会触发ITcpClosingPlugin插件。 (继承自 TcpClientBase。) |
| OnTcpConnected |
建立Tcp连接时触发。
覆盖父类方法，将不会触发ITcpConnectedPlugin插件。 (继承自 TcpClientBase。) |
| OnTcpConnecting |
准备连接的时候，此时已初始化Socket，但是并未建立Tcp连接。
覆盖父类方法，将不会触发ITcpConnectingPlugin插件。 (继承自 HttpClientBase。) |
| OnTcpReceived |
当收到适配器处理的数据时。
(继承自 WebSocketClientBase。) |
| OnTcpReceiving |
当收到原始数据时，触发相关插件进行处理。
(继承自 TcpClientBase。) |
| OnTcpSending |
当即将发送时，如果覆盖父类方法，则不会触发插件。
(继承自 TcpClientBase。) |
| OnWebSocketClosed |
当WebSocket连接关闭时执行的任务。
(重写 WebSocketClientBaseOnWebSocketClosed(ClosedEventArgs)) |
| OnWebSocketClosing |
当WebSocket即将关闭时，执行异步任务。
(重写 WebSocketClientBaseOnWebSocketClosing(ClosedEventArgs)) |
| OnWebSocketHandshaked |
表示完成握手后。
(重写 WebSocketClientBaseOnWebSocketHandshaked(HttpContextEventArgs)) |
| OnWebSocketHandshaking |
表示在即将握手连接时。
(重写 WebSocketClientBaseOnWebSocketHandshaking(HttpContextEventArgs)) |
| OnWebSocketReceived |
当收到WS数据时。
(重写 WebSocketClientBaseOnWebSocketReceived(WSDataFrameEventArgs)) |
| PingAsync | 异步发送Ping请求。 |
| PongAsync | 异步执行Pong操作。 |
| ProtectedClearReceiver | (继承自 TcpClientBase。) |
| ProtectedCreateReceiver | (继承自 TcpClientBase。) |
| ProtectedDefaultSendAsync |
异步发送数据，保护方法。
此方法用于在已建立的TCP连接上异步发送数据。
它首先检查当前实例是否已被弃用，然后检查客户端是否已连接。
如果这些检查通过，它将调用OnTcpSending事件处理程序进行预发送处理，
最后通过TCP核心发送数据。
(继承自 TcpClientBase。) |
| ProtectedRequestAsync |
异步发送Http请求，并仅等待响应头
(继承自 HttpClientBase。) |
| ProtectedRequestContentAsync |
异步发送Http请求，并等待全部响应
(继承自 HttpClientBase。) |
| ProtectedSendAsync(IListArraySegmentByte) |
异步发送数据。
如果数据处理适配器不存在或无法拼接发送，则将所有传输字节合并到一个连续的内存块中发送。
如果数据处理适配器存在且支持拼接发送，则直接发送传输字节列表。
(继承自 TcpClientBase。) |
| ProtectedSendAsync(IRequestInfo) |
异步发送请求信息的受保护方法。
此方法首先检查当前对象是否能够发送请求信息，如果不能，则抛出异常。
如果可以发送，它将使用数据处理适配器来异步发送输入请求。
(继承自 TcpClientBase。) |
| ProtectedSendAsync(ReadOnlyMemoryByte) |
异步发送数据，通过适配器模式灵活处理数据发送。
(继承自 TcpClientBase。) |
| ReadAsync | 异步等待读取数据 |
| RemoveValueTValue |
移除属性值。
(继承自 DependencyObject。) |
| SendAsync(ReadOnlyMemoryByte, Boolean) | 异步发送指定的字节内存数据。 |
| SendAsync(String, Boolean) | 异步发送文本消息。 |
| SendAsync(WSDataFrame, Boolean) | 采用WebSocket协议，发送WS数据。发送结束后，请及时释放WSDataFrame |
| SetAdapter |
设置适配器。
(继承自 TcpClientBase。) |
| SetupAsync |
异步配置设置项
(继承自 SetupConfigObject。) |
| SetValueTValue |
设置依赖注入的值，如果值已经存在，将被覆盖。
(继承自 DependencyObject。) |
| SetWarpAdapter |
设置用于处理单流数据的转换适配器
(继承自 HttpClientBase。) |
| TcpConnectAsync |
异步连接服务器
(继承自 TcpClientBase。) |
| ThrowIfConfigIsNull |
如果Config为空，则抛出ArgumentNullException的异常。
(继承自 ConfigObject。) |
| ThrowIfDisposed |
判断当前对象是否已经被释放。
如果已经被释放，则抛出ObjectDisposedException异常。
(继承自 DisposableObject。) |
| ToString | Returns a string that represents the current object. (继承自 Object。) |
| TryGetValueTValue |
尝试获取依赖注入的值，当没有注入时，会返回。
(继承自 DependencyObject。) |
| TryRemoveValueTValue |
尝试重置属性值，如果没有这个值，则返回。
(继承自 DependencyObject。) |
| Connect |
同步执行连接操作。
(由 ClientExtension 定义。) |
| ConnectAsync |
异步连接
(由 ClientExtension 定义。) |
| GetMessageCombinator |
获取消息合并器。
(由 WebSocketExtension 定义。) |
| Map | (由 Mapper 定义。) |
| Map | (由 Mapper 定义。) |
| MapTTarget | (由 Mapper 定义。) |
| ReadBinaryAsync |
异步读取完整二进制数据。
注意：该访问调用时如果收到非二进制数据则会抛出异常。同时，该方法不可在IWebSocket的接收数据事件（插件）中使用。 相关用法请按照ReadAsync(CancellationToken)进行。 (由 WebSocketExtension 定义。) |
| ReadBinaryAsync |
异步读取完整二进制数据。
注意：该访问调用时如果收到非二进制数据则会抛出异常。同时，该方法不可在IWebSocket的接收数据事件（插件）中使用。 相关用法请按照ReadAsync(CancellationToken)进行。 (由 WebSocketExtension 定义。) |
| ReadStringAsync |
异步读取完整字符串。
注意：该访问调用时如果收到非字符串数据则会抛出异常。同时，该方法不可在IWebSocket的接收数据事件（插件）中使用。 相关用法请按照ReadAsync(CancellationToken)进行。 (由 WebSocketExtension 定义。) |
| ReadStringAsync |
异步读取完整字符串。
注意：该访问调用时如果收到非字符串数据则会抛出异常。同时，该方法不可在IWebSocket的接收数据事件（插件）中使用。 相关用法请按照ReadAsync(CancellationToken)进行。 (由 WebSocketExtension 定义。) |
| SafeDispose |
安全性释放（不用判断对象是否为空）。不会抛出任何异常。
内部会判断DisposedValue的值，如果为，则不会再执行Dispose。 (由 SystemExtension 定义。) |
| SafeDispose |
安全性释放（不用判断对象是否为空）。不会抛出任何异常。
(由 SystemExtension 定义。) |
| Setup |
同步配置方法。
使用给定的配置对象进行设置。
(由 SetupConfigObjectExtension 定义。) |
| ToJsonString |
转换为Json
(由 SerializeConvert 定义。) |
| TryConnect |
同步执行连接操作。不会抛出异常。
(由 ClientExtension 定义。) |
| TryConnectAsync |
尝试连接。不会抛出异常。
(由 ClientExtension 定义。) |