public interface IWebSocket : IDisposable,
IOnlineClient, IClosableClient, IResolverObject, IClient, ILoggerObject,
IDisposableObjectPublic Interface IWebSocket
Inherits IDisposable, IOnlineClient, IClosableClient, IResolverObject,
IClient, ILoggerObject, IDisposableObjecttype IWebSocket =
interface
interface IDisposable
interface IOnlineClient
interface IClosableClient
interface IResolverObject
interface IClient
interface ILoggerObject
interface IDisposableObject
end| AllowAsyncRead | 允许异步Read读取 |
| Client | 使用的Http客户端 |
| ClosedToken |
获取一个 CancellationToken，用于指示客户端是否已关闭。
(继承自 IClosableClient。) |
| CloseStatus | 获取最后WebSocket关闭状态。 |
| DisposedValue |
标识该对象是否已被释放
(继承自 IDisposableObject。) |
| IsClient |
表示是否为客户端终端。当为时，表示是客户端。否则为服务器通讯终端。
(继承自 IClient。) |
| LastReceivedTime |
最后一次接收到数据的时间
(继承自 IClient。) |
| LastSentTime |
最后一次发送数据的时间
(继承自 IClient。) |
| Logger |
日志记录器
(继承自 ILoggerObject。) |
| Online |
判断是否在线
(继承自 IOnlineClient。) |
| Protocol |
终端协议
(继承自 IClient。) |
| Resolver |
获取解析器实例。
(继承自 IResolverObject。) |
| Version | WebSocket版本 |
| CloseAsync(String, CancellationToken) |
关闭客户端。
(继承自 IClosableClient。) |
| CloseAsync(WebSocketCloseStatus, String, CancellationToken) | 异步关闭WebSocket连接。 |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (继承自 IDisposable。) |
| PingAsync | 异步发送Ping请求。 |
| PongAsync | 异步执行Pong操作。 |
| ReadAsync | 异步等待读取数据 |
| SendAsync(ReadOnlyMemoryByte, Boolean, CancellationToken) | 异步发送指定的字节内存数据。 |
| SendAsync(String, Boolean, CancellationToken) | 异步发送文本消息。 |
| SendAsync(WSDataFrame, Boolean, CancellationToken) | 采用WebSocket协议，发送WS数据。发送结束后，请及时释放WSDataFrame |
| GetMessageCombinator |
获取消息合并器。
(由 WebSocketExtension 定义。) |
| ReadBinaryAsync |
异步读取完整二进制数据。
注意：该访问调用时如果收到非二进制数据则会抛出异常。同时，该方法不可在IWebSocket的接收数据事件（插件）中使用。 相关用法请按照ReadAsync(CancellationToken)进行。 (由 WebSocketExtension 定义。) |
| ReadBinaryAsync |
异步读取完整二进制数据。
注意：该访问调用时如果收到非二进制数据则会抛出异常。同时，该方法不可在IWebSocket的接收数据事件（插件）中使用。 相关用法请按照ReadAsync(CancellationToken)进行。 (由 WebSocketExtension 定义。) |
| ReadStringAsync |
异步读取完整字符串。
注意：该访问调用时如果收到非字符串数据则会抛出异常。同时，该方法不可在IWebSocket的接收数据事件（插件）中使用。 相关用法请按照ReadAsync(CancellationToken)进行。 (由 WebSocketExtension 定义。) |
| ReadStringAsync |
异步读取完整字符串。
注意：该访问调用时如果收到非字符串数据则会抛出异常。同时，该方法不可在IWebSocket的接收数据事件（插件）中使用。 相关用法请按照ReadAsync(CancellationToken)进行。 (由 WebSocketExtension 定义。) |
| SafeDispose |
安全性释放（不用判断对象是否为空）。不会抛出任何异常。
(由 SystemExtension 定义。) |
| SafeDispose |
安全性释放（不用判断对象是否为空）。不会抛出任何异常。
内部会判断DisposedValue的值，如果为，则不会再执行Dispose。 (由 SystemExtension 定义。) |
| SendAsync |
异步发送数据帧。
(由 WebSocketClientExtension 定义。) |