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

IWebSocketClient 接口

用户终端接口

Definition

命名空间: TouchSocket.Http.WebSockets
程序集: TouchSocket.Http (在 TouchSocket.Http.dll 中) 版本:3.0.0+ccaf96084d09f972257496d1dd63b8ba3c1e44f0
C#
public interface IWebSocketClient : IClient, 
	IDependencyObject, IDisposableObject, IDisposable, ILoggerObject, IClosableClient, 
	ISetupConfigObject, IResolverConfigObject, IConfigObject, IPluginObject, IResolverObject, 
	ITcpConnectableClient, IConnectableClient, IWebSocket, IOnlineClient
Implements
IDisposable, IConfigObject, IDependencyObject, IDisposableObject, ILoggerObject, IPluginObject, IResolverConfigObject, IResolverObject, ISetupConfigObject, IWebSocket, IClient, IClosableClient, IConnectableClient, IOnlineClient, ITcpConnectableClient

属性

AllowAsyncRead 允许异步Read读取
(继承自 IWebSocket。)
Client 使用的Http客户端
(继承自 IWebSocket。)
Closed 当WebSocket断开时触发。
Closing 当WebSocket收到Close报文时触发。
Config 配置项
(继承自 IConfigObject。)
DisposedValue 标识该对象是否已被释放
(继承自 IDisposableObject。)
Handshaked 表示完成握手后。
Handshaking 表示在即将握手连接时。
IsClient 表示是否为客户端终端。当为时,表示是客户端。否则为服务器通讯终端。
(继承自 IClient。)
LastReceivedTime 最后一次接收到数据的时间
(继承自 IClient。)
LastSentTime 最后一次发送数据的时间
(继承自 IClient。)
Logger 日志记录器
(继承自 ILoggerObject。)
Online 判断是否在线
(继承自 IOnlineClient。)
PluginManager 插件管理器
(继承自 IPluginObject。)
Protocol 终端协议
(继承自 IClient。)
Received 收到WebSocket数据
RemoteIPHost 获取远程主机信息。
(继承自 ITcpConnectableClient。)
Resolver 获取解析器实例。
(继承自 IResolverObject。)
Version WebSocket版本
(继承自 IWebSocket。)

方法

CloseAsync 关闭客户端。
(继承自 IClosableClient。)
ConnectAsync 异步连接
(继承自 IConnectableClient。)
DisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(继承自 IDisposable。)
GetValueTValue 获取依赖注入的值,当没有注入时,会返回默认行为的值。
(继承自 IDependencyObject。)
HasValueTValue 判断在当前对象中是否有已设置的属性值。
(继承自 IDependencyObject。)
PingAsync 异步发送Ping请求。
(继承自 IWebSocket。)
PongAsync 异步执行Pong操作。
(继承自 IWebSocket。)
ReadAsync 异步等待读取数据
(继承自 IWebSocket。)
RemoveValueTValue 移除属性值。
(继承自 IDependencyObject。)
SendAsync(ReadOnlyMemoryByte, Boolean) 异步发送指定的字节内存数据。
(继承自 IWebSocket。)
SendAsync(String, Boolean) 异步发送文本消息。
(继承自 IWebSocket。)
SendAsync(WSDataFrame, Boolean) 采用WebSocket协议,发送WS数据。发送结束后,请及时释放WSDataFrame
(继承自 IWebSocket。)
SetupAsync 异步配置设置项
(继承自 ISetupConfigObject。)
SetValueTValue 设置依赖注入的值,如果值已经存在,将被覆盖。
(继承自 IDependencyObject。)
TryGetValueTValue 尝试获取依赖注入的值,当没有注入时,会返回
(继承自 IDependencyObject。)
TryRemoveValueTValue 尝试重置属性值,如果没有这个值,则返回
(继承自 IDependencyObject。)

扩展方法

Connect 同步执行连接操作。
(由 ClientExtension 定义。)
ConnectAsync 异步连接
(由 ClientExtension 定义。)
GetMessageCombinator 获取消息合并器。
(由 WebSocketExtension 定义。)
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 定义。)
TryConnect 同步执行连接操作。不会抛出异常。
(由 ClientExtension 定义。)
TryConnectAsync 尝试连接。不会抛出异常。
(由 ClientExtension 定义。)

参见