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