WebSocket Třída

Definice

Obor názvů:

System.Net.WebSockets

Sestavení:

netstandard.dll, 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ů 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. Třídy a prvky třídy v oboru názvů System.Net.WebSockets podporované v 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 klienta WebSockets.

Na každém WebSocket 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). Serializace přístupu prostřednictvím jakéhokoli mechanismu funguje nejlépe pro vás, například pomocí zámku nebo semaphore.

Konstruktory

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

Vlastnosti

Name	Description
CloseStatus	Označuje důvod, proč vzdálený koncový bod inicioval metodu handshake.
CloseStatusDescription	Umožňuje vzdálenému koncovému bodu popsat důvod ukončení připojení.
DefaultKeepAliveInterval	Získá výchozí interval protokolu WebSocket keep-alive.
State	Vrátí aktuální stav připojení WebSocket.
SubProtocol	Získá subprotocol, který byl vyjednána během otevírání handshake.

Metody

Name	Description
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é ve specifikaci protokolu WebSocket oddíl 7.
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	Zahájí nebo dokončí metodu handshake definovanou ve specifikaci protokolu WebSocket v části 7.
CreateClientBuffer(Int32, Int32)	Vytvořte 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ří WebSocket , která funguje na reprezentaci připojení k webovému Stream 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č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)
IsApplicationTargeting45()	Zastaralé. Vrátí hodnotu, která označuje, jestli instance WebSocket cílí na .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 Object. (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 WebSocket (ws a wss).
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Odesílá data přes WebSocket připojení asynchronně.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Odesílá data přes WebSocket připojení asynchronně.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	Odesílá data přes WebSocket připojení asynchronně.
ThrowOnInvalidState(WebSocketState, WebSocketState[])	Ověřuje, ž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)