WebSocket WebSocket WebSocket WebSocket Class

Definition

Die „WebSocket“-Klasse erlaubt Anwendungen das Senden und Empfangen von Daten nach Abschluss der WebSocket-Aktualisierung.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
Vererbung
WebSocketWebSocketWebSocketWebSocket
Abgeleitet
Implementiert

Hinweise

Einige der Klassen in der System.Net.WebSockets Namespace werden in Windows 7, Windows Vista SP2 und Windows Server 2008 unterstützt.Some of the classes in the System.Net.WebSockets namespace are supported on Windows 7, Windows Vista SP2, and Windows Server 2008. Allerdings sind die einzige öffentlichen Implementierungen der Client- und WebSockets unter Windows 8 und Windows Server 2012 unterstützt.However, the only public implementations of client and server WebSockets are supported on Windows 8 and Windows Server 2012. Die Klassen und die Klassenelemente in der System.Net.WebSockets sind abstrakte Klassen, Namespaces, die auf Windows 7, Windows Vista SP2 und Windows Server 2008 unterstützt werden.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. Dadurch wird ein Anwendungsentwickler erben, und erweitern diese abstrakten Klassen mit einer echten Implementierung des WebSockets-Clients.This allows an application developer to inherit and extend these abstract classes with an actual implementation of client WebSockets.

Konstruktoren

WebSocket() WebSocket() WebSocket() WebSocket()

Erstellt eine Instanz der WebSocket-Klasse.Creates an instance of the WebSocket class.

Eigenschaften

CloseStatus CloseStatus CloseStatus CloseStatus

Gibt den Grund an, warum der Remoteendpunkt den Schließen-Handshake ausgelöst hat.Indicates the reason why the remote endpoint initiated the close handshake.

CloseStatusDescription CloseStatusDescription CloseStatusDescription CloseStatusDescription

Ermöglicht es dem Remoteendpunkt, den Grund für das Schließen der Verbindung anzugeben.Allows the remote endpoint to describe the reason why the connection was closed.

DefaultKeepAliveInterval DefaultKeepAliveInterval DefaultKeepAliveInterval DefaultKeepAliveInterval

Ruft das standardmäßige Keep-Alive-Intervall des WebSocket-Protokolls ab.Gets the default WebSocket protocol keep-alive interval.

State State State State

Gibt den aktuellen Zustand der WebSocket-Verbindung zurück.Returns the current state of the WebSocket connection.

SubProtocol SubProtocol SubProtocol SubProtocol

Ruft das Unterprotokoll ab, das während des Handshakes beim Öffnen ausgehandelt wurde.Gets the subprotocol that was negotiated during the opening handshake.

Methoden

Abort() Abort() Abort() Abort()

Unterbricht die WebSocket-Verbindung und bricht alle ausstehenden E/A-Vorgänge ab.Aborts the WebSocket connection and cancels any pending IO operations.

CloseAsync(WebSocketCloseStatus, String, CancellationToken) CloseAsync(WebSocketCloseStatus, String, CancellationToken) CloseAsync(WebSocketCloseStatus, String, CancellationToken) 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.Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the WebSocket protocol specification section 7.

CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)

Initiiert oder beendet den Schließen-Handshake gemäß der WebSocket-Protokollspezifikation, Abschnitt 7.Initiates or completes the close handshake defined in the WebSocket protocol specification section 7.

CreateClientBuffer(Int32, Int32) CreateClientBuffer(Int32, Int32) CreateClientBuffer(Int32, Int32) CreateClientBuffer(Int32, Int32)

Clientpuffer erstellen, um mit diesem verwenden WebSocket Instanz.Create client buffers to use with this WebSocket instance.

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

Ermöglicht es dem Aufrufer eine clientseitige WebSocket-Klasse erstellen, die das WSPC zu gestaltungszwecken verwendet wird.Allows callers to create a client side WebSocket class which will use the WSPC for framing purposes.

CreateFromStream(Stream, Boolean, String, TimeSpan) CreateFromStream(Stream, Boolean, String, TimeSpan) CreateFromStream(Stream, Boolean, String, TimeSpan) CreateFromStream(Stream, Boolean, String, TimeSpan)

Erstellt ein neues WebSocket -Objekt, das für den angegebenen Stream und steht für eine Web-Socket-Verbindung, ausgeführt wird.Creates a new WebSocket object that operates on the specified stream, which represents a web socket connection.

CreateServerBuffer(Int32) CreateServerBuffer(Int32) CreateServerBuffer(Int32) CreateServerBuffer(Int32)

Erstellt eine WebSocket-Serverpuffer.Creates a WebSocket server buffer.

Dispose() Dispose() Dispose() Dispose()

Wird verwendet, um nicht verwaltete Ressourcen für ASP.NET und selbst gehostete Implementierungen zu bereinigen.Used to clean up unmanaged resources for ASP.NET and self-hosted implementations.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsApplicationTargeting45() IsApplicationTargeting45() IsApplicationTargeting45() IsApplicationTargeting45()

Gibt einen Wert, der angibt, wenn die WebSocket-Instanz ausgerichtet ist .NET Framework 4.5.NET Framework 4.5.Returns a value that indicates if the WebSocket instance is targeting .NET Framework 4.5.NET Framework 4.5.

IsStateTerminal(WebSocketState) IsStateTerminal(WebSocketState) IsStateTerminal(WebSocketState) IsStateTerminal(WebSocketState)

Gibt einen Wert, der angibt, ob der Zustand der WebSocket-Instanz geschlossen oder abgebrochen wird.Returns a value that indicates if the state of the WebSocket instance is closed or aborted.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken) ReceiveAsync(ArraySegment<Byte>, CancellationToken) ReceiveAsync(ArraySegment<Byte>, CancellationToken) ReceiveAsync(ArraySegment<Byte>, CancellationToken)

Empfängt Daten asynchron von der WebSocket-Verbindung.Receives data from the WebSocket connection asynchronously.

ReceiveAsync(Memory<Byte>, CancellationToken) ReceiveAsync(Memory<Byte>, CancellationToken) ReceiveAsync(Memory<Byte>, CancellationToken) ReceiveAsync(Memory<Byte>, CancellationToken)
RegisterPrefixes() RegisterPrefixes() RegisterPrefixes() RegisterPrefixes()

Ermöglicht es dem Aufrufer Präfixe für WebSocket-Anforderungen (ws und Wss) zu registrieren.Allows callers to register prefixes for WebSocket requests (ws and wss).

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

Sendet Daten asynchron über die WebSocket-VerbindungSends data over the WebSocket connection asynchronously.

SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)
ThrowOnInvalidState(WebSocketState, WebSocketState[]) ThrowOnInvalidState(WebSocketState, WebSocketState[]) ThrowOnInvalidState(WebSocketState, WebSocketState[]) ThrowOnInvalidState(WebSocketState, WebSocketState[])

Überprüft, ob die Verbindung in einem erwarteten Zustand.Verifies that the connection is in an expected state.

ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Gilt für: