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)

Исходный код:

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.

Комментарии

Эта операция не блокируется. Возвращенный Task<TResult> объект завершится после принятия подключения WebSocket.

Размер буфера приема составляет 16 385 байт. Интервал поддержания активности WebSocket имеет значение по умолчанию 30 000 (30 секунд).

См. также раздел

• HttpListenerWebSocketContext

AcceptWebSocketAsync(String, TimeSpan)

Исходный код:

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.

Комментарии

Эта операция не блокируется. Возвращенный Task<TResult> объект завершится после принятия подключения WebSocket.

Размер буфера приема составляет 16 385 байт.

См. также раздел

• HttpListenerWebSocketContext

AcceptWebSocketAsync(String, Int32, TimeSpan)

Исходный код:

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 больше 64К байт.

WebSocketException

Произошла ошибка при отправке ответа для завершения установки соединения WebSocket.

Комментарии

Эта операция не блокируется. Возвращенный Task<TResult>> объект завершится после принятия подключения WebSocket.

См. также раздел

• HttpListenerWebSocketContext

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

Исходный код:

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 больше 64К байт.

WebSocketException

Произошла ошибка при отправке ответа для завершения установки соединения WebSocket.

Комментарии

Эта операция не блокируется. Возвращенный Task<TResult> объект завершится после принятия подключения WebSocket.

См. также раздел

• HttpListenerWebSocketContext