WebSocket Klasse

Definition

Namespace:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.dll

Quelle:

WebSocket.cs

Die „WebSocket“-Klasse erlaubt Anwendungen das Senden und Empfangen von Daten nach Abschluss der WebSocket-Aktualisierung.

public ref class WebSocket abstract : IDisposable

public abstract class WebSocket : IDisposable

type WebSocket = class
    interface IDisposable

Public MustInherit Class WebSocket
Implements IDisposable

Vererbung

Object

WebSocket

Abgeleitet

System.Net.WebSockets.ClientWebSocket

System.Web.WebSockets.AspNetWebSocket

Implementiert

IDisposable

Hinweise

Einige Klassen im System.Net.WebSockets Namespace werden unter Windows 7, Windows Vista SP2 und Windows Server 2008 unterstützt. Die einzigen öffentlichen Implementierungen von Client- und Server-WebSockets werden jedoch auf Windows 8 und Windows Server 2012 unterstützt. Die Klassen und Klassenelemente im Namespace, die System.Net.WebSockets unter Windows 7, Windows Vista SP2 und Windows Server 2008 unterstützt werden, sind abstrakte Klassen. Dadurch kann ein Anwendungsentwickler diese abstrakten Klassen erben und mit einer tatsächlichen Implementierung von Client-WebSockets erweitern.

Genau ein Senden und ein Empfang wird für jedes WebSocket Objekt parallel unterstützt. Das Ausgeben mehrerer Senden oder empfangener Daten zur gleichen Zeit (z. B. ohne Warten oder aus mehreren Threads ohne Synchronisierung) wird nicht unterstützt und führt zu einem nicht definierten Verhalten. Stellen Sie sicher, dass der vorherige Vorgang erwartet (oder abgeschlossen) wird, bevor Sie den nächsten Vorgang ausstellen. Serialisieren Sie den Zugriff über den für Sie am besten geeigneten Mechanismus, z. B. mithilfe einer Sperre oder eines Semaphors.

Konstruktoren

WebSocket()

Erstellt eine Instanz der WebSocket-Klasse.

Eigenschaften

CloseStatus	Gibt den Grund an, warum der Remoteendpunkt den Schließen-Handshake ausgelöst hat.
CloseStatusDescription	Ermöglicht es dem Remoteendpunkt, den Grund für das Schließen der Verbindung anzugeben.
DefaultKeepAliveInterval	Ruft das standardmäßige Keep-Alive-Intervall des WebSocket-Protokolls ab.
State	Gibt den aktuellen Zustand der WebSocket-Verbindung zurück.
SubProtocol	Ruft das Unterprotokoll ab, das während des Handshakes beim Öffnen ausgehandelt wurde.

Methoden

Abort()	Bricht die WebSocket-Verbindung ab und bricht alle ausstehenden EA-Vorgänge ab.
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	Schließt die WebSocket-Verbindung unter Verwendung des in Abschnitt 7 der WebSocket-Protokollspezifikation definierten Schließen-Handshakes in einem asynchronen Vorgang.
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	Initiiert oder beendet den Schließen-Handshake gemäß der WebSocket-Protokollspezifikation, Abschnitt 7.
CreateClientBuffer(Int32, Int32)	Clientpuffer erstellen, um sie mit dieser WebSocket-Instanz zu verwenden.
CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)	Diese API unterstützt die Produktinfrastruktur und ist nicht für die direkte Verwendung aus Ihrem Code gedacht. Ermöglicht es Aufrufern, eine clientseitige WebSocket-Klasse zu erstellen, die das WSPC zu Gestaltungszwecken verwendet.
CreateFromStream(Stream, Boolean, String, TimeSpan)	Erstellt eine neue WebSocket-Klasse, die auf dem angegebenen Datenstrom arbeitet, der eine Websocketverbindung darstellt.
CreateFromStream(Stream, WebSocketCreationOptions)	Erstellt eine WebSocket , die eine Stream Websocketverbindung darstellt.
CreateServerBuffer(Int32)	Erstellt einen WebSocket-Serverpuffer.
Dispose()	Wird verwendet, um nicht verwaltete Ressourcen für ASP.NET und selbst gehostete Implementierungen zu bereinigen.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsApplicationTargeting45()	Veraltet. Gibt einen Wert zurück, der angibt, ob der WebSocket-instance auf .NET Framework 4.5 ausgerichtet ist.
IsStateTerminal(WebSocketState)	Gibt einen Wert zurück, der angibt, wenn der Zustand der WebSocket-Instanz "Closed" oder "Aborted" ist.
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Empfängt Daten asynchron von der WebSocket-Verbindung.
ReceiveAsync(Memory<Byte>, CancellationToken)	Empfängt Daten asynchron von der WebSocket-Verbindung.
RegisterPrefixes()	Diese API unterstützt die Produktinfrastruktur und ist nicht für die direkte Verwendung aus Ihrem Code gedacht. Veraltet. Lässt zu, dass Aufrufer Präfixe für WebSocket-Anforderungen (ws und wss) registrieren.
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Sendet Daten asynchron über die WebSocket-Verbindung
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Sendet Daten asynchron über die WebSocket-Verbindung
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	Sendet Daten asynchron über die WebSocket-Verbindung
ThrowOnInvalidState(WebSocketState, WebSocketState[])	Überprüft, ob sich die Verbindung in einem erwarteten Zustand befindet.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)