ClientWebSocket 类

定义

命名空间:

System.Net.WebSockets

程序集:

System.Net.WebSockets.Client.dll

Source:

ClientWebSocket.cs

提供用于连接到 WebSocket 服务的客户端。

public ref class ClientWebSocket sealed : System::Net::WebSockets::WebSocket

public sealed class ClientWebSocket : System.Net.WebSockets.WebSocket

type ClientWebSocket = class
    inherit WebSocket

Public NotInheritable Class ClientWebSocket
Inherits WebSocket

继承

Object

WebSocket

ClientWebSocket

注解

Windows 7、Windows Vista SP2 和 Windows Server 2008 支持 命名空间中的 System.Net.WebSockets 某些类和类元素。 但是，Windows 8 和 Windows Server 2012 仅支持客户端和服务器 WebSocket 的公共实现。 命名空间中 System.Net.WebSockets Windows 7、Windows Vista SP2 和 Windows Server 2008 支持的类元素是抽象类元素。 这允许应用程序开发人员通过客户端 WebSocket 的实际实现继承和扩展这些抽象类类和类元素。

每个 ClientWebSocket 对象并行支持一个发送和一个接收。 不支持同时发出多个发送或多个接收， (例如，不等待或从多个线程发出不同步) ，并且将导致未定义的行为。 在发出下一个操作之前，请确保上一个操作 (等待或) 完成。 应通过最适合你的任何机制（例如，使用锁或信号灯）来序列化访问。

构造函数

ClientWebSocket()

创建 ClientWebSocket 类的实例。

属性

CloseStatus	获取在 ClientWebSocket 实例上启动关闭握手的原因。
CloseStatusDescription	获取对关闭 ClientWebSocket 实例的原因的描述。
HttpResponseHeaders	如果 CollectHttpResponseDetails 设置) 或设置升级响应标头，则获取 (。
HttpStatusCode	如果 CollectHttpResponseDetails 设置了 ，则获取升级响应状态代码。
Options	获取 ClientWebSocket 实例的 WebSocket 选项。
State	获取 ClientWebSocket 实例的 WebSocket 状态。
SubProtocol	获取 ClientWebSocket 实例支持的 WebSocket 子协议。

方法

Abort()	中止连接并取消任何挂起的 IO 操作。
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	关闭作为异步操作的 ClientWebSocket 实例。
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	关闭作为异步操作的 ClientWebSocket 实例的输出。
ConnectAsync(Uri, CancellationToken)	以异步操作的形式连接到 WebSocket 服务器。
ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)	以异步操作的形式连接到 WebSocket 服务器。
Dispose()	释放 ClientWebSocket 实例使用的非托管资源。
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	将 ClientWebSocket 上的数据作为异步操作进行接收。
ReceiveAsync(Memory<Byte>, CancellationToken)	将 ClientWebSocket 上的数据作为异步操作进行接收。
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	以异步操作方式，发送 ClientWebSocket 上的数据。
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	以异步操作方式，从只读字节内存范围发送 ClientWebSocket 上的数据。
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	以异步操作方式，从只读字节内存范围发送 ClientWebSocket 上的数据。
ToString()	返回表示当前对象的字符串。 (继承自 Object)