WebSocket Classe

Définition

Espace de noms:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.dll

Source:

WebSocket.cs

La classe WebSocket permet aux applications d’envoyer et de recevoir des données une fois la mise à niveau WebSocket terminée.

public ref class WebSocket abstract : IDisposable

public abstract class WebSocket : IDisposable

type WebSocket = class
    interface IDisposable

Public MustInherit Class WebSocket
Implements IDisposable

Héritage

Object

WebSocket

Dérivé

System.Net.WebSockets.ClientWebSocket

System.Web.WebSockets.AspNetWebSocket

Implémente

IDisposable

Remarques

Certaines classes de l’espace System.Net.WebSockets de noms sont prises en charge sur Windows 7, Windows Vista SP2 et Windows Server 2008. Toutefois, les seules implémentations publiques des WebSockets client et serveur sont prises en charge sur Windows 8 et Windows Server 2012. Les classes et les éléments de classe dans l’espace System.Net.WebSockets de noms pris en charge sur Windows 7, Windows Vista SP2 et Windows Server 2008 sont des classes abstraites. Cela permet à un développeur d’applications d’hériter et d’étendre ces classes abstraites avec une implémentation réelle des WebSockets clients.

Un seul envoi et une réception sont pris en charge sur chaque WebSocket objet en parallèle. L’émission de plusieurs envois ou de plusieurs réceptions en même temps (par exemple, sans attendre ou à partir de plusieurs threads sans synchronisation) n’est pas prise en charge et entraîne un comportement non défini. Assurez-vous que l’opération précédente est attendue (ou terminée) avant d’émettre la suivante. Sérialisez l’accès via le mécanisme qui vous convient le mieux, par exemple à l’aide d’un verrou ou d’un sémaphore.

Constructeurs

WebSocket()

Crée une instance de la classe WebSocket.

Propriétés

CloseStatus	Indique la raison pour laquelle le point de terminaison distant a initié le protocole de transfert de fermeture.
CloseStatusDescription	Permet au point de terminaison distant de décrire la raison pour laquelle la connexion a été fermée.
DefaultKeepAliveInterval	Obtient l'intervalle par défaut pendant lequel maintenir l'activité du protocole WebSocket.
State	Retourne l’état actuel de la connexion WebSocket.
SubProtocol	Obtient le sous-protocole négocié pendant l’établissement de la liaison d’ouverture.

Méthodes

Abort()	Abandonne la connexion WebSocket et annule toutes les opérations d'E/S en attente.
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	Ferme la connexion de WebSocket en tant qu’opération asynchrone à l’aide du protocole de transfert de fermeture défini dans la section 7 de la spécification du protocole WebSocket.
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	Démarre ou termine le protocole de transfert de fermeture défini dans la section 7 de la spécification du protocole WebSocket.
CreateClientBuffer(Int32, Int32)	Crée les mémoires tampons du client pour l'utiliser avec cette instance WebSocket.
CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)	Cette API prend en charge l'infrastructure du produit et n'est pas destinée à être utilisée directement à partir de votre code. Permet aux appelants de créer une classe de WebSocket côté client qui utilisera le WSPC pour ce qui concerne les cadres.
CreateFromStream(Stream, Boolean, String, TimeSpan)	Crée un objet WebSocket qui opère sur le flux spécifié, qui représente une connexion de socket web.
CreateFromStream(Stream, WebSocketCreationOptions)	Crée un WebSocket qui fonctionne sur un Stream représentant une connexion de socket web.
CreateServerBuffer(Int32)	Crée une mémoire tampon WebSocket.
Dispose()	Permet de nettoyer les ressources non managées pour ASP.NET et les implémentations auto-hébergées.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsApplicationTargeting45()	Obsolète. Retourne une valeur qui indique si le instance WebSocket cible .NET Framework 4.5.
IsStateTerminal(WebSocketState)	Retourne une valeur qui indique si l'état de l'instance WebSocket est fermé ou abandonné.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Reçoit les données de façon asynchrone à partir de la connexion WebSocket.
ReceiveAsync(Memory<Byte>, CancellationToken)	Reçoit les données de façon asynchrone à partir de la connexion WebSocket.
RegisterPrefixes()	Cette API prend en charge l'infrastructure du produit et n'est pas destinée à être utilisée directement à partir de votre code. Obsolète. Autorise les appelants à enregistrer des préfixes pour les requêtes de WebSocket (WS et WSS).
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Envoie les données de façon asynchrone via la connexion WebSocket.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	Envoie les données de façon asynchrone via la connexion WebSocket.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	Envoie les données de façon asynchrone via la connexion WebSocket.
ThrowOnInvalidState(WebSocketState, WebSocketState[])	Vérifie que la connexion est dans un état attendu.
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)