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ů jsou podporovány v System.Net.WebSockets systémech 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 klientských a serverových websocketů. Prvky třídy v oboru názvů, které jsou podporovány v System.Net.WebSockets systémech 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 WebSocket.

U každého ClientWebSocket objektu je paralelně podporováno právě jedno odeslání a jeden příjem. Vydávání více odeslání nebo více přijetí 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 je předchozí operace očekávána (nebo dokončena). Měli byste serializovat přístup prostřednictvím jakéhokoli mechanismu, který je pro vás nejvhodnější, 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č close handshake byl zahájen na ClientWebSocket instanci.
CloseStatusDescription	Získá popis důvodu, proč ClientWebSocket byla instance uzavřena.
HttpResponseHeaders	Získá (pokud CollectHttpResponseDetails je nastaven) nebo nastaví hlavičky odpovědi na upgrade.
HttpStatusCode	Získá stavový kód odpovědi na upgrade, pokud CollectHttpResponseDetails je nastaven.
Options	Získá WebSocket možnosti pro ClientWebSocket instanci.
State	Získá WebSocket stav ClientWebSocket instance.
SubProtocol	Získá podporovaný 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)	Zavřete ClientWebSocket 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čí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí hashovací funkce. (Zděděno od Object)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Přijímá data v ClientWebSocket jako asynchronní operace.
ReceiveAsync(Memory<Byte>, CancellationToken)	Přijímá data v 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 bajtové paměti jen pro čtení jako asynchronní operace.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	Odesílá data ClientWebSocket z rozsahu bajtové paměti jen pro čtení jako asynchronní operace.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)