WebSocket.CreateClientWebSocket Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Позволяет вызывающим объектам создать класс WebSocket на стороне клиента, который будет использовать WSPC для кадрирования.
Этот API поддерживает инфраструктуру продукта и не предназначен для использования непосредственно из программного кода.
public:
static System::Net::WebSockets::WebSocket ^ CreateClientWebSocket(System::IO::Stream ^ innerStream, System::String ^ subProtocol, int receiveBufferSize, int sendBufferSize, TimeSpan keepAliveInterval, bool useZeroMaskingKey, ArraySegment<System::Byte> internalBuffer);
public static System.Net.WebSockets.WebSocket CreateClientWebSocket (System.IO.Stream innerStream, string? subProtocol, int receiveBufferSize, int sendBufferSize, TimeSpan keepAliveInterval, bool useZeroMaskingKey, ArraySegment<byte> internalBuffer);
public static System.Net.WebSockets.WebSocket CreateClientWebSocket (System.IO.Stream innerStream, string subProtocol, int receiveBufferSize, int sendBufferSize, TimeSpan keepAliveInterval, bool useZeroMaskingKey, ArraySegment<byte> internalBuffer);
static member CreateClientWebSocket : System.IO.Stream * string * int * int * TimeSpan * bool * ArraySegment<byte> -> System.Net.WebSockets.WebSocket
Public Shared Function CreateClientWebSocket (innerStream As Stream, subProtocol As String, receiveBufferSize As Integer, sendBufferSize As Integer, keepAliveInterval As TimeSpan, useZeroMaskingKey As Boolean, internalBuffer As ArraySegment(Of Byte)) As WebSocket
Параметры
- innerStream
- Stream
Подключение, которое необходимо использовать операций ввода-вывода.
- subProtocol
- String
Подпротокол, принятый клиентом.
- receiveBufferSize
- Int32
Размер в байтах буфера получения WebSocket клиента.
- sendBufferSize
- Int32
Размер в байтах буфера передачи клиента WebSocket.
- keepAliveInterval
- TimeSpan
Определяет, как регулярно кадр передается через соединение для поддержание активности. Применяется только в том случае, если соединение бездействует.
- useZeroMaskingKey
- Boolean
Указывает, случайный ключ или статический ключ (нули) должен использоваться для маскирования WebSocket.
- internalBuffer
- ArraySegment<Byte>
Используется как внутренний буфер в WPC. Размер должен быть не менее 2 * ReceiveBufferSize + SendBufferSize + 256 + 20 (16 on 32-bit)
.
Возвращаемое значение
Возвращает WebSocket.