Interface IWebSocketClient

Namespace

Kook.Net.WebSockets

Assembly

Kook.Net.Core.dll

表示一个通用的 WebSocket 客户端。

public interface IWebSocketClient : IDisposable

Inherited Members

IDisposable.Dispose()

Methods

ConnectAsync(string)

连接到指定的主机。

Task ConnectAsync(string host)

Parameters

host string

要连接的主机。

Returns

Task

一个表示异步连接操作的任务。

DisconnectAsync(int)

断开与主机的连接。

Task DisconnectAsync(int closeCode = 1000)

Parameters

closeCode int

要发送给对方主机的关闭代码。

Returns

Task

一个表示异步断开操作的任务。

SendAsync(byte[], int, int, bool)

向对方主机发送文本消息。

Task SendAsync(byte[] data, int index, int count, bool isText)

Parameters

data byte[]

要发送的数据。

index int

要发送的数据的起始位置。

count int

要发送的数据的长度。

isText bool

发送的是否为文本消息。

Returns

Task

一个表示异步发送操作的任务。

SetCancellationToken(CancellationToken)

设置此客户端的取消令牌。

void SetCancellationToken(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

用于取消任务的取消令牌。

SetHeader(string, string)

设置一个将与未来请求一起发送的标头。

void SetHeader(string key, string value)

Parameters

key string

标头的键。

value string

标头的值。

SetKeepAliveInterval(TimeSpan)

设置此客户端的保持活动间隔。

void SetKeepAliveInterval(TimeSpan keepAliveInterval)

Parameters

keepAliveInterval TimeSpan

保持活动间隔。

Remarks

如果未调用此方法，则默认的保持活动间隔是 DefaultKeepAliveInterval。

See Also

KeepAliveInterval

Events

BinaryMessage

当接收到二进制消息时触发。

event Func<byte[], int, int, Task>? BinaryMessage

Event Type

Func<byte[], int, int, Task>

Remarks

事件参数：

1. byte[] 参数是接收到的二进制消息的字节数组。
2. int 参数是接收到的二进制消息的字节数组的起始位置。
3. int 参数是接收到的二进制消息的字节数组的长度。

Closed

当 WebSocket 连接关闭时触发。

event Func<Exception, Task>? Closed

Event Type

Func<Exception, Task>

Remarks

事件参数：

1. Exception 参数是导致连接关闭的异常。

TextMessage

当接收到文本消息时触发。

event Func<string, Task>? TextMessage

Event Type

Func<string, Task>

Remarks

事件参数：

1. string 参数是接收到的文本消息的字符串。