WebSocket 类

定义

命名空间:

System.Net.WebSockets

程序集:

System.Net.WebSockets.dll

Source:

WebSocket.cs

WebSocket 类允许应用程序在 WebSocket 升级完成后发送和接收数据。

public ref class WebSocket abstract : IDisposable

public abstract class WebSocket : IDisposable

type WebSocket = class
    interface IDisposable

Public MustInherit Class WebSocket
Implements IDisposable

继承

Object

WebSocket

派生

System.Net.WebSockets.ClientWebSocket

System.Web.WebSockets.AspNetWebSocket

实现

IDisposable

注解

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

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

构造函数

WebSocket()

创建 WebSocket 类的实例。

属性

CloseStatus	指示远程终结点启动关闭握手的原因。
CloseStatusDescription	允许远程终结点描述关闭该连接的原因。
DefaultKeepAliveInterval	获取默认 WebSocket 协议保持活动状态的间隔。
State	返回 WebSocket 连接的当前状态。
SubProtocol	获取在打开握手期间协商的子协议。

方法

Abort()	中止 WebSocket 连接并取消任何挂起的 IO 操作。
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	使用在 WebSocket 协议规范第 7 节中定义的关闭握手关闭作为异步操作的 WebSocket 连接。
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	启动或完成 WebSocket 协议规范第 7 节中定义的关闭握手。
CreateClientBuffer(Int32, Int32)	创建用于此 WebSocket 实例的客户端缓冲区。
CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)	此 API 支持产品基础结构，不能在代码中直接使用。 允许调用方创建客户端 WebSocket 类，此类为组帧目的将使用 WSPC。
CreateFromStream(Stream, Boolean, String, TimeSpan)	创建在指定流上操作的新 WebSocket 对象，它表示一个 Web 套接字连接。
CreateFromStream(Stream, WebSocketCreationOptions)	创建对 WebSocket 表示 Web 套接字连接的 进行操作 Stream 的 。
CreateServerBuffer(Int32)	创建 WebSocket 服务器缓冲区。
Dispose()	用于清理 ASP.NET 和自承载实现的非托管资源。
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsApplicationTargeting45()	已过时. 返回一个值，该值指示 WebSocket 实例是否面向 .NET Framework 4.5。
IsStateTerminal(WebSocketState)	返回指示 WebSocket 实例的状态是“已关闭”还是“已中止”的值。
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	从 WebSocket 连接异步接收数据。
ReceiveAsync(Memory<Byte>, CancellationToken)	从 WebSocket 连接异步接收数据。
RegisterPrefixes()	此 API 支持产品基础结构，不能在代码中直接使用。 已过时. 允许调用方注册 WebSocket 请求的前缀（ws 和 wss）。
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	通过 WebSocket 连接异步发送数据。
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	通过 WebSocket 连接异步发送数据。
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	通过 WebSocket 连接异步发送数据。
ThrowOnInvalidState(WebSocketState, WebSocketState[])	验证连接是否处于预期状态。
ToString()	返回表示当前对象的字符串。 (继承自 Object)