ClientWebSocket Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет клиент для подключения к службам WebSocket.
public ref class ClientWebSocket sealed : System::Net::WebSockets::WebSocketpublic sealed class ClientWebSocket : System.Net.WebSockets.WebSockettype ClientWebSocket = class
inherit WebSocketPublic NotInheritable Class ClientWebSocket
Inherits WebSocket- Наследование
Комментарии
Некоторые классы и элементы класса в пространстве имен System.Net.WebSockets поддерживаются в Windows 7, Windows Vista с пакетом обновления 2 (SP2) и Windows Server 2008. Однако в Windows 8 и Windows Server 2012 поддерживаются только общедоступные реализации клиента и сервера WebSockets. Элементы класса в пространстве имен System.Net.WebSockets, поддерживаемые в Windows 7, Windows Vista с пакетом обновления 2 (SP2) и Windows Server 2008, являются абстрактными элементами класса. Это позволяет разработчику приложений наследовать и расширять эти абстрактные классы и элементы класса с фактической реализацией клиентских WebSockets.
В каждом ClientWebSocket объекте параллельно поддерживается ровно одна отправка и один прием. Выдача нескольких отправлений или нескольких приемов одновременно (например, без ожидания или из нескольких потоков без синхронизации) не поддерживается и приведет к неопределенному поведению. Прежде чем выпустить следующую операцию, убедитесь, что предыдущая операция ожидается (или завершена). Необходимо сериализовать доступ с помощью любого механизма, например, с помощью блокировки или семафора.
Конструкторы
| Имя | Описание |
|---|---|
| ClientWebSocket() |
Создает экземпляр класса ClientWebSocket. |
Свойства
| Имя | Описание |
|---|---|
| CloseStatus |
Получает причину, из-за которой близкое подтверждение было инициировано на ClientWebSocket экземпляре. |
| CloseStatusDescription |
Возвращает описание причины закрытия экземпляра ClientWebSocket . |
| Options |
Возвращает параметры WebSocket для экземпляра ClientWebSocket . |
| State |
Возвращает состояние WebSocket экземпляра ClientWebSocket . |
| SubProtocol |
Возвращает поддерживаемый вложенный протокол WebSocket для экземпляра ClientWebSocket . |
Методы
| Имя | Описание |
|---|---|
| Abort() |
Прерывает подключение и отменяет все ожидающие операции ввода-вывода. |
| CloseAsync(WebSocketCloseStatus, String, CancellationToken) |
ClientWebSocket Закройте экземпляр как асинхронную операцию. |
| CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) |
Закройте выходные данные для ClientWebSocket экземпляра как асинхронную операцию. |
| ConnectAsync(Uri, 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 из диапазона памяти только для чтения в виде асинхронной операции. |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |