WebSocket Třída

Definice

Obor názvů:

System.Net.WebSockets

Sestavení:

System.Net.WebSockets.dll

Zdroj:

WebSocket.cs

Třída WebSocket umožňuje aplikacím odesílat a přijímat data po dokončení upgradu WebSocket.

public ref class WebSocket abstract : IDisposable

public abstract class WebSocket : IDisposable

type WebSocket = class
    interface IDisposable

Public MustInherit Class WebSocket
Implements IDisposable

Dědičnost

Object

WebSocket

Odvozené

System.Net.WebSockets.ClientWebSocket

System.Web.WebSockets.AspNetWebSocket

Implementuje

IDisposable

Poznámky

Některé 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 sad WebSocket. Třídy a 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í třídy. To umožňuje vývojáři aplikací dědit a rozšířit tyto abstraktní třídy o skutečnou implementaci klientských websocketů.

U každého WebSocket objektu je paralelně podporováno přesně 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). Serializujte přístup pomocí libovolného mechanismu, který vám nejlépe vyhovuje, například pomocí zámku nebo semaforu.

Konstruktory

WebSocket()

Vytvoří instanci objektu WebSocket třídy.

Vlastnosti

CloseStatus	Označuje důvod, proč vzdálený koncový bod zahájil metodu handshake zblízka.
CloseStatusDescription	Umožňuje vzdálenému koncovému bodu popsat důvod ukončení připojení.
DefaultKeepAliveInterval	Získá výchozí protokol WebSocket zachování intervalu.
State	Vrátí aktuální stav připojení WebSocket.
SubProtocol	Získá podprotokol, který byl vyjednáván během otevření metody handshake.

Metody

Abort()	Přeruší připojení WebSocket a zruší všechny čekající vstupně-výstupní operace.
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	Zavře připojení WebSocket jako asynchronní operaci pomocí metody handshake definované v části 7 specifikace protokolu WebSocket .
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	Zahájí nebo dokončí metodu handshake definovanou v části 7 specifikace protokolu WebSocket.
CreateClientBuffer(Int32, Int32)	Create vyrovnávací paměti klienta pro použití s touto WebSocket instancí.
CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)	Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu. Umožňuje volajícím vytvořit třídu WebSocket na straně klienta, která bude používat WSPC pro účely rámování.
CreateFromStream(Stream, Boolean, String, TimeSpan)	Vytvoří nový WebSocket objekt, který pracuje se zadaným datovým proudem, který představuje připojení webového soketu.
CreateFromStream(Stream, WebSocketCreationOptions)	Vytvoří objekt WebSocket , který pracuje s Stream připojením představujícím připojení webového soketu.
CreateServerBuffer(Int32)	Vytvoří vyrovnávací paměť serveru WebSocket.
Dispose()	Slouží k vyčištění nespravovaných prostředků pro ASP.NET a implementace v místním prostředí.
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()	Získá aktuální Type instanci. (Zděděno od Object)
IsApplicationTargeting45()	Zastaralé. Vrátí hodnotu, která označuje, jestli instance WebSocket cílí na rozhraní .NET Framework 4.5.
IsStateTerminal(WebSocketState)	Vrátí hodnotu, která označuje, zda je stav instance WebSocket uzavřen nebo přerušen.
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Přijímá data z WebSocket připojení asynchronně.
ReceiveAsync(Memory<Byte>, CancellationToken)	Přijímá data z WebSocket připojení asynchronně.
RegisterPrefixes()	Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu. Zastaralé. Umožňuje volajícím registrovat předpony pro požadavky Protokolu WebSocket (ws a wss).
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Odesílá data přes připojení asynchronně WebSocket .
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Odesílá data přes připojení asynchronně WebSocket .
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	Odesílá data přes připojení asynchronně WebSocket .
ThrowOnInvalidState(WebSocketState, WebSocketState[])	Ověří, že připojení je v očekávaném stavu.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)