2
0

System.Net.WebSockets.xml 25 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>Класс WebSocket позволяет приложениям отправлять и получать данные после завершения обновления WebSocket.</summary>
  9. </member>
  10. <member name="M:System.Net.WebSockets.WebSocket.#ctor">
  11. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocket" />.</summary>
  12. </member>
  13. <member name="M:System.Net.WebSockets.WebSocket.Abort">
  14. <summary>Отменяет соединение WebSocket и отменяет все ожидающие операции ввода-вывода.</summary>
  15. </member>
  16. <member name="M:System.Net.WebSockets.WebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  17. <summary>Закрывает соединение WebSocket как асинхронная операция с помощью подтверждение закрытия, определенного в 7 разделе Спецификации протокола WebSocket.</summary>
  18. <returns>Возвращает <see cref="T:System.Threading.Tasks.Task" />.Объект задачи, представляющий асинхронную операцию. </returns>
  19. <param name="closeStatus">Указывает причину закрытия соединения WebSocket.</param>
  20. <param name="statusDescription">Задает объяснение причины закрытия соединения в понятном для человека формате.</param>
  21. <param name="cancellationToken">Токен, который может использоваться для распространения уведомления о том, что операции следует отменить.</param>
  22. </member>
  23. <member name="M:System.Net.WebSockets.WebSocket.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  24. <summary>Инициирует или завершает подтверждение закрытия, определенное в разделе 7 спецификации протокола WebSocket.</summary>
  25. <returns>Возвращает <see cref="T:System.Threading.Tasks.Task" />.Объект задачи, представляющий асинхронную операцию. </returns>
  26. <param name="closeStatus">Указывает причину закрытия соединения WebSocket.</param>
  27. <param name="statusDescription">Разрешает приложениям задавать доступное для чтения людьми объяснение о том, почему соединение закрыто.</param>
  28. <param name="cancellationToken">Токен, который может использоваться для распространения уведомления о том, что операции следует отменить.</param>
  29. </member>
  30. <member name="P:System.Net.WebSockets.WebSocket.CloseStatus">
  31. <summary>Указывает причину инициирования удаленной конечной точкой подтверждения закрытия.</summary>
  32. <returns>Возвращает <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" />.</returns>
  33. </member>
  34. <member name="P:System.Net.WebSockets.WebSocket.CloseStatusDescription">
  35. <summary>Разрешает удаленной конечной точке описывать причины, почему соединение было закрыто.</summary>
  36. <returns>Возвращает <see cref="T:System.String" />.</returns>
  37. </member>
  38. <member name="M:System.Net.WebSockets.WebSocket.Dispose">
  39. <summary>Используется для очистки неуправляемых ресурсов для реализаций ASP.NET и резидентных реализаций.</summary>
  40. </member>
  41. <member name="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
  42. <summary>Получает данные через соединение WebSocket асинхронно.</summary>
  43. <returns>Возвращает <see cref="T:System.Threading.Tasks.Task`1" />.Объект задачи, представляющий асинхронную операцию.Свойство <see cref="P:System.Threading.Tasks.Task`1.Result" /> в объекте задачи возвращает массив <see cref="T:System.Byte" />, содержащий полученные данные.</returns>
  44. <param name="buffer">Ссылается на буфер приложения - место хранения полученных данных.</param>
  45. <param name="cancellationToken">Распространение уведомления о том, что операции следует отменить.</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>Отправляет данные через соединение WebSocket асинхронно.</summary>
  49. <returns>Возвращает <see cref="T:System.Threading.Tasks.Task" />.Объект задачи, представляющий асинхронную операцию. </returns>
  50. <param name="buffer">Буфер, отправляемый через соединение.</param>
  51. <param name="messageType">Указывает, двоичное или текстовое сообщение отправляет приложение.</param>
  52. <param name="endOfMessage">Указывает, являются ли данные в "буфере" последней частью сообщения.</param>
  53. <param name="cancellationToken">Токен, который распространяет уведомление о том, что операции следует отменить.</param>
  54. </member>
  55. <member name="P:System.Net.WebSockets.WebSocket.State">
  56. <summary>Возвращает текущее состояние подключения WebSocket.</summary>
  57. <returns>Возвращает <see cref="T:System.Net.WebSockets.WebSocketState" />.</returns>
  58. </member>
  59. <member name="P:System.Net.WebSockets.WebSocket.SubProtocol">
  60. <summary>Подпротокол, который был согласован во время подтверждения открытия.</summary>
  61. <returns>Возвращает <see cref="T:System.String" />.</returns>
  62. </member>
  63. <member name="T:System.Net.WebSockets.WebSocketCloseStatus">
  64. <summary>Представляет стандартные коды закрытия WebSocket, как указано в параграфе 11.7 спецификации протокола WebSocket.</summary>
  65. </member>
  66. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.Empty">
  67. <summary>Ошибка не указана.</summary>
  68. </member>
  69. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.EndpointUnavailable">
  70. <summary>(1001) Указывает на то, что конечная точка удалена.Клиент или сервер становятся недоступными.</summary>
  71. </member>
  72. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InternalServerError">
  73. <summary>Соединение будет закрыто сервером из-за ошибки на сервере.</summary>
  74. </member>
  75. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidMessageType">
  76. <summary>(1003) Клиент или сервер завершает подключение, так как он не может принять полученный тип данных.</summary>
  77. </member>
  78. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidPayloadData">
  79. <summary>(1007) Клиент или сервер завершает подключение, так как он получил данные, не соответствующие типу сообщения.</summary>
  80. </member>
  81. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MandatoryExtension">
  82. <summary>(1010) Клиент завершает подключение, поскольку ожидалось, что расширение будет согласовано сервером.</summary>
  83. </member>
  84. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MessageTooBig">
  85. <summary>(1004) Зарезервировано для дальнейшего использования.</summary>
  86. </member>
  87. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.NormalClosure">
  88. <summary>(1000) Соединение закрыто после того, как запрос был выполнен.</summary>
  89. </member>
  90. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.PolicyViolation">
  91. <summary>(1008) Соединение будет закрыто из-за того, что конечная точка получала сообщение, которое нарушает его политику.</summary>
  92. </member>
  93. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.ProtocolError">
  94. <summary>(1002) Клиент или сервер завершает подключение из-за ошибки протокола.</summary>
  95. </member>
  96. <member name="T:System.Net.WebSockets.WebSocketError">
  97. <summary>Содержит список возможных ошибок WebSocket.</summary>
  98. </member>
  99. <member name="F:System.Net.WebSockets.WebSocketError.ConnectionClosedPrematurely">
  100. <summary>Указывает, что подключение было неожиданно прервано.</summary>
  101. </member>
  102. <member name="F:System.Net.WebSockets.WebSocketError.Faulted">
  103. <summary>Показывает общую ошибку.</summary>
  104. </member>
  105. <member name="F:System.Net.WebSockets.WebSocketError.HeaderError">
  106. <summary>Указывает, что произошла ошибка при разборе заголовков HTTP во время подтверждения открытия.</summary>
  107. </member>
  108. <member name="F:System.Net.WebSockets.WebSocketError.InvalidMessageType">
  109. <summary>Указывает, что был получен кадр WebSocket с неизвестным кодом операции.</summary>
  110. </member>
  111. <member name="F:System.Net.WebSockets.WebSocketError.InvalidState">
  112. <summary>Указывает, что WebSocket находится в недопустимом состоянии для заданной операции (например, закрывается или прерывается).</summary>
  113. </member>
  114. <member name="F:System.Net.WebSockets.WebSocketError.NativeError">
  115. <summary>Указывает, что произошла неизвестная собственная ошибка.</summary>
  116. </member>
  117. <member name="F:System.Net.WebSockets.WebSocketError.NotAWebSocket">
  118. <summary>Указывает, что входящий запрос не был допустимым запросом WebSocket.</summary>
  119. </member>
  120. <member name="F:System.Net.WebSockets.WebSocketError.Success">
  121. <summary>Указывает, что для исключения не было никаких собственных сведений об ошибке.</summary>
  122. </member>
  123. <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedProtocol">
  124. <summary>Указывает, что клиент запросил неподдерживаемую версию подпротокола WebSocket.</summary>
  125. </member>
  126. <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedVersion">
  127. <summary>Указывает, что клиент запросил неподдерживаемую версию протокола WebSocket.</summary>
  128. </member>
  129. <member name="T:System.Net.WebSockets.WebSocketException">
  130. <summary>Представляет исключение, возникшее при выполнении операции на соединении WebSocket.</summary>
  131. </member>
  132. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32)">
  133. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  134. <param name="nativeError">Машинный код ошибки для исключения.</param>
  135. </member>
  136. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.Exception)">
  137. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  138. <param name="nativeError">Машинный код ошибки для исключения.</param>
  139. <param name="innerException">Указывает предыдущее исключение, которое привело к появлению текущего исключения.</param>
  140. </member>
  141. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.String)">
  142. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  143. <param name="nativeError">Машинный код ошибки для исключения.</param>
  144. <param name="message">Описание ошибки.</param>
  145. </member>
  146. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError)">
  147. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  148. <param name="error">Ошибка от перечисления WebSocketError.</param>
  149. </member>
  150. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Exception)">
  151. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  152. <param name="error">Ошибка от перечисления WebSocketError.</param>
  153. <param name="innerException">Указывает предыдущее исключение, которое привело к появлению текущего исключения.</param>
  154. </member>
  155. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32)">
  156. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  157. <param name="error">Ошибка от перечисления WebSocketError.</param>
  158. <param name="nativeError">Машинный код ошибки для исключения.</param>
  159. </member>
  160. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.Exception)">
  161. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  162. <param name="error">Ошибка от перечисления WebSocketError.</param>
  163. <param name="nativeError">Машинный код ошибки для исключения.</param>
  164. <param name="innerException">Указывает предыдущее исключение, которое привело к появлению текущего исключения.</param>
  165. </member>
  166. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String)">
  167. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  168. <param name="error">Ошибка от перечисления WebSocketError.</param>
  169. <param name="nativeError">Машинный код ошибки для исключения.</param>
  170. <param name="message">Описание ошибки.</param>
  171. </member>
  172. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String,System.Exception)">
  173. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  174. <param name="error">Ошибка от перечисления WebSocketError.</param>
  175. <param name="nativeError">Машинный код ошибки для исключения.</param>
  176. <param name="message">Описание ошибки.</param>
  177. <param name="innerException">Указывает предыдущее исключение, которое привело к появлению текущего исключения.</param>
  178. </member>
  179. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String)">
  180. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  181. <param name="error">Ошибка от перечисления WebSocketError.</param>
  182. <param name="message">Описание ошибки.</param>
  183. </member>
  184. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String,System.Exception)">
  185. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  186. <param name="error">Ошибка от перечисления WebSocketError.</param>
  187. <param name="message">Описание ошибки.</param>
  188. <param name="innerException">Указывает предыдущее исключение, которое привело к появлению текущего исключения.</param>
  189. </member>
  190. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String)">
  191. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  192. <param name="message">Описание ошибки.</param>
  193. </member>
  194. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String,System.Exception)">
  195. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketException" />.</summary>
  196. <param name="message">Описание ошибки.</param>
  197. <param name="innerException">Указывает предыдущее исключение, которое привело к появлению текущего исключения.</param>
  198. </member>
  199. <member name="P:System.Net.WebSockets.WebSocketException.ErrorCode">
  200. <summary>Машинный код ошибки для возникшего исключения.</summary>
  201. <returns>Возвращает <see cref="T:System.Int32" />.</returns>
  202. </member>
  203. <member name="P:System.Net.WebSockets.WebSocketException.WebSocketErrorCode">
  204. <summary>Возвращает WebSocketError, указывающий тип происшедшей ошибки.</summary>
  205. <returns>Возвращает <see cref="T:System.Net.WebSockets.WebSocketError" />.</returns>
  206. </member>
  207. <member name="T:System.Net.WebSockets.WebSocketMessageType">
  208. <summary>Указывает тип сообщения.</summary>
  209. </member>
  210. <member name="F:System.Net.WebSockets.WebSocketMessageType.Binary">
  211. <summary>Сообщение должно быть в двоичном формате.</summary>
  212. </member>
  213. <member name="F:System.Net.WebSockets.WebSocketMessageType.Close">
  214. <summary>Получение завершено из-за того, что было получено сообщение закрывания.</summary>
  215. </member>
  216. <member name="F:System.Net.WebSockets.WebSocketMessageType.Text">
  217. <summary>Сообщение в виде открытого текста.</summary>
  218. </member>
  219. <member name="T:System.Net.WebSockets.WebSocketReceiveResult">
  220. <summary>Экземпляр этого класса, представляющий результат выполнения одной операцию ReceiveAsync на WebSocket.</summary>
  221. </member>
  222. <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean)">
  223. <summary>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" />.</summary>
  224. <param name="count">Число полученных байтов.</param>
  225. <param name="messageType">Тип полученного сообщения.</param>
  226. <param name="endOfMessage">Указывает, является ли данное сообщение конечным.</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>Создает экземпляр класса <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" />.</summary>
  230. <param name="count">Число полученных байтов.</param>
  231. <param name="messageType">Тип полученного сообщения.</param>
  232. <param name="endOfMessage">Указывает, является ли данное сообщение конечным.</param>
  233. <param name="closeStatus">Указывает <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" /> подключения.</param>
  234. <param name="closeStatusDescription">Описание параметра <paramref name="closeStatus" />.</param>
  235. </member>
  236. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatus">
  237. <summary>Указывает причину инициирования удаленной конечной точкой подтверждения закрытия.</summary>
  238. <returns>Возвращает <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" />.</returns>
  239. </member>
  240. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatusDescription">
  241. <summary>Возвращает необязательное описание, которое показывает, почему подтверждение закрытия было инициировано удаленной конечной точкой.</summary>
  242. <returns>Возвращает <see cref="T:System.String" />.</returns>
  243. </member>
  244. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.Count">
  245. <summary>Указывает количество байтов, полученных объектом WebSocket.</summary>
  246. <returns>Возвращает <see cref="T:System.Int32" />.</returns>
  247. </member>
  248. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.EndOfMessage">
  249. <summary>Указывает, было ли сообщение получено полностью.</summary>
  250. <returns>Возвращает <see cref="T:System.Boolean" />.</returns>
  251. </member>
  252. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.MessageType">
  253. <summary>Указывает, сообщением UTF-8 или двоичным сообщением является текущее сообщение.</summary>
  254. <returns>Возвращает <see cref="T:System.Net.WebSockets.WebSocketMessageType" />.</returns>
  255. </member>
  256. <member name="T:System.Net.WebSockets.WebSocketState">
  257. <summary> Указывает различные состояния, в которых может быть экземпляр WebSockets.</summary>
  258. </member>
  259. <member name="F:System.Net.WebSockets.WebSocketState.Aborted">
  260. <summary>Зарезервировано для использования в будущем.</summary>
  261. </member>
  262. <member name="F:System.Net.WebSockets.WebSocketState.Closed">
  263. <summary>Указывает, что подтверждение закрытия WebSocket завершилось правильно.</summary>
  264. </member>
  265. <member name="F:System.Net.WebSockets.WebSocketState.CloseReceived">
  266. <summary>Сообщение о закрытии было получено от удаленной конечной точки.</summary>
  267. </member>
  268. <member name="F:System.Net.WebSockets.WebSocketState.CloseSent">
  269. <summary>Сообщение о закрытии было отправлено удаленной конечной точке.</summary>
  270. </member>
  271. <member name="F:System.Net.WebSockets.WebSocketState.Connecting">
  272. <summary>Соединение согласовывает подтверждение с удаленной конечной точкой.</summary>
  273. </member>
  274. <member name="F:System.Net.WebSockets.WebSocketState.None">
  275. <summary>Зарезервировано для использования в будущем.</summary>
  276. </member>
  277. <member name="F:System.Net.WebSockets.WebSocketState.Open">
  278. <summary>Начальное состояние после завершения подтверждения HTTP.</summary>
  279. </member>
  280. </members>
  281. </doc>