Revert "PR-5360"
[platform/core/csapi/tizenfx.git] / pkg / Tizen.NET.API11 / build / tizen11.0 / ref / System.Net.WebSockets.xml
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.ValueWebSocketReceiveResult">
8       <summary>Represents the result of performing a single <see cref="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.Memory{System.Byte},System.Threading.CancellationToken)" /> operation on a <see cref="T:System.Net.WebSockets.WebSocket" />.</summary>
9     </member>
10     <member name="M:System.Net.WebSockets.ValueWebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean)">
11       <summary>Initializes a new instance of the <see cref="T:System.Net.WebSockets.ValueWebSocketReceiveResult" /> struct. An instance of this struct represents the result of performing a single <c>ReceiveAsync</c> operation on a <see cref="T:System.Net.WebSockets.WebSocket" />.</summary>
12       <param name="count">The number of bytes that the <see cref="T:System.Net.WebSockets.WebSocket" /> received.</param>
13       <param name="messageType">One of the enumeration values that indicates whether the current message is a UTF-8 message or a binary message.</param>
14       <param name="endOfMessage">
15         <see langword="true" /> to indicate the messsage has been received completely; otherwise, <see langword="false" />.</param>
16     </member>
17     <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.Count" />
18     <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.EndOfMessage" />
19     <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.MessageType" />
20     <member name="T:System.Net.WebSockets.WebSocket">
21       <summary>The WebSocket class allows applications to send and receive data after the WebSocket upgrade has completed.</summary>
22     </member>
23     <member name="M:System.Net.WebSockets.WebSocket.#ctor">
24       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocket" /> class.</summary>
25     </member>
26     <member name="M:System.Net.WebSockets.WebSocket.Abort">
27       <summary>Aborts the WebSocket connection and cancels any pending IO operations.</summary>
28     </member>
29     <member name="M:System.Net.WebSockets.WebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
30       <summary>Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the WebSocket protocol specification section 7.</summary>
31       <param name="closeStatus">Indicates the reason for closing the WebSocket connection.</param>
32       <param name="statusDescription">Specifies a human readable explanation as to why the connection is closed.</param>
33       <param name="cancellationToken">The token that can be used to propagate notification that operations should be canceled.</param>
34       <returns>The task object representing the asynchronous operation.</returns>
35     </member>
36     <member name="M:System.Net.WebSockets.WebSocket.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
37       <summary>Initiates or completes the close handshake defined in the WebSocket protocol specification section 7.</summary>
38       <param name="closeStatus">Indicates the reason for closing the WebSocket connection.</param>
39       <param name="statusDescription">Allows applications to specify a human readable explanation as to why the connection is closed.</param>
40       <param name="cancellationToken">The token that can be used to propagate notification that operations should be canceled.</param>
41       <returns>The task object representing the asynchronous operation.</returns>
42     </member>
43     <member name="P:System.Net.WebSockets.WebSocket.CloseStatus">
44       <summary>Indicates the reason why the remote endpoint initiated the close handshake.</summary>
45       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" />.</returns>
46     </member>
47     <member name="P:System.Net.WebSockets.WebSocket.CloseStatusDescription">
48       <summary>Allows the remote endpoint to describe the reason why the connection was closed.</summary>
49       <returns>Returns <see cref="T:System.String" />.</returns>
50     </member>
51     <member name="M:System.Net.WebSockets.WebSocket.CreateClientBuffer(System.Int32,System.Int32)">
52       <summary>Create client buffers to use with this <see cref="T:System.Net.WebSockets.WebSocket" /> instance.</summary>
53       <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
54       <param name="sendBufferSize">The size, in bytes, of the send buffer.</param>
55       <returns>An array with the client buffers.</returns>
56     </member>
57     <member name="M:System.Net.WebSockets.WebSocket.CreateClientWebSocket(System.IO.Stream,System.String,System.Int32,System.Int32,System.TimeSpan,System.Boolean,System.ArraySegment{System.Byte})">
58       <summary>Allows callers to create a client side WebSocket class which will use the WSPC for framing purposes.</summary>
59       <param name="innerStream">The connection to be used for IO operations.</param>
60       <param name="subProtocol">The subprotocol accepted by the client.</param>
61       <param name="receiveBufferSize">The size in bytes of the client WebSocket receive buffer.</param>
62       <param name="sendBufferSize">The size in bytes of the client WebSocket send buffer.</param>
63       <param name="keepAliveInterval">Determines how regularly a frame is sent over the connection as a keep-alive. Applies only when the connection is idle.</param>
64       <param name="useZeroMaskingKey">Indicates whether a random key or a static key (just zeros) should be used for the WebSocket masking.</param>
65       <param name="internalBuffer">Will be used as the internal buffer in the WPC. The size has to be at least <c>2 * ReceiveBufferSize + SendBufferSize + 256 + 20 (16 on 32-bit)</c>.</param>
66       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocket" />.</returns>
67     </member>
68     <member name="M:System.Net.WebSockets.WebSocket.CreateFromStream(System.IO.Stream,System.Boolean,System.String,System.TimeSpan)">
69       <summary>Creates a new <see cref="T:System.Net.WebSockets.WebSocket" /> object that operates on the specified stream, which represents a web socket connection.</summary>
70       <param name="stream">The stream for the connection.</param>
71       <param name="isServer">
72         <see langword="true" /> to indicate it's the server-side of the connection; <see langword="false" /> if it's the client-side.</param>
73       <param name="subProtocol">The agreed upon sub-protocol that was used when creating the connection.</param>
74       <param name="keepAliveInterval">The keep-alive interval to use, or <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to disable keep-alives.</param>
75       <returns>The new web socket.</returns>
76     </member>
77     <member name="M:System.Net.WebSockets.WebSocket.CreateServerBuffer(System.Int32)">
78       <summary>Creates a WebSocket server buffer.</summary>
79       <param name="receiveBufferSize">The size, in bytes, of the desired buffer.</param>
80       <returns>Returns <see cref="T:System.ArraySegment`1" />.</returns>
81     </member>
82     <member name="P:System.Net.WebSockets.WebSocket.DefaultKeepAliveInterval">
83       <summary>Gets the default WebSocket protocol keep-alive interval.</summary>
84       <returns>The default WebSocket protocol keep-alive interval. The typical value for this interval is 30 seconds (as defined by the OS or the .NET platform). It is used to initialize <see cref="P:System.Net.WebSockets.ClientWebSocketOptions.KeepAliveInterval" /> value.</returns>
85     </member>
86     <member name="M:System.Net.WebSockets.WebSocket.Dispose">
87       <summary>Used to clean up unmanaged resources for ASP.NET and self-hosted implementations.</summary>
88     </member>
89     <member name="M:System.Net.WebSockets.WebSocket.IsApplicationTargeting45">
90       <summary>Returns a value that indicates if the WebSocket instance is targeting .NET Framework 4.5.</summary>
91       <returns>
92         <see langword="true" /> if the <see cref="T:System.Net.WebSockets.WebSocket" /> is targeting .NET Framework 4.5; otherwise, <see langword="false" />.</returns>
93     </member>
94     <member name="M:System.Net.WebSockets.WebSocket.IsStateTerminal(System.Net.WebSockets.WebSocketState)">
95       <summary>Returns a value that indicates if the state of the WebSocket instance is closed or aborted.</summary>
96       <param name="state">The current state of the WebSocket.</param>
97       <returns>
98         <see langword="true" /> if the <see cref="T:System.Net.WebSockets.WebSocket" /> is closed or aborted; otherwise, <see langword="false" />.</returns>
99     </member>
100     <member name="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
101       <summary>Receives data from the <see cref="T:System.Net.WebSockets.WebSocket" /> connection asynchronously.</summary>
102       <param name="buffer">References the application buffer that is the storage location for the received data.</param>
103       <param name="cancellationToken">Propagates the notification that operations should be canceled.</param>
104       <returns>The task object representing the asynchronous operation. The <see cref="P:System.Threading.Tasks.Task`1.Result" /> property on the task object returns a <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" /> object that represents the received data.</returns>
105     </member>
106     <member name="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
107       <param name="buffer" />
108       <param name="cancellationToken" />
109     </member>
110     <member name="M:System.Net.WebSockets.WebSocket.RegisterPrefixes">
111       <summary>Allows callers to register prefixes for WebSocket requests (ws and wss).</summary>
112     </member>
113     <member name="M:System.Net.WebSockets.WebSocket.SendAsync(System.ArraySegment{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
114       <summary>Sends data over the <see cref="T:System.Net.WebSockets.WebSocket" /> connection asynchronously.</summary>
115       <param name="buffer">The buffer to be sent over the connection.</param>
116       <param name="messageType">Indicates whether the application is sending a binary or text message.</param>
117       <param name="endOfMessage">Indicates whether the data in "buffer" is the last part of a message.</param>
118       <param name="cancellationToken">The token that propagates the notification that operations should be canceled.</param>
119       <returns>The task object representing the asynchronous operation.</returns>
120     </member>
121     <member name="M:System.Net.WebSockets.WebSocket.SendAsync(System.ReadOnlyMemory{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
122       <param name="buffer" />
123       <param name="messageType" />
124       <param name="endOfMessage" />
125       <param name="cancellationToken" />
126     </member>
127     <member name="P:System.Net.WebSockets.WebSocket.State">
128       <summary>Returns the current state of the WebSocket connection.</summary>
129       <returns>The current state of the WebSocket connection.</returns>
130     </member>
131     <member name="P:System.Net.WebSockets.WebSocket.SubProtocol">
132       <summary>Gets the subprotocol that was negotiated during the opening handshake.</summary>
133       <returns>The subprotocol that was negotiated during the opening handshake.</returns>
134     </member>
135     <member name="M:System.Net.WebSockets.WebSocket.ThrowOnInvalidState(System.Net.WebSockets.WebSocketState,System.Net.WebSockets.WebSocketState[])">
136       <summary>Verifies that the connection is in an expected state.</summary>
137       <param name="state">The current state of the WebSocket to be tested against the list of valid states.</param>
138       <param name="validStates">List of valid connection states.</param>
139     </member>
140     <member name="T:System.Net.WebSockets.WebSocketCloseStatus">
141       <summary>Represents well known WebSocket close codes as defined in section 11.7 of the WebSocket protocol spec.</summary>
142     </member>
143     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.Empty">
144       <summary>No error specified.</summary>
145     </member>
146     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.EndpointUnavailable">
147       <summary>(1001) Indicates an endpoint is being removed. Either the server or client will become unavailable.</summary>
148     </member>
149     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InternalServerError">
150       <summary>(1011) The connection will be closed by the server because of an error on the server.</summary>
151     </member>
152     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidMessageType">
153       <summary>(1003) The client or server is terminating the connection because it cannot accept the data type it received.</summary>
154     </member>
155     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidPayloadData">
156       <summary>(1007) The client or server is terminating the connection because it has received data inconsistent with the message type.</summary>
157     </member>
158     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MandatoryExtension">
159       <summary>(1010) The client is terminating the connection because it expected the server to negotiate an extension.</summary>
160     </member>
161     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MessageTooBig">
162       <summary>(1009) The client or server is terminating the connection because it has received a message that is too big for it to process.</summary>
163     </member>
164     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.NormalClosure">
165       <summary>(1000) The connection has closed after the request was fulfilled.</summary>
166     </member>
167     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.PolicyViolation">
168       <summary>(1008) The connection will be closed because an endpoint has received a message that violates its policy.</summary>
169     </member>
170     <member name="F:System.Net.WebSockets.WebSocketCloseStatus.ProtocolError">
171       <summary>(1002) The client or server is terminating the connection because of a protocol error.</summary>
172     </member>
173     <member name="T:System.Net.WebSockets.WebSocketContext">
174       <summary>Used for accessing the information in the WebSocket handshake.</summary>
175     </member>
176     <member name="M:System.Net.WebSockets.WebSocketContext.#ctor">
177       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketContext" /> class.</summary>
178     </member>
179     <member name="P:System.Net.WebSockets.WebSocketContext.CookieCollection">
180       <summary>The cookies that were passed to the server during the opening handshake.</summary>
181       <returns>Returns <see cref="T:System.Net.CookieCollection" />.</returns>
182     </member>
183     <member name="P:System.Net.WebSockets.WebSocketContext.Headers">
184       <summary>The HTTP headers that were sent to the server during the opening handshake.</summary>
185       <returns>Returns <see cref="T:System.Collections.Specialized.NameValueCollection" />.</returns>
186     </member>
187     <member name="P:System.Net.WebSockets.WebSocketContext.IsAuthenticated">
188       <summary>Whether the WebSocket client is authenticated.</summary>
189       <returns>Returns <see cref="T:System.Boolean" />.</returns>
190     </member>
191     <member name="P:System.Net.WebSockets.WebSocketContext.IsLocal">
192       <summary>Whether the WebSocket client connected from the local machine.</summary>
193       <returns>Returns <see cref="T:System.Boolean" />.</returns>
194     </member>
195     <member name="P:System.Net.WebSockets.WebSocketContext.IsSecureConnection">
196       <summary>Whether the WebSocket connection is secured using Secure Sockets Layer (SSL).</summary>
197       <returns>Returns <see cref="T:System.Boolean" />.</returns>
198     </member>
199     <member name="P:System.Net.WebSockets.WebSocketContext.Origin">
200       <summary>The value of the Origin HTTP header included in the opening handshake.</summary>
201       <returns>Returns <see cref="T:System.String" />.</returns>
202     </member>
203     <member name="P:System.Net.WebSockets.WebSocketContext.RequestUri">
204       <summary>The URI requested by the WebSocket client.</summary>
205       <returns>Returns <see cref="T:System.Uri" />.</returns>
206     </member>
207     <member name="P:System.Net.WebSockets.WebSocketContext.SecWebSocketKey">
208       <summary>The value of the SecWebSocketKey HTTP header included in the opening handshake.</summary>
209       <returns>Returns <see cref="T:System.String" />.</returns>
210     </member>
211     <member name="P:System.Net.WebSockets.WebSocketContext.SecWebSocketProtocols">
212       <summary>The value of the SecWebSocketKey HTTP header included in the opening handshake.</summary>
213       <returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
214     </member>
215     <member name="P:System.Net.WebSockets.WebSocketContext.SecWebSocketVersion">
216       <summary>The list of subprotocols requested by the WebSocket client.</summary>
217       <returns>Returns <see cref="T:System.String" />.</returns>
218     </member>
219     <member name="P:System.Net.WebSockets.WebSocketContext.User">
220       <summary>An object used to obtain identity, authentication information, and security roles for the WebSocket client.</summary>
221       <returns>Returns <see cref="T:System.Security.Principal.IPrincipal" />.</returns>
222     </member>
223     <member name="P:System.Net.WebSockets.WebSocketContext.WebSocket">
224       <summary>The WebSocket instance used to interact (send/receive/close/etc) with the WebSocket connection.</summary>
225       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocket" />.</returns>
226     </member>
227     <member name="T:System.Net.WebSockets.WebSocketError">
228       <summary>Contains the list of possible WebSocket errors.</summary>
229     </member>
230     <member name="F:System.Net.WebSockets.WebSocketError.ConnectionClosedPrematurely">
231       <summary>Indicates that the connection was terminated unexpectedly.</summary>
232     </member>
233     <member name="F:System.Net.WebSockets.WebSocketError.Faulted">
234       <summary>Indicates a general error.</summary>
235     </member>
236     <member name="F:System.Net.WebSockets.WebSocketError.HeaderError">
237       <summary>Indicates an error occurred when parsing the HTTP headers during the opening handshake.</summary>
238     </member>
239     <member name="F:System.Net.WebSockets.WebSocketError.InvalidMessageType">
240       <summary>Indicates that a WebSocket frame with an unknown opcode was received.</summary>
241     </member>
242     <member name="F:System.Net.WebSockets.WebSocketError.InvalidState">
243       <summary>Indicates the WebSocket is an invalid state for the given operation (such as being closed or aborted).</summary>
244     </member>
245     <member name="F:System.Net.WebSockets.WebSocketError.NativeError">
246       <summary>Indicates that an unknown native error occurred.</summary>
247     </member>
248     <member name="F:System.Net.WebSockets.WebSocketError.NotAWebSocket">
249       <summary>Indicates that the incoming request was not a valid websocket request.</summary>
250     </member>
251     <member name="F:System.Net.WebSockets.WebSocketError.Success">
252       <summary>Indicates that there was no native error information for the exception.</summary>
253     </member>
254     <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedProtocol">
255       <summary>Indicates that the client requested an unsupported WebSocket subprotocol.</summary>
256     </member>
257     <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedVersion">
258       <summary>Indicates that the client requested an unsupported version of the WebSocket protocol.</summary>
259     </member>
260     <member name="T:System.Net.WebSockets.WebSocketException">
261       <summary>Represents an exception that occurred when performing an operation on a WebSocket connection.</summary>
262     </member>
263     <member name="M:System.Net.WebSockets.WebSocketException.#ctor">
264       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
265     </member>
266     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32)">
267       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
268       <param name="nativeError">The native error code for the exception.</param>
269     </member>
270     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.Exception)">
271       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
272       <param name="nativeError">The native error code for the exception.</param>
273       <param name="innerException">Indicates the previous exception that led to the current exception.</param>
274     </member>
275     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.String)">
276       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
277       <param name="nativeError">The native error code for the exception.</param>
278       <param name="message">The description of the error.</param>
279     </member>
280     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError)">
281       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
282       <param name="error">The error from the WebSocketError enumeration.</param>
283     </member>
284     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Exception)">
285       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
286       <param name="error">The error from the WebSocketError enumeration.</param>
287       <param name="innerException">Indicates the previous exception that led to the current exception.</param>
288     </member>
289     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32)">
290       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
291       <param name="error">The error from the WebSocketError enumeration.</param>
292       <param name="nativeError">The native error code for the exception.</param>
293     </member>
294     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.Exception)">
295       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
296       <param name="error">The error from the WebSocketError enumeration.</param>
297       <param name="nativeError">The native error code for the exception.</param>
298       <param name="innerException">Indicates the previous exception that led to the current exception.</param>
299     </member>
300     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String)">
301       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
302       <param name="error">The error from the WebSocketError enumeration.</param>
303       <param name="nativeError">The native error code for the exception.</param>
304       <param name="message">The description of the error.</param>
305     </member>
306     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String,System.Exception)">
307       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
308       <param name="error">The error from the WebSocketError enumeration.</param>
309       <param name="nativeError">The native error code for the exception.</param>
310       <param name="message">The description of the error.</param>
311       <param name="innerException">Indicates the previous exception that led to the current exception.</param>
312     </member>
313     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String)">
314       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
315       <param name="error">The error from the WebSocketError enumeration.</param>
316       <param name="message">The description of the error.</param>
317     </member>
318     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String,System.Exception)">
319       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
320       <param name="error">The error from the WebSocketError enumeration.</param>
321       <param name="message">The description of the error.</param>
322       <param name="innerException">Indicates the previous exception that led to the current exception.</param>
323     </member>
324     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String)">
325       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
326       <param name="message">The description of the error.</param>
327     </member>
328     <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String,System.Exception)">
329       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException" /> class.</summary>
330       <param name="message">The description of the error.</param>
331       <param name="innerException">Indicates the previous exception that led to the current exception.</param>
332     </member>
333     <member name="P:System.Net.WebSockets.WebSocketException.ErrorCode">
334       <summary>The native error code for the exception that occurred.</summary>
335       <returns>Returns <see cref="T:System.Int32" />.</returns>
336     </member>
337     <member name="M:System.Net.WebSockets.WebSocketException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
338       <summary>Sets the SerializationInfo object with the file name and line number where the exception occurred.</summary>
339       <param name="info">A SerializationInfo object.</param>
340       <param name="context">The contextual information about the source or destination.</param>
341     </member>
342     <member name="P:System.Net.WebSockets.WebSocketException.WebSocketErrorCode">
343       <summary>Returns a WebSocketError indicating the type of error that occurred.</summary>
344       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketError" />.</returns>
345     </member>
346     <member name="T:System.Net.WebSockets.WebSocketMessageType">
347       <summary>Indicates the message type.</summary>
348     </member>
349     <member name="F:System.Net.WebSockets.WebSocketMessageType.Binary">
350       <summary>The message is in binary format.</summary>
351     </member>
352     <member name="F:System.Net.WebSockets.WebSocketMessageType.Close">
353       <summary>A receive has completed because a close message was received.</summary>
354     </member>
355     <member name="F:System.Net.WebSockets.WebSocketMessageType.Text">
356       <summary>The message is clear text.</summary>
357     </member>
358     <member name="T:System.Net.WebSockets.WebSocketReceiveResult">
359       <summary>An instance of this class represents the result of performing a single ReceiveAsync operation on a WebSocket.</summary>
360     </member>
361     <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean)">
362       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" /> class.</summary>
363       <param name="count">The number of bytes received.</param>
364       <param name="messageType">The type of message that was received.</param>
365       <param name="endOfMessage">Indicates whether this is the final message.</param>
366     </member>
367     <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Nullable{System.Net.WebSockets.WebSocketCloseStatus},System.String)">
368       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketReceiveResult" /> class.</summary>
369       <param name="count">The number of bytes received.</param>
370       <param name="messageType">The type of message that was received.</param>
371       <param name="endOfMessage">Indicates whether this is the final message.</param>
372       <param name="closeStatus">Indicates the <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" /> of the connection.</param>
373       <param name="closeStatusDescription">The description of <paramref name="closeStatus" />.</param>
374     </member>
375     <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatus">
376       <summary>Indicates the reason why the remote endpoint initiated the close handshake.</summary>
377       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" />.</returns>
378     </member>
379     <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatusDescription">
380       <summary>Returns the optional description that describes why the close handshake has been initiated by the remote endpoint.</summary>
381       <returns>Returns <see cref="T:System.String" />.</returns>
382     </member>
383     <member name="P:System.Net.WebSockets.WebSocketReceiveResult.Count">
384       <summary>Indicates the number of bytes that the WebSocket received.</summary>
385       <returns>Returns <see cref="T:System.Int32" />.</returns>
386     </member>
387     <member name="P:System.Net.WebSockets.WebSocketReceiveResult.EndOfMessage">
388       <summary>Indicates whether the message has been received completely.</summary>
389       <returns>Returns <see cref="T:System.Boolean" />.</returns>
390     </member>
391     <member name="P:System.Net.WebSockets.WebSocketReceiveResult.MessageType">
392       <summary>Indicates whether the current message is a UTF-8 message or a binary message.</summary>
393       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketMessageType" />.</returns>
394     </member>
395     <member name="T:System.Net.WebSockets.WebSocketState">
396       <summary>Defines the different states a WebSockets instance can be in.</summary>
397     </member>
398     <member name="F:System.Net.WebSockets.WebSocketState.Aborted">
399       <summary>Reserved for future use.</summary>
400     </member>
401     <member name="F:System.Net.WebSockets.WebSocketState.Closed">
402       <summary>Indicates the WebSocket close handshake completed gracefully.</summary>
403     </member>
404     <member name="F:System.Net.WebSockets.WebSocketState.CloseReceived">
405       <summary>A close message was received from the remote endpoint.</summary>
406     </member>
407     <member name="F:System.Net.WebSockets.WebSocketState.CloseSent">
408       <summary>A close message was sent to the remote endpoint.</summary>
409     </member>
410     <member name="F:System.Net.WebSockets.WebSocketState.Connecting">
411       <summary>The connection is negotiating the handshake with the remote endpoint.</summary>
412     </member>
413     <member name="F:System.Net.WebSockets.WebSocketState.None">
414       <summary>Reserved for future use.</summary>
415     </member>
416     <member name="F:System.Net.WebSockets.WebSocketState.Open">
417       <summary>The initial state after the HTTP handshake has been completed.</summary>
418     </member>
419   </members>
420 </doc>