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