System.Net.WebSockets.xml 21 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 protocol specification 7단원에 정의된 close 핸드셰이크를 사용하여 비동기 작업으로 WebSocket 연결을 닫습니다.</summary>
  19. <returns>
  20. <see cref="T:System.Threading.Tasks.Task" />를 반환합니다.비동기 작업(operation)을 나타내는 작업(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에 정의된 close 핸드셰이크를 시작하거나 완료합니다.</summary>
  27. <returns>
  28. <see cref="T:System.Threading.Tasks.Task" />를 반환합니다.비동기 작업(operation)을 나타내는 작업(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>원격 끝점에서 close 핸드셰이크를 시작한 이유를 나타냅니다.</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" />를 반환합니다.비동기 작업(operation)을 나타내는 작업(task) 개체입니다.작업 개체의 <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" />를 반환합니다.비동기 작업(operation)을 나타내는 작업(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>알 수 없는 opcode가 포함된 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>원격 끝점에서 close 핸드셰이크를 시작한 이유를 나타냅니다.</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>원격 끝점에서 close 핸드셰이크를 시작한 이유를 설명하는 선택적 설명을 반환합니다.</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 close 핸드셰이크가 정성적으로 완료되었음을 나타냅니다.</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>