HttpListenerContext.AcceptWebSocketAsync 方法

定义

命名空间:

System.Net

程序集:

System.Net.HttpListener.dll

接受 WebSocket 连接以作为异步操作。

重载

AcceptWebSocketAsync(String)	接受 WebSocket 连接以作为异步操作。
AcceptWebSocketAsync(String, TimeSpan)	接受 WebSocket 连接，将支持的 WebSocket 子协议和 WebSocket 保持连接间隔指定为异步操作。
AcceptWebSocketAsync(String, Int32, TimeSpan)	接受指定支持的 WebSocket 子协议的 WebSocket 连接、接受缓冲区大小和 WebSocket 保持活动状态的间隔以作为异步操作。
AcceptWebSocketAsync(String, Int32, TimeSpan, ArraySegment<Byte>)	接受指定支持的 WebSocket 子协议的 WebSocket 连接、接受缓冲区大小和 WebSocket 保持活动状态的间隔和内部缓冲区以作为异步操作。

AcceptWebSocketAsync(String)

Source:

HttpListenerContext.cs

接受 WebSocket 连接以作为异步操作。

public:
 System::Threading::Tasks::Task<System::Net::WebSockets::HttpListenerWebSocketContext ^> ^ AcceptWebSocketAsync(System::String ^ subProtocol);

public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string? subProtocol);

member this.AcceptWebSocketAsync : string -> System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext>

Public Function AcceptWebSocketAsync (subProtocol As String) As Task(Of HttpListenerWebSocketContext)

参数

subProtocol

String

支持的 WebSocket 子协议。

返回

Task<HttpListenerWebSocketContext>

表示异步操作的任务对象。 任务对象上的 Result 属性返回了 HttpListenerWebSocketContext 对象。

例外

ArgumentException

subProtocol 是空字符串

- 或 -

subProtocol 包含非法字符。

WebSocketException

发送响应以完成 WebSocket 握手时出错。

注解

此操作不会阻止。 接受 WebSocket 连接后，返回 Task<TResult> 的对象将完成。

接收缓冲区的大小为 16,385 字节。 WebSocket 保持连接间隔设置为默认值 30,000 (30 秒) 。

另请参阅

• HttpListenerWebSocketContext

AcceptWebSocketAsync(String, TimeSpan)

Source:

HttpListenerContext.cs

接受 WebSocket 连接，将支持的 WebSocket 子协议和 WebSocket 保持连接间隔指定为异步操作。

public:
 System::Threading::Tasks::Task<System::Net::WebSockets::HttpListenerWebSocketContext ^> ^ AcceptWebSocketAsync(System::String ^ subProtocol, TimeSpan keepAliveInterval);

public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string? subProtocol, TimeSpan keepAliveInterval);

member this.AcceptWebSocketAsync : string * TimeSpan -> System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext>

Public Function AcceptWebSocketAsync (subProtocol As String, keepAliveInterval As TimeSpan) As Task(Of HttpListenerWebSocketContext)

参数

subProtocol

String

支持的 WebSocket 子协议。

keepAliveInterval

TimeSpan

WebSocket 协议保持活动状态的间隔（以毫秒为单位）。

返回

Task<HttpListenerWebSocketContext>

表示异步操作的任务对象。 任务对象上的 Result 属性返回了 HttpListenerWebSocketContext 对象。

例外

ArgumentException

subProtocol 是空字符串

- 或 -

subProtocol 包含非法字符。

ArgumentOutOfRangeException

keepAliveInterval 太小。

WebSocketException

发送响应以完成 WebSocket 握手时出错。

注解

此操作不会阻止。 接受 WebSocket 连接后，返回 Task<TResult> 的对象将完成。

接收缓冲区的大小为 16,385 字节。

另请参阅

• HttpListenerWebSocketContext

AcceptWebSocketAsync(String, Int32, TimeSpan)

Source:

HttpListenerContext.Managed.cs

接受指定支持的 WebSocket 子协议的 WebSocket 连接、接受缓冲区大小和 WebSocket 保持活动状态的间隔以作为异步操作。

public:
 System::Threading::Tasks::Task<System::Net::WebSockets::HttpListenerWebSocketContext ^> ^ AcceptWebSocketAsync(System::String ^ subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval);

public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string? subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval);

member this.AcceptWebSocketAsync : string * int * TimeSpan -> System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext>

Public Function AcceptWebSocketAsync (subProtocol As String, receiveBufferSize As Integer, keepAliveInterval As TimeSpan) As Task(Of HttpListenerWebSocketContext)

参数

subProtocol

String

支持的 WebSocket 子协议。

receiveBufferSize

Int32

接收缓冲区大小（以字节为单位）。

keepAliveInterval

TimeSpan

WebSocket 协议保持活动状态的间隔（以毫秒为单位）。

返回

Task<HttpListenerWebSocketContext>

表示异步操作的任务对象。 任务对象上的 Result 属性返回了 HttpListenerWebSocketContext 对象。

例外

ArgumentException

subProtocol 是空字符串

- 或 -

subProtocol 包含非法字符。

ArgumentOutOfRangeException

keepAliveInterval 太小。

- 或 -

receiveBufferSize 小于 16 字节

- 或 -

receiveBufferSize 大于 64K 字节。

WebSocketException

发送响应以完成 WebSocket 握手时出错。

注解

此操作不会阻止。 接受 WebSocket 连接后，返回 Task<TResult>> 的对象将完成。

另请参阅

• HttpListenerWebSocketContext

AcceptWebSocketAsync(String, Int32, TimeSpan, ArraySegment<Byte>)

Source:

HttpListenerContext.Managed.cs

接受指定支持的 WebSocket 子协议的 WebSocket 连接、接受缓冲区大小和 WebSocket 保持活动状态的间隔和内部缓冲区以作为异步操作。

public:
 System::Threading::Tasks::Task<System::Net::WebSockets::HttpListenerWebSocketContext ^> ^ AcceptWebSocketAsync(System::String ^ subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, ArraySegment<System::Byte> internalBuffer);

public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string? subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, ArraySegment<byte> internalBuffer);

member this.AcceptWebSocketAsync : string * int * TimeSpan * ArraySegment<byte> -> System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext>

Public Function AcceptWebSocketAsync (subProtocol As String, receiveBufferSize As Integer, keepAliveInterval As TimeSpan, internalBuffer As ArraySegment(Of Byte)) As Task(Of HttpListenerWebSocketContext)

参数

subProtocol

String

支持的 WebSocket 子协议。

receiveBufferSize

Int32

接收缓冲区大小（以字节为单位）。

keepAliveInterval

TimeSpan

WebSocket 协议保持活动状态的间隔（以毫秒为单位）。

internalBuffer

ArraySegment<Byte>

用于此操作的一个内部缓冲区。

返回

Task<HttpListenerWebSocketContext>

表示异步操作的任务对象。 任务对象上的 Result 属性返回了 HttpListenerWebSocketContext 对象。

例外

ArgumentException

subProtocol 是空字符串

- 或 -

subProtocol 包含非法字符。

ArgumentOutOfRangeException

keepAliveInterval 太小。

- 或 -

receiveBufferSize 小于 16 字节

- 或 -

receiveBufferSize 大于 64K 字节。

WebSocketException

发送响应以完成 WebSocket 握手时出错。

注解

此操作不会阻止。 接受 WebSocket 连接后，返回 Task<TResult> 的对象将完成。

另请参阅

• HttpListenerWebSocketContext