System.Net.WebSockets.xml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  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 連線並取消任何暫止 IO 作業。</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>啟始或完成 WebSocket 通訊協定規格區段 7中所定義的關閉信號交換。</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 的 Unmanaged 資源和自我裝載的實作。</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>表示已收到具有未知 opcode 的 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>這個類別的執行個體表示在 WebSocket 上執行單一 ReceiveAsync 作業的結果。</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">
  235. <paramref name="closeStatus" /> 的描述。</param>
  236. </member>
  237. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatus">
  238. <summary>指出遠端端點為什麼啟始關閉信號交換的原因。</summary>
  239. <returns>傳回 <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" />。</returns>
  240. </member>
  241. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatusDescription">
  242. <summary>傳回描述遠端端點為何已啟動關閉信號交換的選擇性描述。</summary>
  243. <returns>傳回 <see cref="T:System.String" />。</returns>
  244. </member>
  245. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.Count">
  246. <summary>表示 WebSocket 收到的位元組數。</summary>
  247. <returns>傳回 <see cref="T:System.Int32" />。</returns>
  248. </member>
  249. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.EndOfMessage">
  250. <summary>指示是否已完全接收訊息。</summary>
  251. <returns>傳回 <see cref="T:System.Boolean" />。</returns>
  252. </member>
  253. <member name="P:System.Net.WebSockets.WebSocketReceiveResult.MessageType">
  254. <summary>指出目前的訊息是 UTF-8 訊息或二進位訊息。</summary>
  255. <returns>傳回 <see cref="T:System.Net.WebSockets.WebSocketMessageType" />。</returns>
  256. </member>
  257. <member name="T:System.Net.WebSockets.WebSocketState">
  258. <summary> 定義 WebSockets 執行個體可能處於的狀態。</summary>
  259. </member>
  260. <member name="F:System.Net.WebSockets.WebSocketState.Aborted">
  261. <summary>保留供將來使用。</summary>
  262. </member>
  263. <member name="F:System.Net.WebSockets.WebSocketState.Closed">
  264. <summary>指示 WebSocket 關閉信號交換正常完成。</summary>
  265. </member>
  266. <member name="F:System.Net.WebSockets.WebSocketState.CloseReceived">
  267. <summary>接收到來自遠端端點的關閉訊息。</summary>
  268. </member>
  269. <member name="F:System.Net.WebSockets.WebSocketState.CloseSent">
  270. <summary>關閉訊息已傳送至遠端端點。</summary>
  271. </member>
  272. <member name="F:System.Net.WebSockets.WebSocketState.Connecting">
  273. <summary>這個連接正在交涉與遠端端點的信號交換。</summary>
  274. </member>
  275. <member name="F:System.Net.WebSockets.WebSocketState.None">
  276. <summary>保留供將來使用。</summary>
  277. </member>
  278. <member name="F:System.Net.WebSockets.WebSocketState.Open">
  279. <summary>HTTP 信號交換完成之後的初始狀態。</summary>
  280. </member>
  281. </members>
  282. </doc>