WebSocket Класс

Определение

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

System.Net.WebSockets

Сборка:

System.Net.WebSockets.dll

Сборка:

System.dll

Сборка:

netstandard.dll

Класс WebSocket позволяет приложениям отправлять и получать данные после завершения обновления WebSocket.

public ref class WebSocket abstract : IDisposable

public abstract class WebSocket : IDisposable

type WebSocket = class
    interface IDisposable

Public MustInherit Class WebSocket
Implements IDisposable

Наследование

Object

WebSocket

Производный

System.Net.WebSockets.ClientWebSocket

System.Web.WebSockets.AspNetWebSocket

Реализации

IDisposable

Комментарии

Некоторые классы в 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.

Свойства

CloseStatus	Указывает причину, по которой удаленная конечная точка инициировала подтверждение закрытия.
CloseStatusDescription	Позволяет удаленной конечной точке описать причину закрытия подключения.
DefaultKeepAliveInterval	Возвращает интервал проверки активности протокола WebSocket.
State	Возвращает текущее состояние соединения WebSocket.
SubProtocol	Возвращает подпротокол, который был согласован во время подтверждения открытия.

Методы

Abort()	Отменяет соединение WebSocket и отменяет все ожидающие операции ввода-вывода.
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	Закрывает подключение WebSocket в качестве асинхронной операции, используя подтверждение закрытия, которое определено в разделе 7 спецификации протокола WebSocket.
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, работающий в указанном потоке, который представляет подключение к веб-сокету.
CreateFromStream(Stream, WebSocketCreationOptions)	Создает объект WebSocket , который работает с Stream подключением веб-сокета.
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.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	Асинхронно отправляет данные по соединению WebSocket.
ThrowOnInvalidState(WebSocketState, WebSocketState[])	Проверяет, находится ли соединение в ожидаемом состоянии.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)