System.Net.WebSockets.xml 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Net.WebSockets</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Net.WebSockets.WebSocket">
  8. <summary>La classe WebSocket permet aux applications d'envoyer et recevoir des données une fois la mise à niveau de WebSocket terminée.</summary>
  9. </member>
  10. <member name="M:System.Net.WebSockets.WebSocket.#ctor">
  11. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocket" />.</summary>
  12. </member>
  13. <member name="M:System.Net.WebSockets.WebSocket.Abort">
  14. <summary>Abandonne la connexion WebSocket et annule toutes les opérations d'E/S en attente.</summary>
  15. </member>
  16. <member name="M:System.Net.WebSockets.WebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  17. <summary>Ferme la connexion WebSocket sous forme d'opération asynchrone à l'aide du protocole de transfert de fermeture défini dans la Spécification du protocole WebSocket (section 7).</summary>
  18. <returns>retourne <see cref="T:System.Threading.Tasks.Task" /> ;Objet de tâche représentant l'opération asynchrone. </returns>
  19. <param name="closeStatus">Indique la raison de la fermeture de la connexion WebSocket.</param>
  20. <param name="statusDescription">Spécifie une explication lisible du motif de fermeture de la connexion.</param>
  21. <param name="cancellationToken">Jeton qui peut être utilisé pour propager la notification indiquant que les opérations doivent être annulées.</param>
  22. </member>
  23. <member name="M:System.Net.WebSockets.WebSocket.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  24. <summary>Initialise et termine le protocole de transfert de fermeture défini dans la spécification du protocole WebSocket (section 7).</summary>
  25. <returns>retourne <see cref="T:System.Threading.Tasks.Task" /> ;Objet de tâche représentant l'opération asynchrone. </returns>
  26. <param name="closeStatus">Indique la raison de la fermeture de la connexion WebSocket.</param>
  27. <param name="statusDescription">Permet aux applications de spécifier une explication lisible par l'utilisateur quant à la fermeture de connexion.</param>
  28. <param name="cancellationToken">Jeton qui peut être utilisé pour propager la notification indiquant que les opérations doivent être annulées.</param>
  29. </member>
  30. <member name="P:System.Net.WebSockets.WebSocket.CloseStatus">
  31. <summary>Indique la raison pour laquelle le point de terminaison distant a initialisé le protocole de transfert de fermeture.</summary>
  32. <returns>retourne <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" /> ;</returns>
  33. </member>
  34. <member name="P:System.Net.WebSockets.WebSocket.CloseStatusDescription">
  35. <summary>Permet au point de terminaison distant de décrire la raison de fermeture de la connexion.</summary>
  36. <returns>retourne <see cref="T:System.String" /> ;</returns>
  37. </member>
  38. <member name="M:System.Net.WebSockets.WebSocket.Dispose">
  39. <summary>Utilisé pour nettoyer des ressources non managées pour ASP.NET et des implémentations auto-hébergées.</summary>
  40. </member>
  41. <member name="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
  42. <summary>Reçoit des données de la connexion WebSocket de façon asynchrone.</summary>
  43. <returns>retourne <see cref="T:System.Threading.Tasks.Task`1" /> ;Objet de tâche représentant l'opération asynchrone.La propriété <see cref="P:System.Threading.Tasks.Task`1.Result" /> sur l'objet de tâche retourne un tableau <see cref="T:System.Byte" /> contenant les données reçues.</returns>
  44. <param name="buffer">Référence la mémoire tampon d'application qui est l'emplacement de stockage des données reçues.</param>
  45. <param name="cancellationToken">Propage la notification indiquant que des opérations doivent être annulées.</param>
  46. </member>
  47. <member name="M:System.Net.WebSockets.WebSocket.SendAsync(System.ArraySegment{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
  48. <summary>Envoie des données via la connexion WebSocket de façon asynchrone.</summary>
  49. <returns>retourne <see cref="T:System.Threading.Tasks.Task" /> ;Objet de tâche représentant l'opération asynchrone. </returns>
  50. <param name="buffer">Mémoire tampon à envoyer sur la connexion.</param>
  51. <param name="messageType">Indique si l'application envoie un message binaire ou texte.</param>
  52. <param name="endOfMessage">Indique si les données dans la « mémoire tampon » est la dernière partie d'un message.</param>
  53. <param name="cancellationToken">Jeton qui propage la notification indiquant que les opérations doivent être annulées.</param>
  54. </member>
  55. <member name="P:System.Net.WebSockets.WebSocket.State">
  56. <summary>Retourne l'état actuel de la connexion de WebSocket.</summary>
  57. <returns>retourne <see cref="T:System.Net.WebSockets.WebSocketState" /> ;</returns>
  58. </member>
  59. <member name="P:System.Net.WebSockets.WebSocket.SubProtocol">
  60. <summary>Sous-protocole négocié pendant l'établissement de la liaison d'ouverture.</summary>
  61. <returns>retourne <see cref="T:System.String" /> ;</returns>
  62. </member>
  63. <member name="T:System.Net.WebSockets.WebSocketCloseStatus">
  64. <summary>Représente des codes de fermeture WebSocket connus, comme définis dans la section 11.7 de la spécification de protocole WebSocket.</summary>
  65. </member>
  66. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.Empty">
  67. <summary>Aucune erreur spécifiée.</summary>
  68. </member>
  69. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.EndpointUnavailable">
  70. <summary>(1001) Indique qu'un point de terminaison a été supprimé.Le serveur ou le client deviendra indisponible.</summary>
  71. </member>
  72. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InternalServerError">
  73. <summary>La connexion sera fermée par le serveur en raison d'une erreur sur le serveur.</summary>
  74. </member>
  75. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidMessageType">
  76. <summary>(1003) Le client ou le serveur met fin à la connexion car le type de données reçu n'est pas accepté.</summary>
  77. </member>
  78. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidPayloadData">
  79. <summary>(1007) Le client ou le serveur met fin à la connexion car les données reçues ne sont pas cohérentes avec le type de message.</summary>
  80. </member>
  81. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MandatoryExtension">
  82. <summary>(1010) Le client met fin à la connexion car la gestion d'une extension de la part du serveur était attendue.</summary>
  83. </member>
  84. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MessageTooBig">
  85. <summary>(1004) Réservé à un usage futur.</summary>
  86. </member>
  87. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.NormalClosure">
  88. <summary>(1000) La connexion s'est fermée après que l'exécution de la requête.</summary>
  89. </member>
  90. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.PolicyViolation">
  91. <summary>(1008) La connexion sera fermée car le message reçu par un point de terminaison ne respecte pas la stratégie de ce dernier.</summary>
  92. </member>
  93. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.ProtocolError">
  94. <summary>(1002) Le client ou le serveur met fin à la connexion suite à une erreur de protocole.</summary>
  95. </member>
  96. <member name="T:System.Net.WebSockets.WebSocketError">
  97. <summary>Contient la liste d'erreurs WebSocket possibles.</summary>
  98. </member>
  99. <member name="F:System.Net.WebSockets.WebSocketError.ConnectionClosedPrematurely">
  100. <summary>Indique que la connexion a été interrompue de manière inattendue.</summary>
  101. </member>
  102. <member name="F:System.Net.WebSockets.WebSocketError.Faulted">
  103. <summary>Indique une erreur générale.</summary>
  104. </member>
  105. <member name="F:System.Net.WebSockets.WebSocketError.HeaderError">
  106. <summary>Indique qu'une erreur s'est produite lors de l'analyse des en-têtes HTTP pendant l'établissement de la liaison d'ouverture.</summary>
  107. </member>
  108. <member name="F:System.Net.WebSockets.WebSocketError.InvalidMessageType">
  109. <summary>Indique qu'un frame de WebSocket avec un opcode inconnu a été reçu.</summary>
  110. </member>
  111. <member name="F:System.Net.WebSockets.WebSocketError.InvalidState">
  112. <summary>Indique que le WebSocket n'est pas valide pour l'opération donnée (telles que la fermeture ou l'abandon).</summary>
  113. </member>
  114. <member name="F:System.Net.WebSockets.WebSocketError.NativeError">
  115. <summary>Indique qu'une erreur native inconnue s'est produite.</summary>
  116. </member>
  117. <member name="F:System.Net.WebSockets.WebSocketError.NotAWebSocket">
  118. <summary>Indique que la requête entrante n'est pas une requête Websock valide.</summary>
  119. </member>
  120. <member name="F:System.Net.WebSockets.WebSocketError.Success">
  121. <summary>Indique qu'il n'y avait aucune information d'erreur native pour l'exception.</summary>
  122. </member>
  123. <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedProtocol">
  124. <summary>Indique que le client a demandé un sous-protocole WebSocket non pris en charge.</summary>
  125. </member>
  126. <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedVersion">
  127. <summary>Indique que le client a demandé une version non prise en charge du protocole WebSocket.</summary>
  128. </member>
  129. <member name="T:System.Net.WebSockets.WebSocketException">
  130. <summary>Représente une exception qui s'est produite lors de l'exécution d'une opération sur une connexion WebSocket.</summary>
  131. </member>
  132. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32)">
  133. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  134. <param name="nativeError">Code d'erreur natif de l'exception.</param>
  135. </member>
  136. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.Exception)">
  137. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  138. <param name="nativeError">Code d'erreur natif de l'exception.</param>
  139. <param name="innerException">Indique la précédente exception qui a abouti à l'exception actuelle.</param>
  140. </member>
  141. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.String)">
  142. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  143. <param name="nativeError">Code d'erreur natif de l'exception.</param>
  144. <param name="message">Description de l'erreur.</param>
  145. </member>
  146. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError)">
  147. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  148. <param name="error">Erreur de l'énumération de WebSocketError.</param>
  149. </member>
  150. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Exception)">
  151. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  152. <param name="error">Erreur de l'énumération de WebSocketError.</param>
  153. <param name="innerException">Indique la précédente exception qui a abouti à l'exception actuelle.</param>
  154. </member>
  155. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32)">
  156. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  157. <param name="error">Erreur de l'énumération de WebSocketError.</param>
  158. <param name="nativeError">Code d'erreur natif de l'exception.</param>
  159. </member>
  160. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.Exception)">
  161. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  162. <param name="error">Erreur de l'énumération de WebSocketError.</param>
  163. <param name="nativeError">Code d'erreur natif de l'exception.</param>
  164. <param name="innerException">Indique la précédente exception qui a abouti à l'exception actuelle.</param>
  165. </member>
  166. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String)">
  167. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  168. <param name="error">Erreur de l'énumération de WebSocketError.</param>
  169. <param name="nativeError">Code d'erreur natif de l'exception.</param>
  170. <param name="message">Description de l'erreur.</param>
  171. </member>
  172. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String,System.Exception)">
  173. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  174. <param name="error">Erreur de l'énumération de WebSocketError.</param>
  175. <param name="nativeError">Code d'erreur natif de l'exception.</param>
  176. <param name="message">Description de l'erreur.</param>
  177. <param name="innerException">Indique la précédente exception qui a abouti à l'exception actuelle.</param>
  178. </member>
  179. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String)">
  180. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  181. <param name="error">Erreur de l'énumération de WebSocketError.</param>
  182. <param name="message">Description de l'erreur.</param>
  183. </member>
  184. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String,System.Exception)">
  185. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  186. <param name="error">Erreur de l'énumération de WebSocketError.</param>
  187. <param name="message">Description de l'erreur.</param>
  188. <param name="innerException">Indique la précédente exception qui a abouti à l'exception actuelle.</param>
  189. </member>
  190. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String)">
  191. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  192. <param name="message">Description de l'erreur.</param>
  193. </member>
  194. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String,System.Exception)">
  195. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  196. <param name="message">Description de l'erreur.</param>
  197. <param name="innerException">Indique la précédente exception qui a abouti à l'exception actuelle.</param>
  198. </member>
  199. <member name="P:System.Net.WebSockets.WebSocketException.ErrorCode">
  200. <summary>Code d'erreur natif de l'exception qui s'est produite.</summary>
  201. <returns>retourne <see cref="T:System.Int32" /> ;</returns>
  202. </member>
  203. <member name="P:System.Net.WebSockets.WebSocketException.WebSocketErrorCode">
  204. <summary>Retourne une classe WebSocketError indiquant le type d'erreur qui s'est produit.</summary>
  205. <returns>retourne <see cref="T:System.Net.WebSockets.WebSocketError" /> ;</returns>
  206. </member>
  207. <member name="T:System.Net.WebSockets.WebSocketMessageType">
  208. <summary>Indique le type de message.</summary>
  209. </member>
  210. <member name="F:System.Net.WebSockets.WebSocketMessageType.Binary">
  211. <summary>Le message est au format binaire.</summary>
  212. </member>
  213. <member name="F:System.Net.WebSockets.WebSocketMessageType.Close">
  214. <summary>Réception terminée car un message de fermeture a été reçu.</summary>
  215. </member>
  216. <member name="F:System.Net.WebSockets.WebSocketMessageType.Text">
  217. <summary>Message en texte clair.</summary>
  218. </member>
  219. <member name="T:System.Net.WebSockets.WebSocketReceiveResult">
  220. <summary>Une instance de cette classe représente le résultat d'effectuer une opération unique de ReceiveAsync sur un WebSocket.</summary>
  221. </member>
  222. <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean)">
  223. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" />.</summary>
  224. <param name="count">Nombre d'octets reçus.</param>
  225. <param name="messageType">Type de message reçu.</param>
  226. <param name="endOfMessage">Indique s'il s'agit du message final.</param>
  227. </member>
  228. <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Nullable{System.Net.WebSockets.WebSocketCloseStatus},System.String)">
  229. <summary>Crée une instance de la classe <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" />.</summary>
  230. <param name="count">Nombre d'octets reçus.</param>
  231. <param name="messageType">Type de message reçu.</param>
  232. <param name="endOfMessage">Indique s'il s'agit du message final.</param>
  233. <param name="closeStatus">Indique l'état <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" /> de la connexion.</param>
  234. <param name="closeStatusDescription">Description de <paramref name="closeStatus" />.</param>
  235. </member>
  236. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatus">
  237. <summary>Indique la raison pour laquelle le point de terminaison distant a initialisé le protocole de transfert de fermeture.</summary>
  238. <returns>retourne <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" /> ;</returns>
  239. </member>
  240. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatusDescription">
  241. <summary>Retourne la description facultative qui décrit la raison pour laquelle le protocole de transfert de fermeture a été initialisé par le point de terminaison distant.</summary>
  242. <returns>retourne <see cref="T:System.String" /> ;</returns>
  243. </member>
  244. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.Count">
  245. <summary>Indique le nombre d'octets reçus par WebSocket.</summary>
  246. <returns>retourne <see cref="T:System.Int32" /> ;</returns>
  247. </member>
  248. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.EndOfMessage">
  249. <summary>Indique si le message a été reçu complètement.</summary>
  250. <returns>retourne <see cref="T:System.Boolean" /> ;</returns>
  251. </member>
  252. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.MessageType">
  253. <summary>Indique si le message actuel est un message UTF-8 ou un message binaire.</summary>
  254. <returns>retourne <see cref="T:System.Net.WebSockets.WebSocketMessageType" /> ;</returns>
  255. </member>
  256. <member name="T:System.Net.WebSockets.WebSocketState">
  257. <summary> Définit les différents états qu'une instance WebSockets peut inclure.</summary>
  258. </member>
  259. <member name="F:System.Net.WebSockets.WebSocketState.Aborted">
  260. <summary>Réservé à une utilisation future.</summary>
  261. </member>
  262. <member name="F:System.Net.WebSockets.WebSocketState.Closed">
  263. <summary>Indique que le protocole de transfert de fermeture WebSocket s'est terminé normalement.</summary>
  264. </member>
  265. <member name="F:System.Net.WebSockets.WebSocketState.CloseReceived">
  266. <summary>Message de fermeture reçu du point de terminaison distant.</summary>
  267. </member>
  268. <member name="F:System.Net.WebSockets.WebSocketState.CloseSent">
  269. <summary>Message de fermeture envoyé au point de terminaison distant.</summary>
  270. </member>
  271. <member name="F:System.Net.WebSockets.WebSocketState.Connecting">
  272. <summary>La connexion négocie le protocole de transfert avec le point de terminaison distant.</summary>
  273. </member>
  274. <member name="F:System.Net.WebSockets.WebSocketState.None">
  275. <summary>Réservé à une utilisation future.</summary>
  276. </member>
  277. <member name="F:System.Net.WebSockets.WebSocketState.Open">
  278. <summary>État initial une fois l'établissement de la liaison HTTP terminé.</summary>
  279. </member>
  280. </members>
  281. </doc>