ClientWebSocket Třída

Definice

Obor názvů:

System.Net.WebSockets

Sestavení:

netstandard.dll, System.Net.WebSockets.Client.dll

Zdroj:

ClientWebSocket.cs

Poskytuje klienta pro připojení ke službám WebSocket.

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

Dědičnost

Object

WebSocket

ClientWebSocket

Poznámky

Některé třídy a prvky třídy v oboru názvů System.Net.WebSockets jsou podporovány v Windows 7, Windows Vista SP2 a Windows Server 2008. Na Windows 8 a Windows Server 2012 jsou však podporovány pouze veřejné implementace klienta a serveru WebSocket. Elementy třídy v oboru názvů System.Net.WebSockets podporované v Windows 7, Windows Vista SP2 a Windows Server 2008 jsou abstraktní prvky třídy. To umožňuje vývojáři aplikace dědit a rozšířit tyto abstraktní třídy třídy a elementy třídy o skutečnou implementaci klienta WebSockets.

Na každém ClientWebSocket objektu je paralelně podporováno přesně jedno odeslání a jeden příjem. Vydávání více odesílaných nebo více příjmů najednou (například bez čekání nebo z více vláken bez synchronizace) není podporováno a bude mít za následek nedefinované chování. Před vydáním další operace se ujistěte, že předchozí operace čeká (nebo je dokončena). Přístup byste měli serializovat pomocí jakéhokoli mechanismu, který vám nejlépe vyhovuje, například pomocí zámku nebo semaforu.

Konstruktory

Name	Description
ClientWebSocket()	Vytvoří instanci objektu ClientWebSocket třídy.

Vlastnosti

Name	Description
CloseStatus	Získá důvod, proč byl u instance zahájen ClientWebSocket close handshake.
CloseStatusDescription	Získá popis důvodu, proč ClientWebSocket byla instance uzavřena.
HttpResponseHeaders	Získá (pokud CollectHttpResponseDetails je nastavena) nebo nastaví hlavičky odpovědi upgradu.
HttpStatusCode	Získá stavový kód odpovědi upgradu, pokud CollectHttpResponseDetails je nastaven.
Options	Získá možnosti WebSocket pro ClientWebSocket instanci.
State	Získá stav ClientWebSocket WebSocket instance.
SubProtocol	Získá podporovaný pod-protokol WebSocket pro ClientWebSocket instanci.

Metody

Name	Description
Abort()	Přeruší připojení a zruší všechny čekající vstupně-výstupní operace.
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	ClientWebSocket Zavřete instanci jako asynchronní operaci.
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	Zavřete výstup instance ClientWebSocket jako asynchronní operaci.
ConnectAsync(Uri, CancellationToken)	Připojí se k serveru WebSocket jako asynchronní operace.
ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)	Připojí se k serveru WebSocket jako asynchronní operace.
Dispose()	Uvolní nespravované prostředky používané ClientWebSocket instancí.
Equals(Object)	Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Přijímá data ClientWebSocket jako asynchronní operace.
ReceiveAsync(Memory<Byte>, CancellationToken)	Přijímá data ClientWebSocket jako asynchronní operace.
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Odesílá data ClientWebSocket jako asynchronní operace.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Odesílá data ClientWebSocket z rozsahu paměti jen pro čtení jako asynchronní operace.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	Odesílá data ClientWebSocket z rozsahu paměti jen pro čtení jako asynchronní operace.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)