WebSocket Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Класс WebSocket позволяет приложениям отправлять и получать данные после завершения обновления WebSocket.
public ref class WebSocket abstract : IDisposablepublic abstract class WebSocket : IDisposabletype WebSocket = class
interface IDisposablePublic MustInherit Class WebSocket
Implements IDisposable- Наследование
-
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.
В каждом WebSocket объекте параллельно поддерживается ровно одна отправка и один прием. Выдача нескольких отправлений или нескольких приемов одновременно (например, без ожидания или из нескольких потоков без синхронизации) не поддерживается и приведет к неопределенному поведению. Прежде чем выпустить следующую операцию, убедитесь, что предыдущая операция ожидается (или завершена). Сериализуйте доступ с помощью любого механизма, например, с помощью блокировки или семафора.
Конструкторы
| Имя | Описание |
|---|---|
| WebSocket() |
Создает экземпляр класса WebSocket. |
Свойства
| Имя | Описание |
|---|---|
| CloseStatus |
Указывает причину, по которой удаленная конечная точка инициировала подтверждение закрытия. |
| CloseStatusDescription |
Позволяет удаленной конечной точке описать причину закрытия подключения. |
| DefaultKeepAliveInterval |
Возвращает интервал сохранения активности протокола WebSocket по умолчанию. |
| State |
Возвращает текущее состояние подключения WebSocket. |
| SubProtocol |
Возвращает подпротокол, который был согласован во время открытия подтверждения. |
Методы
| Имя | Описание |
|---|---|
| Abort() |
Прерывает подключение WebSocket и отменяет все ожидающие операции ввода-вывода. |
| CloseAsync(WebSocketCloseStatus, String, CancellationToken) |
Закрывает подключение WebSocket как асинхронную операцию с помощью близкого подтверждения, определенного в спецификации протокола WebSocket, раздела 7. |
| CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) |
Инициирует или завершает подтверждение закрытия, определенное в спецификации протокола WebSocket, раздел 7. |
| CreateClientBuffer(Int32, Int32) |
Создайте буферы клиента для использования с этим WebSocket экземпляром. |
| CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>) |
Этот API поддерживает инфраструктуру продукта и не предназначен для использования непосредственно из программного кода. Позволяет вызывающим пользователям создавать клиентский класс WebSocket, который будет использовать WSPC для обрамления. |
| CreateFromStream(Stream, Boolean, String, TimeSpan) |
Создает новый WebSocket объект, который работает с указанным потоком, который представляет подключение веб-сокета. |
| CreateServerBuffer(Int32) |
Создает буфер сервера WebSocket. |
| Dispose() |
Используется для очистки неуправляемых ресурсов для ASP.NET и локальных реализаций. |
| Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
| GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| IsApplicationTargeting45() |
Устаревшие..
Устаревшие..
Возвращает значение, указывающее, предназначен ли экземпляр WebSocket .NET Framework 4.5. |
| IsStateTerminal(WebSocketState) |
Возвращает значение, указывающее, закрыт ли или прервано состояние экземпляра WebSocket. |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| ReceiveAsync(ArraySegment<Byte>, CancellationToken) |
Получает данные из WebSocket подключения асинхронно. |
| ReceiveAsync(Memory<Byte>, CancellationToken) |
Получает данные из WebSocket подключения асинхронно. |
| RegisterPrefixes() |
Этот API поддерживает инфраструктуру продукта и не предназначен для использования непосредственно из программного кода. Позволяет вызывающим пользователям регистрировать префиксы для запросов WebSocket (ws и wss). |
| SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Отправляет данные по подключению WebSocket асинхронно. |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Отправляет данные по подключению WebSocket асинхронно. |
| ThrowOnInvalidState(WebSocketState, WebSocketState[]) |
Проверяет, находится ли подключение в ожидаемом состоянии. |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |