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

IWebSocket 接口

定义WebSocket服务的接口,继承自IDisposable, IOnlineClient, IClosableClient接口。

Definition

命名空间: TouchSocket.Http.WebSockets
程序集: TouchSocket.Http (在 TouchSocket.Http.dll 中) 版本:3.0.0+ccaf96084d09f972257496d1dd63b8ba3c1e44f0
C#
public interface IWebSocket : IDisposable, 
	IOnlineClient, IClosableClient
Implements
IDisposable, IClosableClient, IOnlineClient

属性

AllowAsyncRead 允许异步Read读取
Client 使用的Http客户端
Online 判断是否在线
(继承自 IOnlineClient。)
Version WebSocket版本

方法

CloseAsync 关闭客户端。
(继承自 IClosableClient。)
DisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(继承自 IDisposable。)
PingAsync 异步发送Ping请求。
PongAsync 异步执行Pong操作。
ReadAsync 异步等待读取数据
SendAsync(ReadOnlyMemoryByte, Boolean) 异步发送指定的字节内存数据。
SendAsync(String, Boolean) 异步发送文本消息。
SendAsync(WSDataFrame, Boolean) 采用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 定义。)

参见