WebSocket 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.
La classe WebSocket permet aux applications d’envoyer et de recevoir des données une fois la mise à niveau de WebSocket terminée.
public ref class WebSocket abstract : IDisposablepublic abstract class WebSocket : IDisposabletype WebSocket = class
interface IDisposablePublic MustInherit Class WebSocket
Implements IDisposable- Héritage
-
WebSocket
- Dérivé
- Implémente
Remarques
Certaines des classes de l’espace de noms System.Net.WebSockets sont prises en charge sur Windows 7, Windows Vista SP2 et Windows Server 2008. Toutefois, les seules implémentations publiques des webSockets clients et serveurs sont prises en charge sur Windows 8 et les Windows Server 2012. Les classes et les éléments de classe de l’espace de noms System.Net.WebSockets 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.
Exactement un envoi et une réception est pris en charge sur chaque WebSocket objet en parallèle. L’émission de plusieurs envois ou réceptions multiples 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. Vérifiez 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
| Nom | Description |
|---|---|
| WebSocket() |
Crée une instance de la classe WebSocket. |
Propriétés
| Nom | Description |
|---|---|
| CloseStatus |
Indique la raison pour laquelle le point de terminaison distant a lancé l’établissement d’une liaison étroite. |
| CloseStatusDescription |
Permet au point de terminaison distant de décrire la raison pour laquelle la connexion a été fermée. |
| DefaultKeepAliveInterval |
Obtient l’intervalle de conservation actif du protocole WebSocket par défaut. |
| State |
Retourne l’état actuel de la connexion WebSocket. |
| SubProtocol |
Obtient le sous-protocole qui a été négocié pendant la négociation ouvrante. |
Méthodes
| Nom | Description |
|---|---|
| Abort() |
Abandonne la connexion WebSocket et annule les opérations d’E/S en attente. |
| CloseAsync(WebSocketCloseStatus, String, CancellationToken) |
Ferme la connexion WebSocket en tant qu’opération asynchrone à l’aide de la négociation de fermeture définie dans la spécification du protocole WebSocket, section 7. |
| CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) |
Lance ou termine l’établissement d’une liaison étroite définie dans la spécification du protocole WebSocket, section 7. |
| CreateClientBuffer(Int32, Int32) |
Créez des mémoires tampons clientes à utiliser avec cette WebSocket instance. |
| 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 WebSocket côté client qui utilisera le WSPC à des fins de trame. |
| CreateFromStream(Stream, Boolean, String, TimeSpan) |
Crée un WebSocket objet qui fonctionne sur le flux spécifié, qui représente une connexion de socket web. |
| CreateServerBuffer(Int32) |
Crée une mémoire tampon de serveur WebSocket. |
| Dispose() |
Utilisé pour nettoyer les ressources non managées pour les implémentations ASP.NET et auto-hébergées. |
| Equals(Object) |
Détermine si l’objet spécifié est égal à l’objet actuel. (Hérité de Object) |
| GetHashCode() |
Sert de fonction de hachage par défaut. (Hérité de Object) |
| GetType() |
Obtient la Type de l’instance actuelle. (Hérité de Object) |
| IsApplicationTargeting45() |
Obsolète.
Obsolète.
Retourne une valeur qui indique si l’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 Objectactuel. (Hérité de Object) |
| ReceiveAsync(ArraySegment<Byte>, CancellationToken) |
Reçoit des données de la WebSocket connexion de façon asynchrone. |
| ReceiveAsync(Memory<Byte>, CancellationToken) |
Reçoit des données de la WebSocket connexion de façon asynchrone. |
| RegisterPrefixes() |
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 d’inscrire des préfixes pour les requêtes WebSocket (ws et wss). |
| SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Envoie des données sur la WebSocket connexion de manière asynchrone. |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Envoie des données sur la WebSocket connexion de manière asynchrone. |
| 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) |