WebSocket Класс

Определение

Класс WebSocket позволяет приложениям отправлять и получать данные после завершения обновления WebSocket.The WebSocket class allows applications to send and receive data after the WebSocket upgrade has completed.

public ref class WebSocket abstract : IDisposable
public abstract class WebSocket : IDisposable
type WebSocket = class
    interface IDisposable
Public MustInherit Class WebSocket
Implements IDisposable
Наследование
WebSocket
Производный
Реализации

Комментарии

Некоторые классы в System.Net.WebSockets пространстве имен поддерживаются в Windows 7, Windows Vista SP2 и Windows Server 2008.Some of the classes in the System.Net.WebSockets namespace are supported on Windows 7, Windows Vista SP2, and Windows Server 2008. Однако в Windows 8 и Windows Server 2012 поддерживаются только общедоступные реализации клиентских и серверных WebSocket.However, the only public implementations of client and server WebSockets are supported on Windows 8 and Windows Server 2012. Классы и элементы класса в System.Net.WebSockets пространстве имен, которые поддерживаются в Windows 7, Windows Vista SP2 и Windows Server 2008, являются абстрактными классами.The classes and class elements in the System.Net.WebSockets namespace that are supported on Windows 7, Windows Vista SP2, and Windows Server 2008 are abstract classes. Это позволяет разработчику приложения наследовать и расширять эти абстрактные классы с помощью фактической реализации клиентских WebSocket.This allows an application developer to inherit and extend these abstract classes with an actual implementation of client WebSockets.

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

WebSocket()

Создает экземпляр класса WebSocket.Creates an instance of the WebSocket class.

Свойства

CloseStatus

Указывает причину, по которой удаленная конечная точка инициировала подтверждение закрытия.Indicates the reason why the remote endpoint initiated the close handshake.

CloseStatusDescription

Позволяет удаленной конечной точке описать причину закрытия подключения.Allows the remote endpoint to describe the reason why the connection was closed.

DefaultKeepAliveInterval

Возвращает интервал проверки активности протокола WebSocket.Gets the default WebSocket protocol keep-alive interval.

State

Возвращает текущее состояние соединения WebSocket.Returns the current state of the WebSocket connection.

SubProtocol

Возвращает подпротокол, который был согласован во время подтверждения открытия.Gets the subprotocol that was negotiated during the opening handshake.

Методы

Abort()

Отменяет соединение WebSocket и отменяет все ожидающие операции ввода-вывода.Aborts the WebSocket connection and cancels any pending IO operations.

CloseAsync(WebSocketCloseStatus, String, CancellationToken)

Закрывает подключение WebSocket в качестве асинхронной операции, используя подтверждение закрытия, которое определено в разделе 7 спецификации протокола WebSocket.Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the WebSocket protocol specification section 7.

CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)

Инициирует или завершает подтверждение закрытия, определенное в разделе 7 спецификации протокола WebSocket.Initiates or completes the close handshake defined in the WebSocket protocol specification section 7.

CreateClientBuffer(Int32, Int32)

Создайте буферы клиента для использования с этим экземпляром WebSocket.Create client buffers to use with this WebSocket instance.

CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)

Этот API поддерживает инфраструктуру продукта и не предназначен для использования непосредственно из программного кода.

Позволяет вызывающим объектам создать класс WebSocket на стороне клиента, который будет использовать WSPC для кадрирования.Allows callers to create a client side WebSocket class which will use the WSPC for framing purposes.

CreateFromStream(Stream, Boolean, String, TimeSpan)

Создает новый WebSocket, работающий в указанном потоке, который представляет подключение к веб-сокету.Creates a new WebSocket object that operates on the specified stream, which represents a web socket connection.

CreateServerBuffer(Int32)

Создает буфер сервера WebSocket.Creates a WebSocket server buffer.

Dispose()

Используется для очистки неуправляемых ресурсов для ASP.NET и резидентных реализаций.Used to clean up unmanaged resources for ASP.NET and self-hosted implementations.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
IsApplicationTargeting45()
Является устаревшей.
Является устаревшей.
Является устаревшей.

Возвращает значение, указывающее, предназначен ли экземпляр WebSocket платформа .NET Framework 4,5.Returns a value that indicates if the WebSocket instance is targeting .NET Framework 4.5.

IsStateTerminal(WebSocketState)

Возвращает значение, указывающее, какое состояние экземпляра WebSocket - закрыто или прервано.Returns a value that indicates if the state of the WebSocket instance is closed or aborted.

MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)

Асинхронно получает данные через соединение WebSocket.Receives data from the WebSocket connection asynchronously.

ReceiveAsync(Memory<Byte>, CancellationToken)

Асинхронно получает данные через соединение WebSocket.Receives data from the WebSocket connection asynchronously.

RegisterPrefixes()

Этот API поддерживает инфраструктуру продукта и не предназначен для использования непосредственно из программного кода.

Разрешает вызывающим объектам регистрировать префиксы для запросов WebSocket (ws и wss).Allows callers to register prefixes for WebSocket requests (ws and wss).

SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)

Асинхронно отправляет данные по соединению WebSocket.Sends data over the WebSocket connection asynchronously.

SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)

Асинхронно отправляет данные по соединению WebSocket.Sends data over the WebSocket connection asynchronously.

ThrowOnInvalidState(WebSocketState, WebSocketState[])

Проверяет, находится ли соединение в ожидаемом состоянии.Verifies that the connection is in an expected state.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к