ClientWebSocket Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Fournit un client pour la connexion aux services 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
- Héritage
Remarques
Certaines classes et éléments de classe de l’espace System.Net.WebSockets de noms sont pris 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 é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 éléments de classe abstraits. Cela permet à un développeur d’applications d’hériter et d’étendre ces classes abstraites et ces éléments de classe avec une implémentation réelle des WebSockets clients.
Un seul envoi et une réception sont pris en charge sur chaque ClientWebSocket 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. Vous devez sérialiser 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
ClientWebSocket() |
Crée une instance de la classe ClientWebSocket. |
Propriétés
CloseStatus |
Obtient la cause de l’initiation du protocole de transfert de fermeture sur l’instance de ClientWebSocket. |
CloseStatusDescription |
Obtient une description de la cause de la fermeture de l’instance de ClientWebSocket. |
HttpResponseHeaders |
Obtient (si CollectHttpResponseDetails est défini) ou définit les en-têtes de réponse de mise à niveau. |
HttpStatusCode |
Obtient la réponse de mise à niveau status code si CollectHttpResponseDetails est défini. |
Options |
Obtient les options de WebSocket pour l’instance de ClientWebSocket. |
State |
Obtient l’état de WebSocket de l’instance ClientWebSocket. |
SubProtocol |
Obtient le sous-protocole WebSocket pris en charge pour l’instance de ClientWebSocket. |
Méthodes
Abort() |
Abandonne la connexion et annule les opérations d’E/S en attente. |
CloseAsync(WebSocketCloseStatus, String, CancellationToken) |
Ferme l’instance de ClientWebSocket en tant qu’opération asynchrone. |
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) |
Fermer la sortie de l’instance ClientWebSocket comme opération asynchrone. |
ConnectAsync(Uri, CancellationToken) |
Se connecte à un serveur WebSocket en tant qu’opération asynchrone. |
ConnectAsync(Uri, HttpMessageInvoker, CancellationToken) |
Se connecte à un serveur WebSocket en tant qu’opération asynchrone. |
Dispose() |
Libère les ressources non managées utilisées par l’instance ClientWebSocket. |
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) |
MemberwiseClone() |
Crée une copie superficielle du Object actuel. (Hérité de Object) |
ReceiveAsync(ArraySegment<Byte>, CancellationToken) |
Reçoit les données sur ClientWebSocket en tant qu’opération asynchrone. |
ReceiveAsync(Memory<Byte>, CancellationToken) |
Reçoit les données sur ClientWebSocket en tant qu’opération asynchrone. |
ReceiveAsync(Memory<Byte>, CancellationToken) |
Reçoit les données de façon asynchrone à partir de la connexion WebSocket. (Hérité de WebSocket) |
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Envoie des données sur ClientWebSocket en tant qu’opération asynchrone. |
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Envoie des données sur ClientWebSocket à partir d’une plage de mémoire d’octets en lecture seule en tant qu’opération asynchrone. |
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Envoie les données de façon asynchrone via la connexion WebSocket. (Hérité de WebSocket) |
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken) |
Envoie des données sur ClientWebSocket à partir d’une plage de mémoire d’octets en lecture seule en tant qu’opération asynchrone. |
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken) |
Envoie les données de façon asynchrone via la connexion WebSocket. (Hérité de WebSocket) |
ToString() |
Retourne une chaîne qui représente l'objet actuel. (Hérité de Object) |