ClientWebSocket Класс

Определение

Пространство имен:

System.Net.WebSockets

Сборка:

System.Net.WebSockets.Client.dll

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

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

Комментарии

Некоторые классы и элементы класса в пространстве имен поддерживаются в System.Net.WebSockets Windows 7, Windows Vista с пакетом обновления 2 (SP2) и Windows Server 2008. Однако в Windows 8 и Windows Server 2012 поддерживаются только общедоступные реализации WebSocket клиента и сервера. Элементы класса в System.Net.WebSockets пространстве имен, поддерживаемые в Windows 7, Windows Vista с пакетом обновления 2 (SP2) и Windows Server 2008, являются абстрактными элементами класса. Это позволяет разработчику приложения наследовать и расширять эти абстрактные классы и элементы класса с помощью фактической реализации клиентских WebSocket.

Для каждого ClientWebSocket объекта поддерживается только одна отправка и одно получение в параллельном режиме. Выдача нескольких отправлений или получения одновременно (например, без ожидания или из нескольких потоков без синхронизации) не поддерживается и приводит к неопределенному поведению. Перед выполнением следующей операции убедитесь, что предыдущая операция ожидается (или завершена). Следует сериализовать доступ с помощью любого наиболее подходящего для вас механизма, например с помощью блокировки или семафора.

Конструкторы

ClientWebSocket()

Создает экземпляр класса ClientWebSocket.

Свойства

CloseStatus	Возвращает причину, по которой подтверждение закрытия было инициировано для экземпляра ClientWebSocket.
CloseStatusDescription	Возвращает описание причины, по которой экземпляр ClientWebSocket был закрыт.
HttpResponseHeaders	Возвращает (если CollectHttpResponseDetails задано) или задает заголовки ответа обновления.
HttpStatusCode	Возвращает код состояния ответа на обновление, если CollectHttpResponseDetails задано значение .
Options	Возвращает параметры WebSocket для экземпляра ClientWebSocket.
State	Получает состояние WebSocket экземпляра ClientWebSocket.
SubProtocol	Получает поддерживаемый подпротокол WebSocket для экземпляра ClientWebSocket.

Методы

Abort()	Прерывает подключение и отменяет все ожидающие операции ввода-вывода.
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)