ClientWebSocket Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt einen Client zum Herstellen einer Verbindung mit WebSocket-Diensten bereit.
public ref class ClientWebSocket sealed : System::Net::WebSockets::WebSocket
public sealed class ClientWebSocket : System.Net.WebSockets.WebSocket
type ClientWebSocket = class
inherit WebSocket
Public NotInheritable Class ClientWebSocket
Inherits WebSocket
- Vererbung
Hinweise
Einige der Klassen und Klassenelemente 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 Klassenelemente im namespace System.Net.WebSockets, die für Windows 7, Windows Vista SP2 und Windows Server 2008 unterstützt werden, sind abstrakte Klassenelemente. Auf diese Weise kann ein Anwendungsentwickler diese abstrakten Klassen und Klassenelemente mit einer tatsächlichen Implementierung von ClientwebSockets erben und erweitern.
Genau ein Sende- und ein Empfang wird für jedes ClientWebSocket 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. Sie sollten den Zugriff über jeden Mechanismus serialisieren, der für Sie am besten geeignet ist, z. B. mithilfe einer Sperre oder eines Semaphors.
Konstruktoren
| Name | Beschreibung |
|---|---|
| ClientWebSocket() |
Erstellt eine Instanz der ClientWebSocket-Klasse. |
Eigenschaften
| Name | Beschreibung |
|---|---|
| CloseStatus |
Ruft den Grund ab, warum der schließende Handshake für ClientWebSocket die Instanz initiiert wurde. |
| CloseStatusDescription |
Ruft eine Beschreibung des Grunds ab, warum die ClientWebSocket Instanz geschlossen wurde. |
| HttpResponseHeaders |
Ruft (falls CollectHttpResponseDetails festgelegt) ab oder legt die Upgradeantwortheader fest. |
| HttpStatusCode |
Ruft den Upgradeantwortstatuscode ab, wenn CollectHttpResponseDetails dieser festgelegt ist. |
| Options |
Ruft die WebSocket-Optionen für die ClientWebSocket Instanz ab. |
| State |
Ruft den WebSocket-Status der ClientWebSocket Instanz ab. |
| SubProtocol |
Ruft das unterstützte WebSocket-Unterprotokoll für die ClientWebSocket Instanz ab. |
Methoden
| Name | Beschreibung |
|---|---|
| Abort() |
Bricht die Verbindung ab und bricht alle ausstehenden E/A-Vorgänge ab. |
| CloseAsync(WebSocketCloseStatus, String, CancellationToken) |
Schließen Sie die ClientWebSocket Instanz als asynchronen Vorgang. |
| CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) |
Schließen Sie die Ausgabe für die ClientWebSocket Instanz als asynchronen Vorgang. |
| ConnectAsync(Uri, CancellationToken) |
Stellt eine Verbindung mit einem WebSocket-Server als asynchronen Vorgang dar. |
| ConnectAsync(Uri, HttpMessageInvoker, CancellationToken) |
Stellt eine Verbindung mit einem WebSocket-Server als asynchronen Vorgang dar. |
| Dispose() |
Gibt die nicht verwalteten Ressourcen frei, die von der ClientWebSocket Instanz verwendet werden. |
| 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) |
| MemberwiseClone() |
Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object) |
| ReceiveAsync(ArraySegment<Byte>, CancellationToken) |
Empfängt Daten ClientWebSocket als asynchronen Vorgang. |
| ReceiveAsync(Memory<Byte>, CancellationToken) |
Empfängt Daten ClientWebSocket als asynchronen Vorgang. |
| ReceiveAsync(Memory<Byte>, CancellationToken) |
Empfängt Daten aus der WebSocket Verbindung asynchron. (Geerbt von WebSocket) |
| SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Sendet Daten ClientWebSocket als asynchronen Vorgang. |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Sendet Daten ClientWebSocket aus einem schreibgeschützten Bytespeicherbereich als asynchronen Vorgang. |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Sendet Daten über die WebSocket Verbindung asynchron. (Geerbt von WebSocket) |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken) |
Sendet Daten ClientWebSocket aus einem schreibgeschützten Bytespeicherbereich als asynchronen Vorgang. |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken) |
Sendet Daten über die WebSocket Verbindung asynchron. (Geerbt von WebSocket) |
| ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object) |