WebSocket Klasa

Definicja

Przestrzeń nazw:

System.Net.WebSockets

Zestaw:

System.Net.WebSockets.dll

Źródło:

WebSocket.cs

Klasa WebSocket umożliwia aplikacjom wysyłanie i odbieranie danych po zakończeniu uaktualniania protokołu WebSocket.

public ref class WebSocket abstract : IDisposable

public abstract class WebSocket : IDisposable

type WebSocket = class
    interface IDisposable

Public MustInherit Class WebSocket
Implements IDisposable

Dziedziczenie

Object

WebSocket

Pochodne

System.Net.WebSockets.ClientWebSocket

System.Web.WebSockets.AspNetWebSocket

Implementuje

IDisposable

Uwagi

Niektóre klasy w przestrzeni nazw są obsługiwane w System.Net.WebSockets systemach Windows 7, Windows Vista z dodatkiem SP2 i Windows Server 2008. Jednak jedyne publiczne implementacje obiektów WebSocket klienta i serwera są obsługiwane w Windows 8 i Windows Server 2012. Klasy i elementy klas w przestrzeni nazw, które są obsługiwane w System.Net.WebSockets systemach Windows 7, Windows Vista z dodatkiem SP2 i Windows Server 2008 są klasy abstrakcyjne. Dzięki temu deweloper aplikacji może dziedziczyć i rozszerzać te klasy abstrakcyjne przy użyciu rzeczywistej implementacji obiektów WebSocket klienta.

Dokładnie jedno wysyłanie i jedno odbieranie jest obsługiwane równolegle dla każdego WebSocket obiektu. Wysyłanie wielu wysyłania lub wielokrotnego odbierania w tym samym czasie (na przykład bez oczekiwania lub z wielu wątków bez synchronizacji) nie jest obsługiwane i spowoduje niezdefiniowane zachowanie. Przed wydaniem następnej operacji upewnij się, że poprzednia operacja jest oczekiwana (lub zakończona). Serializowanie dostępu za pośrednictwem dowolnego mechanizmu działa najlepiej, na przykład za pomocą blokady lub semafora.

Konstruktory

WebSocket()

Tworzy wystąpienie klasy WebSocket.

Właściwości

CloseStatus	Wskazuje przyczynę zainicjowania uzgadniania przez zdalny punkt końcowy.
CloseStatusDescription	Umożliwia zdalnemu punktowi końcowemu opisanie przyczyny zamknięcia połączenia.
DefaultKeepAliveInterval	Pobiera domyślny interwał utrzymywania aktywności protokołu WebSocket.
State	Zwraca bieżący stan połączenia protokołu WebSocket.
SubProtocol	Pobiera podprotokcol, który został wynegocjowany podczas uzgadniania otwierającego.

Metody

Abort()	Przerywa połączenie protokołu WebSocket i anuluje wszystkie oczekujące operacje we/wy.
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	Zamyka połączenie protokołu WebSocket jako operację asynchroniczną przy użyciu uzgadniania zamknięcia zdefiniowanego w sekcji specyfikacji protokołu WebSocket 7.
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	Inicjuje lub kończy uzgadnianie zamknięcia zdefiniowane w sekcji specyfikacji protokołu WebSocket 7.
CreateClientBuffer(Int32, Int32)	Twórca bufory klienta do użycia z tym WebSocket wystąpieniem.
CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)	Ten interfejs API obsługuje infrastrukturę produktu i nie jest przeznaczony do użycia bezpośrednio z poziomu kodu. Umożliwia obiektom wywołującym utworzenie klasy WebSocket po stronie klienta, która będzie używać WSPC do celów tworzenia ramek.
CreateFromStream(Stream, Boolean, String, TimeSpan)	Tworzy nowy WebSocket obiekt, który działa na określonym strumieniu, który reprezentuje połączenie gniazda internetowego.
CreateFromStream(Stream, WebSocketCreationOptions)	Tworzy obiekt WebSocket , który działa na Stream reprezentującym połączenie gniazda internetowego.
CreateServerBuffer(Int32)	Tworzy bufor serwera WebSocket.
Dispose()	Służy do czyszczenia niezarządzanych zasobów na potrzeby implementacji ASP.NET i własnych.
Equals(Object)	Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetType()	Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object)
IsApplicationTargeting45()	Przestarzałe. Zwraca wartość wskazującą, czy wystąpienie protokołu WebSocket jest przeznaczone dla .NET Framework 4,5.
IsStateTerminal(WebSocketState)	Zwraca wartość wskazującą, czy stan wystąpienia protokołu WebSocket jest zamknięty, czy przerwany.
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Odbiera dane z WebSocket połączenia asynchronicznie.
ReceiveAsync(Memory<Byte>, CancellationToken)	Odbiera dane z WebSocket połączenia asynchronicznie.
RegisterPrefixes()	Ten interfejs API obsługuje infrastrukturę produktu i nie jest przeznaczony do użycia bezpośrednio z poziomu kodu. Przestarzałe. Umożliwia obiektom wywołującym rejestrowanie prefiksów dla żądań Protokołu WebSocket (ws i wss).
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Wysyła dane za pośrednictwem WebSocket połączenia asynchronicznie.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Wysyła dane za pośrednictwem WebSocket połączenia asynchronicznie.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	Wysyła dane za pośrednictwem WebSocket połączenia asynchronicznie.
ThrowOnInvalidState(WebSocketState, WebSocketState[])	Sprawdza, czy połączenie jest w oczekiwanym stanie.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)