WebSocket Klasse

Definition

Namespace:

System.Net.WebSockets

Assemblys:

netstandard.dll, System.Net.WebSockets.dll

Quelle:

WebSocket.cs

Mit der WebSocket-Klasse können Anwendungen Daten senden und empfangen, nachdem das WebSocket-Upgrade abgeschlossen wurde.

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 der Klassen im namespace System.Net.WebSockets werden für Windows 7, Windows Vista SP2 und Windows Server 2008 unterstützt. Die einzigen öffentlichen Implementierungen von Client- und ServerwebSockets werden jedoch für Windows 8 und Windows Server 2012 unterstützt. Die Klassen und Klassenelemente im namespace System.Net.WebSockets, die für Windows 7, Windows Vista SP2 und Windows Server 2008 unterstützt werden, sind abstrakte Klassen. Auf diese Weise kann ein Anwendungsentwickler diese abstrakten Klassen mit einer tatsächlichen Implementierung von ClientwebSockets erben und erweitern.

Genau ein Sende- und ein Empfang wird für jedes WebSocket Objekt parallel unterstützt. Das Gleichzeitige Ausgeben mehrerer Sendevorgänge oder mehrerer Empfänger (z. B. ohne Warten oder von mehreren Threads ohne Synchronisierung) wird nicht unterstützt und führt zu einem nicht definierten Verhalten. Stellen Sie sicher, dass der vorherige Vorgang vor dem Ausgeben des nächsten Vorgangs erwartet (oder abgeschlossen) wird. Serialisieren Sie den Zugriff über jeden Mechanismus, der für Sie am besten geeignet ist, z. B. mithilfe einer Sperre oder eines Semaphors.

Konstruktoren

Name	Beschreibung
WebSocket()	Erstellt eine Instanz der WebSocket-Klasse.

Eigenschaften

Name	Beschreibung
CloseStatus	Gibt den Grund an, warum der Remoteendpunkt den schließende Handshake initiiert hat.
CloseStatusDescription	Ermöglicht dem Remoteendpunkt zu beschreiben, warum die Verbindung geschlossen wurde.
DefaultKeepAliveInterval	Ruft das standardmäßige WebSocket-Protokoll-Keep-Alive-Intervall ab.
State	Gibt den aktuellen Status der WebSocket-Verbindung zurück.
SubProtocol	Ruft das Unterprotocol ab, das während des Öffnens handshake ausgehandelt wurde.

Methoden

Name	Beschreibung
Abort()	Hebt die WebSocket-Verbindung ab und bricht alle ausstehenden E/A-Vorgänge ab.
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	Schließt die WebSocket-Verbindung als asynchronen Vorgang mithilfe des in der WebSocket-Protokollspezifikation definierten Schließen-Handshakes, Abschnitt 7.
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	Initiiert oder schließt den schließende Handshake ab, der in der WebSocket-Protokollspezifikation, Abschnitt 7, definiert ist.
CreateClientBuffer(Int32, Int32)	Erstellen Sie Clientpuffer, die für diese WebSocket Instanz verwendet werden sollen.
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 Aufrufern das Erstellen einer clientseitigen WebSocket-Klasse, die den WSPC für Rahmenzwecke verwendet.
CreateFromStream(Stream, Boolean, String, TimeSpan)	Erstellt ein neues WebSocket Objekt, das für den angegebenen Datenstrom ausgeführt wird, der eine Websocketverbindung darstellt.
CreateFromStream(Stream, WebSocketCreationOptions)	Erstellt eine WebSocket , die für eine Stream Websocketverbindung ausgeführt wird.
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 dem aktuellen Objekt entspricht. (Geerbt von Object)
GetHashCode()	Dient als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
IsApplicationTargeting45()	Veraltet. Gibt einen Wert zurück, der angibt, ob die WebSocket-Instanz auf .NET Framework 4.5 ausgerichtet ist.
IsStateTerminal(WebSocketState)	Gibt einen Wert zurück, der angibt, ob der Zustand der WebSocket-Instanz geschlossen oder abgebrochen wird.
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Empfängt Daten aus der WebSocket Verbindung asynchron.
ReceiveAsync(Memory<Byte>, CancellationToken)	Empfängt Daten aus der WebSocket Verbindung asynchron.
RegisterPrefixes()	Diese API unterstützt die Produktinfrastruktur und ist nicht für die direkte Verwendung aus Ihrem Code gedacht. Veraltet. Ermöglicht Aufrufern das Registrieren von Präfixen für WebSocket-Anforderungen (ws und wss).
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Sendet Daten über die WebSocket Verbindung asynchron.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Sendet Daten über die WebSocket Verbindung asynchron.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	Sendet Daten über die WebSocket Verbindung asynchron.
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)