System.Net.WebSockets.xml 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  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>
  12. <see cref="T:System.Net.WebSockets.WebSocket" /> クラスのインスタンスを作成します。</summary>
  13. </member>
  14. <member name="M:System.Net.WebSockets.WebSocket.Abort">
  15. <summary>WebSocket 接続を中止し、保留中の IO 操作をキャンセルします。</summary>
  16. </member>
  17. <member name="M:System.Net.WebSockets.WebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  18. <summary>非同期操作として、WebSocket プロトコル仕様のセクション 7 に定義された終了ハンドシェイクを使用している WebSocket 接続を閉じます。</summary>
  19. <returns>
  20. <see cref="T:System.Threading.Tasks.Task" /> を返します。非同期操作を表すタスク オブジェクト。</returns>
  21. <param name="closeStatus">WebSocket 接続を閉じる理由を示します。</param>
  22. <param name="statusDescription">接続が閉じられた理由について人間が判読可能な説明を指定します。</param>
  23. <param name="cancellationToken">操作を取り消す通知を配信するために使用できるトークン。</param>
  24. </member>
  25. <member name="M:System.Net.WebSockets.WebSocket.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  26. <summary>WebSocket プロトコル仕様のセクション 7 で定義されている終了ハンドシェイクを開始または完了します。</summary>
  27. <returns>
  28. <see cref="T:System.Threading.Tasks.Task" /> を返します。非同期操作を表すタスク オブジェクト。</returns>
  29. <param name="closeStatus">WebSocket 接続を閉じる理由を示します。</param>
  30. <param name="statusDescription">接続が閉じられた理由について人間が判読可能な説明をアプリケーションが指定できるようにします。</param>
  31. <param name="cancellationToken">操作を取り消す通知を配信するために使用できるトークン。</param>
  32. </member>
  33. <member name="P:System.Net.WebSockets.WebSocket.CloseStatus">
  34. <summary>リモート エンドポイントが終了ハンドシェイクを開始した理由を示します。</summary>
  35. <returns>
  36. <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" /> を返します。</returns>
  37. </member>
  38. <member name="P:System.Net.WebSockets.WebSocket.CloseStatusDescription">
  39. <summary>接続が閉じられた理由をリモート エンドポイントが説明できるようにします。</summary>
  40. <returns>
  41. <see cref="T:System.String" /> を返します。</returns>
  42. </member>
  43. <member name="M:System.Net.WebSockets.WebSocket.Dispose">
  44. <summary>ASP.NET およびセルフホストされている実装のアンマネージ リソースをクリーンアップするために使用します。</summary>
  45. </member>
  46. <member name="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
  47. <summary>WebSocket 接続からデータを非同期に受け取ります。</summary>
  48. <returns>
  49. <see cref="T:System.Threading.Tasks.Task`1" /> を返します。非同期操作を表すタスク オブジェクト。タスク オブジェクトの <see cref="P:System.Threading.Tasks.Task`1.Result" /> プロパティは、受け取ったデータを含む <see cref="T:System.Byte" /> 配列を返します。</returns>
  50. <param name="buffer">受信データのデータ格納場所であるアプリケーション バッファーを参照します。</param>
  51. <param name="cancellationToken">操作を取り消す通知を配信します。</param>
  52. </member>
  53. <member name="M:System.Net.WebSockets.WebSocket.SendAsync(System.ArraySegment{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
  54. <summary>WebSocket 接続を介してデータを非同期に受け取ります。</summary>
  55. <returns>
  56. <see cref="T:System.Threading.Tasks.Task" /> を返します。非同期操作を表すタスク オブジェクト。</returns>
  57. <param name="buffer">接続上で送信されるバッファー。</param>
  58. <param name="messageType">アプリケーションがバイナリ メッセージを送信するか、テキスト メッセージを送信するかを示します。</param>
  59. <param name="endOfMessage">"バッファー" 内のデータがメッセージの最後の部分であるかどうかを示します。</param>
  60. <param name="cancellationToken">操作を取り消す通知を配信するトークン。</param>
  61. </member>
  62. <member name="P:System.Net.WebSockets.WebSocket.State">
  63. <summary>WebSocket 接続の現在の状態を返します。</summary>
  64. <returns>
  65. <see cref="T:System.Net.WebSockets.WebSocketState" /> を返します。</returns>
  66. </member>
  67. <member name="P:System.Net.WebSockets.WebSocket.SubProtocol">
  68. <summary>開始ハンドシェイクの間にネゴシエートされたサブプロトコル。</summary>
  69. <returns>
  70. <see cref="T:System.String" /> を返します。</returns>
  71. </member>
  72. <member name="T:System.Net.WebSockets.WebSocketCloseStatus">
  73. <summary>WebSocket プロトコル仕様の セクション 11.7 で定義されている既知の WebSocket の終了コードを表します。</summary>
  74. </member>
  75. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.Empty">
  76. <summary>エラーが指定されていません。</summary>
  77. </member>
  78. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.EndpointUnavailable">
  79. <summary>(1001) エンドポイントが削除されていることを示します。サーバーまたはクライアントが使用できなくなります。</summary>
  80. </member>
  81. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InternalServerError">
  82. <summary>接続は、サーバーのエラーのためサーバーによって閉じられます。</summary>
  83. </member>
  84. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidMessageType">
  85. <summary>(1003) 受け取ったデータ型を許可できないため、クライアントまたはサーバーは接続を終了中です。</summary>
  86. </member>
  87. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidPayloadData">
  88. <summary>(1007) メッセージ型と一致しない受信データがあるため、クライアントまたはサーバーは接続を終了中です。</summary>
  89. </member>
  90. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MandatoryExtension">
  91. <summary>(1010) クライアントはサーバーが拡張をネゴシエートすると予期したため、接続を終了中です。</summary>
  92. </member>
  93. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MessageTooBig">
  94. <summary>(1004) 今後使用するために予約されています。</summary>
  95. </member>
  96. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.NormalClosure">
  97. <summary>(1000) 接続は、要求が実行された後に閉じられました。</summary>
  98. </member>
  99. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.PolicyViolation">
  100. <summary>(1008) エンドポイントがポリシーに違反するメッセージを受け取ったため、接続は閉じられます。</summary>
  101. </member>
  102. <member name="F:System.Net.WebSockets.WebSocketCloseStatus.ProtocolError">
  103. <summary>(1002) クライアントまたはサーバーはプロトコル エラーが原因で接続を終了中です。</summary>
  104. </member>
  105. <member name="T:System.Net.WebSockets.WebSocketError">
  106. <summary>発生する可能性のある WebSocket のエラーのリストを格納します。</summary>
  107. </member>
  108. <member name="F:System.Net.WebSockets.WebSocketError.ConnectionClosedPrematurely">
  109. <summary>接続が予期せずに終了されたことを示します。</summary>
  110. </member>
  111. <member name="F:System.Net.WebSockets.WebSocketError.Faulted">
  112. <summary>一般的なエラーを示します。</summary>
  113. </member>
  114. <member name="F:System.Net.WebSockets.WebSocketError.HeaderError">
  115. <summary>開始ハンドシェイク中に HTTP ヘッダーを解析しているときに発生したエラーを示します。</summary>
  116. </member>
  117. <member name="F:System.Net.WebSockets.WebSocketError.InvalidMessageType">
  118. <summary>不明なオペコードのある WebSocket フレームを受信したことを示します。</summary>
  119. </member>
  120. <member name="F:System.Net.WebSockets.WebSocketError.InvalidState">
  121. <summary>WebSocket が特定の操作に対して無効な状態 (閉じている、中止されたなど) であることを示します。</summary>
  122. </member>
  123. <member name="F:System.Net.WebSockets.WebSocketError.NativeError">
  124. <summary>不明なネイティブ エラーが発生したことを示します。</summary>
  125. </member>
  126. <member name="F:System.Net.WebSockets.WebSocketError.NotAWebSocket">
  127. <summary>受信した要求が有効な websocket 要求ではなかったことを示します。</summary>
  128. </member>
  129. <member name="F:System.Net.WebSockets.WebSocketError.Success">
  130. <summary>例外のネイティブ エラー情報がないことを示します。</summary>
  131. </member>
  132. <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedProtocol">
  133. <summary>クライアントがサポートされていない WebSocket サブプロトコルを要求したことを示します。</summary>
  134. </member>
  135. <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedVersion">
  136. <summary>クライアントが WebSocket プロトコルのサポートされていないバージョンを要求したことを示します。</summary>
  137. </member>
  138. <member name="T:System.Net.WebSockets.WebSocketException">
  139. <summary>WebSocket 接続操作を実行したときに発生した例外を表します 。</summary>
  140. </member>
  141. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32)">
  142. <summary>
  143. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  144. <param name="nativeError">例外のネイティブ エラー コード。</param>
  145. </member>
  146. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.Exception)">
  147. <summary>
  148. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  149. <param name="nativeError">例外のネイティブ エラー コード。</param>
  150. <param name="innerException">現在の例外の原因となった前の例外を示します。</param>
  151. </member>
  152. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.String)">
  153. <summary>
  154. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  155. <param name="nativeError">例外のネイティブ エラー コード。</param>
  156. <param name="message">エラーの説明です。</param>
  157. </member>
  158. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError)">
  159. <summary>
  160. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  161. <param name="error">WebSocketError の列挙からのエラー。</param>
  162. </member>
  163. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Exception)">
  164. <summary>
  165. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  166. <param name="error">WebSocketError の列挙からのエラー。</param>
  167. <param name="innerException">現在の例外の原因となった前の例外を示します。</param>
  168. </member>
  169. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32)">
  170. <summary>
  171. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  172. <param name="error">WebSocketError の列挙からのエラー。</param>
  173. <param name="nativeError">例外のネイティブ エラー コード。</param>
  174. </member>
  175. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.Exception)">
  176. <summary>
  177. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  178. <param name="error">WebSocketError の列挙からのエラー。</param>
  179. <param name="nativeError">例外のネイティブ エラー コード。</param>
  180. <param name="innerException">現在の例外の原因となった前の例外を示します。</param>
  181. </member>
  182. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String)">
  183. <summary>
  184. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  185. <param name="error">WebSocketError の列挙からのエラー。</param>
  186. <param name="nativeError">例外のネイティブ エラー コード。</param>
  187. <param name="message">エラーの説明です。</param>
  188. </member>
  189. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String,System.Exception)">
  190. <summary>
  191. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  192. <param name="error">WebSocketError の列挙からのエラー。</param>
  193. <param name="nativeError">例外のネイティブ エラー コード。</param>
  194. <param name="message">エラーの説明です。</param>
  195. <param name="innerException">現在の例外の原因となった前の例外を示します。</param>
  196. </member>
  197. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String)">
  198. <summary>
  199. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  200. <param name="error">WebSocketError の列挙からのエラー。</param>
  201. <param name="message">エラーの説明です。</param>
  202. </member>
  203. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String,System.Exception)">
  204. <summary>
  205. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  206. <param name="error">WebSocketError の列挙からのエラー。</param>
  207. <param name="message">エラーの説明です。</param>
  208. <param name="innerException">現在の例外の原因となった前の例外を示します。</param>
  209. </member>
  210. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String)">
  211. <summary>
  212. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  213. <param name="message">エラーの説明です。</param>
  214. </member>
  215. <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String,System.Exception)">
  216. <summary>
  217. <see cref="T:System.Net.WebSockets.WebSocketException" /> クラスのインスタンスを作成します。</summary>
  218. <param name="message">エラーの説明です。</param>
  219. <param name="innerException">現在の例外の原因となった前の例外を示します。</param>
  220. </member>
  221. <member name="P:System.Net.WebSockets.WebSocketException.ErrorCode">
  222. <summary>発生した例外のネイティブ エラー コード。</summary>
  223. <returns>
  224. <see cref="T:System.Int32" /> を返します。</returns>
  225. </member>
  226. <member name="P:System.Net.WebSockets.WebSocketException.WebSocketErrorCode">
  227. <summary>発生したエラーの種類を示す WebSocketError を返します。</summary>
  228. <returns>
  229. <see cref="T:System.Net.WebSockets.WebSocketError" /> を返します。</returns>
  230. </member>
  231. <member name="T:System.Net.WebSockets.WebSocketMessageType">
  232. <summary>メッセージの種類を示します。</summary>
  233. </member>
  234. <member name="F:System.Net.WebSockets.WebSocketMessageType.Binary">
  235. <summary>メッセージがバイナリ形式です。</summary>
  236. </member>
  237. <member name="F:System.Net.WebSockets.WebSocketMessageType.Close">
  238. <summary>終了メッセージを受信したため受信が完了しました。</summary>
  239. </member>
  240. <member name="F:System.Net.WebSockets.WebSocketMessageType.Text">
  241. <summary>メッセージはクリア テキストです。</summary>
  242. </member>
  243. <member name="T:System.Net.WebSockets.WebSocketReceiveResult">
  244. <summary>このクラスのインスタンスは WebSocket での単一の ReceiveAsync 操作の実行結果を表します。</summary>
  245. </member>
  246. <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean)">
  247. <summary>
  248. <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" /> クラスのインスタンスを作成します。</summary>
  249. <param name="count">受信したバイト数。</param>
  250. <param name="messageType">受信したメッセージの型。</param>
  251. <param name="endOfMessage">これが最終メッセージかどうかを示します。</param>
  252. </member>
  253. <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Nullable{System.Net.WebSockets.WebSocketCloseStatus},System.String)">
  254. <summary>
  255. <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" /> クラスのインスタンスを作成します。</summary>
  256. <param name="count">受信したバイト数。</param>
  257. <param name="messageType">受信したメッセージの型。</param>
  258. <param name="endOfMessage">これが最終メッセージかどうかを示します。</param>
  259. <param name="closeStatus">接続の <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" /> を示します。</param>
  260. <param name="closeStatusDescription">
  261. <paramref name="closeStatus" /> の説明。</param>
  262. </member>
  263. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatus">
  264. <summary>リモート エンドポイントが終了ハンドシェイクを開始した理由を示します。</summary>
  265. <returns>
  266. <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" /> を返します。</returns>
  267. </member>
  268. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatusDescription">
  269. <summary>終了ハンドシェイクがリモート エンドポイントによって開始された理由を説明する省略可能な記述が返されます。</summary>
  270. <returns>
  271. <see cref="T:System.String" /> を返します。</returns>
  272. </member>
  273. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.Count">
  274. <summary>WebSocket が受信したバイト数を示します。</summary>
  275. <returns>
  276. <see cref="T:System.Int32" /> を返します。</returns>
  277. </member>
  278. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.EndOfMessage">
  279. <summary>メッセージを完全に受け取ったかどうかを示します。</summary>
  280. <returns>
  281. <see cref="T:System.Boolean" /> を返します。</returns>
  282. </member>
  283. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.MessageType">
  284. <summary>現在のメッセージが UTF-8 メッセージか、バイナリ メッセージかを示します。</summary>
  285. <returns>
  286. <see cref="T:System.Net.WebSockets.WebSocketMessageType" /> を返します。</returns>
  287. </member>
  288. <member name="T:System.Net.WebSockets.WebSocketState">
  289. <summary> WebSockets インスタンスが取ることのできるさまざまな状態を定義します。</summary>
  290. </member>
  291. <member name="F:System.Net.WebSockets.WebSocketState.Aborted">
  292. <summary>将来使用するために予約されています。</summary>
  293. </member>
  294. <member name="F:System.Net.WebSockets.WebSocketState.Closed">
  295. <summary>WebSocket の終了ハンドシェイクが正常に完了したことを示します。</summary>
  296. </member>
  297. <member name="F:System.Net.WebSockets.WebSocketState.CloseReceived">
  298. <summary>リモート エンドポイントから終了メッセージが届きました。</summary>
  299. </member>
  300. <member name="F:System.Net.WebSockets.WebSocketState.CloseSent">
  301. <summary>リモート エンドポイントに終了メッセージが送信されました。</summary>
  302. </member>
  303. <member name="F:System.Net.WebSockets.WebSocketState.Connecting">
  304. <summary>接続は、リモート エンドポイントとのハンドシェイクをネゴシエートしています。</summary>
  305. </member>
  306. <member name="F:System.Net.WebSockets.WebSocketState.None">
  307. <summary>将来使用するために予約されています。</summary>
  308. </member>
  309. <member name="F:System.Net.WebSockets.WebSocketState.Open">
  310. <summary>HTTP ハンドシェイク完了後の初期状態。</summary>
  311. </member>
  312. </members>
  313. </doc>