System.Net.WebSockets.xml 20 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 consente alle applicazioni di inviare e ricevere dati dopo il completamento dell'aggiornamento di WebSocket.</summary>
  9. </member>
  10. <member name="M:System.Net.WebSockets.WebSocket.#ctor">
  11. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocket" />.</summary>
  12. </member>
  13. <member name="M:System.Net.WebSockets.WebSocket.Abort">
  14. <summary>Interrompe la connessione WebSocket e annulla tutte le operazioni di I/O in corso.</summary>
  15. </member>
  16. <member name="M:System.Net.WebSockets.WebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  17. <summary>Chiude la connessione WebSocket come operazione asincrona utilizzando l'handshake di chiusura definito nelle specifiche del protocollo WebSocket sezione 7.</summary>
  18. <returns>Restituisca il valore <see cref="T:System.Threading.Tasks.Task" />.Oggetto dell'attività che rappresenta l'operazione asincrona. </returns>
  19. <param name="closeStatus">Indica il motivo della chiusura della connessione WebSocket.</param>
  20. <param name="statusDescription">Specifica una spiegazione leggibile del motivo della chiusura della connessione.</param>
  21. <param name="cancellationToken">Token che può essere utilizzato per propagare la notifica della richiesta di annullamento delle operazioni.</param>
  22. </member>
  23. <member name="M:System.Net.WebSockets.WebSocket.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  24. <summary>Avvia o completa l'handshake di chiusura definito nella Specifica del protocollo WebSocket, sezione 7 (le informazioni potrebbero essere in inglese).</summary>
  25. <returns>Restituisca il valore <see cref="T:System.Threading.Tasks.Task" />.Oggetto dell'attività che rappresenta l'operazione asincrona. </returns>
  26. <param name="closeStatus">Indica il motivo della chiusura della connessione WebSocket.</param>
  27. <param name="statusDescription">Consente alle applicazioni di specificare una spiegazione leggibile sul motivo della chiusura della connessione.</param>
  28. <param name="cancellationToken">Token che può essere utilizzato per propagare la notifica della richiesta di annullamento delle operazioni.</param>
  29. </member>
  30. <member name="P:System.Net.WebSockets.WebSocket.CloseStatus">
  31. <summary>Indica il motivo per cui l'endpoint remoto ha avviato l'handshake di chiusura.</summary>
  32. <returns>Restituisca il valore <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" />.</returns>
  33. </member>
  34. <member name="P:System.Net.WebSockets.WebSocket.CloseStatusDescription">
  35. <summary>Consente all'endpoint remoto di descrivere il motivo per cui la connessione è stata chiusa.</summary>
  36. <returns>Restituisca il valore <see cref="T:System.String" />.</returns>
  37. </member>
  38. <member name="M:System.Net.WebSockets.WebSocket.Dispose">
  39. <summary>Utilizzato per pulire le risorse non gestite per ASP.NET e le implementazioni indipendenti.</summary>
  40. </member>
  41. <member name="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
  42. <summary>Riceve dati dalla connessione WebSocket in modo asincrono.</summary>
  43. <returns>Restituisca il valore <see cref="T:System.Threading.Tasks.Task`1" />.Oggetto dell'attività che rappresenta l'operazione asincrona.La proprietà <see cref="P:System.Threading.Tasks.Task`1.Result" /> sull'oggetto attività restituisce una matrice <see cref="T:System.Byte" /> che contiene i dati ricevuti.</returns>
  44. <param name="buffer">Fa riferimento al buffer di applicazione che rappresenta il percorso di archiviazione per i dati ricevuti.</param>
  45. <param name="cancellationToken">Propaga la notifica di richiesta di annullamento delle operazioni.</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>Invia dati sulla connessione WebSocket in modo asincrono.</summary>
  49. <returns>Restituisca il valore <see cref="T:System.Threading.Tasks.Task" />.Oggetto dell'attività che rappresenta l'operazione asincrona. </returns>
  50. <param name="buffer">Il buffer da inviare tramite la connessione.</param>
  51. <param name="messageType">Indica se l'applicazione sta inviando un messaggio testuale o binario.</param>
  52. <param name="endOfMessage">Indica se i dati nel buffer sono l'ultima parte di un messaggio.</param>
  53. <param name="cancellationToken">Token che propaga la notifica della richiesta di annullamento delle operazioni.</param>
  54. </member>
  55. <member name="P:System.Net.WebSockets.WebSocket.State">
  56. <summary>Restituisce lo stato corrente della connessione WebSocket.</summary>
  57. <returns>Restituisca il valore <see cref="T:System.Net.WebSockets.WebSocketState" />.</returns>
  58. </member>
  59. <member name="P:System.Net.WebSockets.WebSocket.SubProtocol">
  60. <summary>Sottoprotocollo negoziato durante l'handshake di apertura.</summary>
  61. <returns>Restituisca il valore <see cref="T:System.String" />.</returns>
  62. </member>
  63. <member name="T:System.Net.WebSockets.WebSocketCloseStatus">
  64. <summary>Rappresenta i codici di chiusura WebSocket noti definiti nella sezione 11.7 della specifica del protocollo WebSocket.</summary>
  65. </member>
  66. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.Empty">
  67. <summary>Nessun errore specificato.</summary>
  68. </member>
  69. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.EndpointUnavailable">
  70. <summary>(1001) Indica che è in corso la rimozione di un endpoint.Il server o il client diventerà non disponibile.</summary>
  71. </member>
  72. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InternalServerError">
  73. <summary>La connessione verrà chiusa dal server a causa di un errore nel server.</summary>
  74. </member>
  75. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidMessageType">
  76. <summary>(1003) Il client o il server sta terminando la connessione poiché non accetta il tipo di dati fornito.</summary>
  77. </member>
  78. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidPayloadData">
  79. <summary>(1007) Il client o il server sta terminando la connessione poiché ha ricevuto dati non coerenti con il tipo di messaggio.</summary>
  80. </member>
  81. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MandatoryExtension">
  82. <summary>(1010) Il client sta terminando la connessione poiché prevedeva la negoziazione di un'estensione da parte del server.</summary>
  83. </member>
  84. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MessageTooBig">
  85. <summary>(1004) Riservato per un utilizzo futuro.</summary>
  86. </member>
  87. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.NormalClosure">
  88. <summary>(1000) La connessione è stata chiusa dopo che la richiesta è stata completata.</summary>
  89. </member>
  90. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.PolicyViolation">
  91. <summary>(1008) La connessione verrà chiusa poiché un endpoint ha ricevuto un messaggio che ne viola i criteri.</summary>
  92. </member>
  93. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.ProtocolError">
  94. <summary>(1002) Il client o il server sta terminando la connessione a causa di un errore di protocollo.</summary>
  95. </member>
  96. <member name="T:System.Net.WebSockets.WebSocketError">
  97. <summary>Contiene l'elenco degli errori possibili WebSocket.</summary>
  98. </member>
  99. <member name="F:System.Net.WebSockets.WebSocketError.ConnectionClosedPrematurely">
  100. <summary>Indica che la connessione è stata interrotta in modo imprevisto.</summary>
  101. </member>
  102. <member name="F:System.Net.WebSockets.WebSocketError.Faulted">
  103. <summary>Indica un errore generale.</summary>
  104. </member>
  105. <member name="F:System.Net.WebSockets.WebSocketError.HeaderError">
  106. <summary>Indica un errore verificatosi in fase di analisi delle intestazioni HTTP durante l'handshake di apertura.</summary>
  107. </member>
  108. <member name="F:System.Net.WebSockets.WebSocketError.InvalidMessageType">
  109. <summary>Indica che è stato ricevuto un frame di WebSocket con un codice operativo sconosciuto.</summary>
  110. </member>
  111. <member name="F:System.Net.WebSockets.WebSocketError.InvalidState">
  112. <summary>Indica che il WebSocket è uno stato non valido per l'operazione specificata (ad esempio, chiuso o interrotto).</summary>
  113. </member>
  114. <member name="F:System.Net.WebSockets.WebSocketError.NativeError">
  115. <summary>Indica che si è verificato un errore nativo sconosciuto.</summary>
  116. </member>
  117. <member name="F:System.Net.WebSockets.WebSocketError.NotAWebSocket">
  118. <summary>Indica che la richiesta in ingresso non è una richiesta WebSocket valida.</summary>
  119. </member>
  120. <member name="F:System.Net.WebSockets.WebSocketError.Success">
  121. <summary>Indica che non erano presenti informazioni sugli errori nativi per l'eccezione.</summary>
  122. </member>
  123. <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedProtocol">
  124. <summary>Indica che il client ha richiesto una versione non supportata del sottoprotocollo WebSocket.</summary>
  125. </member>
  126. <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedVersion">
  127. <summary>Indica che il client ha richiesto una versione non supportata del protocollo WebSocket.</summary>
  128. </member>
  129. <member name="T:System.Net.WebSockets.WebSocketException">
  130. <summary>Rappresenta eccezioni che si verificano durante un'operazione su una connessione di WebSocket.</summary>
  131. </member>
  132. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32)">
  133. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  134. <param name="nativeError">Codice di errore nativo per l'eccezione.</param>
  135. </member>
  136. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.Exception)">
  137. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  138. <param name="nativeError">Codice di errore nativo per l'eccezione.</param>
  139. <param name="innerException">Indica l'eccezione precedente che ha causato l'eccezione corrente.</param>
  140. </member>
  141. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.String)">
  142. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  143. <param name="nativeError">Codice di errore nativo per l'eccezione.</param>
  144. <param name="message">Descrizione dell'errore.</param>
  145. </member>
  146. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError)">
  147. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  148. <param name="error">L'errore dall'enumerazione WebSocketError.</param>
  149. </member>
  150. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Exception)">
  151. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  152. <param name="error">L'errore dall'enumerazione WebSocketError.</param>
  153. <param name="innerException">Indica l'eccezione precedente che ha causato l'eccezione corrente.</param>
  154. </member>
  155. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32)">
  156. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  157. <param name="error">L'errore dall'enumerazione WebSocketError.</param>
  158. <param name="nativeError">Codice di errore nativo per l'eccezione.</param>
  159. </member>
  160. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.Exception)">
  161. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  162. <param name="error">L'errore dall'enumerazione WebSocketError.</param>
  163. <param name="nativeError">Codice di errore nativo per l'eccezione.</param>
  164. <param name="innerException">Indica l'eccezione precedente che ha causato l'eccezione corrente.</param>
  165. </member>
  166. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String)">
  167. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  168. <param name="error">L'errore dall'enumerazione WebSocketError.</param>
  169. <param name="nativeError">Codice di errore nativo per l'eccezione.</param>
  170. <param name="message">Descrizione dell'errore.</param>
  171. </member>
  172. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String,System.Exception)">
  173. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  174. <param name="error">L'errore dall'enumerazione WebSocketError.</param>
  175. <param name="nativeError">Codice di errore nativo per l'eccezione.</param>
  176. <param name="message">Descrizione dell'errore.</param>
  177. <param name="innerException">Indica l'eccezione precedente che ha causato l'eccezione corrente.</param>
  178. </member>
  179. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String)">
  180. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  181. <param name="error">L'errore dall'enumerazione WebSocketError.</param>
  182. <param name="message">Descrizione dell'errore.</param>
  183. </member>
  184. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String,System.Exception)">
  185. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  186. <param name="error">L'errore dall'enumerazione WebSocketError.</param>
  187. <param name="message">Descrizione dell'errore.</param>
  188. <param name="innerException">Indica l'eccezione precedente che ha causato l'eccezione corrente.</param>
  189. </member>
  190. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String)">
  191. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  192. <param name="message">Descrizione dell'errore.</param>
  193. </member>
  194. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String,System.Exception)">
  195. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  196. <param name="message">Descrizione dell'errore.</param>
  197. <param name="innerException">Indica l'eccezione precedente che ha causato l'eccezione corrente.</param>
  198. </member>
  199. <member name="P:System.Net.WebSockets.WebSocketException.ErrorCode">
  200. <summary>Codice di errore nativo per l'eccezione che si è verificata.</summary>
  201. <returns>Restituisce <see cref="T:System.Int32" />.</returns>
  202. </member>
  203. <member name="P:System.Net.WebSockets.WebSocketException.WebSocketErrorCode">
  204. <summary>Restituisce un WebSocketError che indica il tipo di errore che si è verificato.</summary>
  205. <returns>Restituisce <see cref="T:System.Net.WebSockets.WebSocketError" />.</returns>
  206. </member>
  207. <member name="T:System.Net.WebSockets.WebSocketMessageType">
  208. <summary>Indica il tipo di messaggio.</summary>
  209. </member>
  210. <member name="F:System.Net.WebSockets.WebSocketMessageType.Binary">
  211. <summary>Il messaggio è in formato binario.</summary>
  212. </member>
  213. <member name="F:System.Net.WebSockets.WebSocketMessageType.Close">
  214. <summary>È stata completata una ricezione perché è stato ricevuto un messaggio di chiusura.</summary>
  215. </member>
  216. <member name="F:System.Net.WebSockets.WebSocketMessageType.Text">
  217. <summary>Il messaggio in testo non crittografato.</summary>
  218. </member>
  219. <member name="T:System.Net.WebSockets.WebSocketReceiveResult">
  220. <summary>Un'istanza di questa classe rappresenta il risultato dell'esecuzione di una singola operazione di ReceiveAsync in un WebSocket.</summary>
  221. </member>
  222. <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean)">
  223. <summary>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" />.</summary>
  224. <param name="count">Numero di byte ricevuti.</param>
  225. <param name="messageType">Tipo messaggio ricevuto.</param>
  226. <param name="endOfMessage">Indica se si tratta del messaggio finale.</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>Crea un'istanza della classe <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" />.</summary>
  230. <param name="count">Numero di byte ricevuti.</param>
  231. <param name="messageType">Tipo messaggio ricevuto.</param>
  232. <param name="endOfMessage">Indica se si tratta del messaggio finale.</param>
  233. <param name="closeStatus">Indica l'oggetto <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" /> della connessione.</param>
  234. <param name="closeStatusDescription">Descrizione di <paramref name="closeStatus" />.</param>
  235. </member>
  236. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatus">
  237. <summary>Indica il motivo per cui l'endpoint remoto ha avviato l'handshake di chiusura.</summary>
  238. <returns>Restituisce <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" />.</returns>
  239. </member>
  240. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatusDescription">
  241. <summary>Restituisce la descrizione facoltativa del motivo per cui l'handshake di chiusura è stato avviato dall'endpoint remoto.</summary>
  242. <returns>Restituisce <see cref="T:System.String" />.</returns>
  243. </member>
  244. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.Count">
  245. <summary>Indica il numero di byte ricevuti da WebSocket.</summary>
  246. <returns>Restituisce <see cref="T:System.Int32" />.</returns>
  247. </member>
  248. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.EndOfMessage">
  249. <summary>Indica se il messaggio è stato ricevuto per intero.</summary>
  250. <returns>Restituisce <see cref="T:System.Boolean" />.</returns>
  251. </member>
  252. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.MessageType">
  253. <summary>Indica se il messaggio corrente è un messaggio UTF-8 o un messaggio binario.</summary>
  254. <returns>Restituisce <see cref="T:System.Net.WebSockets.WebSocketMessageType" />.</returns>
  255. </member>
  256. <member name="T:System.Net.WebSockets.WebSocketState">
  257. <summary> Definisce i diversi stati in cui può trovarsi un'istanza di WebSockets.</summary>
  258. </member>
  259. <member name="F:System.Net.WebSockets.WebSocketState.Aborted">
  260. <summary>Riservato per un utilizzo futuro.</summary>
  261. </member>
  262. <member name="F:System.Net.WebSockets.WebSocketState.Closed">
  263. <summary>Indica che l'handshake di chiusura WebSocket è stato completato correttamente.</summary>
  264. </member>
  265. <member name="F:System.Net.WebSockets.WebSocketState.CloseReceived">
  266. <summary>Un messaggio di chiusura è stato ricevuto dall'endpoint remoto.</summary>
  267. </member>
  268. <member name="F:System.Net.WebSockets.WebSocketState.CloseSent">
  269. <summary>Un messaggio di chiusura è stato inviato all'endpoint remoto.</summary>
  270. </member>
  271. <member name="F:System.Net.WebSockets.WebSocketState.Connecting">
  272. <summary>La connessione sta negoziando l'handshake con l'endpoint remoto.</summary>
  273. </member>
  274. <member name="F:System.Net.WebSockets.WebSocketState.None">
  275. <summary>Riservato per un utilizzo futuro.</summary>
  276. </member>
  277. <member name="F:System.Net.WebSockets.WebSocketState.Open">
  278. <summary>Lo stato iniziale dopo che l'handshake HTTP è stato completato.</summary>
  279. </member>
  280. </members>
  281. </doc>