1 <?xml version="1.0" encoding="utf-8"?><doc>
3 <name>System.Net.WebSockets</name>
6 <member name="T:System.Net.WebSockets.WebSocketState">
7 <summary>Defines the different states a WebSockets instance can be in.</summary>
9 <member name="F:System.Net.WebSockets.WebSocketState.Aborted">
10 <summary>Reserved for future use.</summary>
13 <member name="F:System.Net.WebSockets.WebSocketState.Closed">
14 <summary>Indicates the WebSocket close handshake completed gracefully.</summary>
17 <member name="F:System.Net.WebSockets.WebSocketState.CloseReceived">
18 <summary>A close message was received from the remote endpoint.</summary>
21 <member name="F:System.Net.WebSockets.WebSocketState.CloseSent">
22 <summary>A close message was sent to the remote endpoint.</summary>
25 <member name="F:System.Net.WebSockets.WebSocketState.Connecting">
26 <summary>The connection is negotiating the handshake with the remote endpoint.</summary>
29 <member name="F:System.Net.WebSockets.WebSocketState.None">
30 <summary>Reserved for future use.</summary>
33 <member name="F:System.Net.WebSockets.WebSocketState.Open">
34 <summary>The initial state after the HTTP handshake has been completed.</summary>
37 <member name="T:System.Net.WebSockets.WebSocketReceiveResult">
38 <summary>An instance of this class represents the result of performing a single ReceiveAsync operation on a WebSocket.</summary>
40 <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean)">
41 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketReceiveResult"></see> class.</summary>
42 <param name="count">The number of bytes received.</param>
43 <param name="messageType">The type of message that was received.</param>
44 <param name="endOfMessage">Indicates whether this is the final message.</param>
46 <member name="M:System.Net.WebSockets.WebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Nullable{System.Net.WebSockets.WebSocketCloseStatus},System.String)">
47 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketReceiveResult"></see> class.</summary>
48 <param name="count">The number of bytes received.</param>
49 <param name="messageType">The type of message that was received.</param>
50 <param name="endOfMessage">Indicates whether this is the final message.</param>
51 <param name="closeStatus">Indicates the <see cref="T:System.Net.WebSockets.WebSocketCloseStatus"></see> of the connection.</param>
52 <param name="closeStatusDescription">The description of closeStatus.</param>
54 <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatus">
55 <summary>Indicates the reason why the remote endpoint initiated the close handshake.</summary>
56 <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketCloseStatus"></see>.</returns>
58 <member name="P:System.Net.WebSockets.WebSocketReceiveResult.CloseStatusDescription">
59 <summary>Returns the optional description that describes why the close handshake has been initiated by the remote endpoint.</summary>
60 <returns>Returns <see cref="T:System.String"></see>.</returns>
62 <member name="P:System.Net.WebSockets.WebSocketReceiveResult.Count">
63 <summary>Indicates the number of bytes that the WebSocket received.</summary>
64 <returns>Returns <see cref="T:System.Int32"></see>.</returns>
66 <member name="P:System.Net.WebSockets.WebSocketReceiveResult.EndOfMessage">
67 <summary>Indicates whether the message has been received completely.</summary>
68 <returns>Returns <see cref="T:System.Boolean"></see>.</returns>
70 <member name="P:System.Net.WebSockets.WebSocketReceiveResult.MessageType">
71 <summary>Indicates whether the current message is a UTF-8 message or a binary message.</summary>
72 <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketMessageType"></see>.</returns>
74 <member name="T:System.Net.WebSockets.WebSocketMessageType">
75 <summary>Indicates the message type.</summary>
77 <member name="F:System.Net.WebSockets.WebSocketMessageType.Binary">
78 <summary>The message is in binary format.</summary>
81 <member name="F:System.Net.WebSockets.WebSocketMessageType.Close">
82 <summary>A receive has completed because a close message was received.</summary>
85 <member name="F:System.Net.WebSockets.WebSocketMessageType.Text">
86 <summary>The message is clear text.</summary>
89 <member name="T:System.Net.WebSockets.WebSocketException">
90 <summary>Represents an exception that occurred when performing an operation on a WebSocket connection.</summary>
92 <member name="M:System.Net.WebSockets.WebSocketException.#ctor">
93 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
95 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String,System.Exception)">
96 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
97 <param name="error">The error from the WebSocketError enumeration.</param>
98 <param name="nativeError">The native error code for the exception.</param>
99 <param name="message">The description of the error.</param>
100 <param name="innerException">Indicates the previous exception that led to the current exception.</param>
102 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String,System.Exception)">
103 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
104 <param name="error">The error from the WebSocketError enumeration.</param>
105 <param name="message">The description of the error.</param>
106 <param name="innerException">Indicates the previous exception that led to the current exception.</param>
108 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.String)">
109 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
110 <param name="error">The error from the WebSocketError enumeration.</param>
111 <param name="nativeError">The native error code for the exception.</param>
112 <param name="message">The description of the error.</param>
114 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32,System.Exception)">
115 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
116 <param name="error">The error from the WebSocketError enumeration.</param>
117 <param name="nativeError">The native error code for the exception.</param>
118 <param name="innerException">Indicates the previous exception that led to the current exception.</param>
120 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String,System.Exception)">
121 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
122 <param name="message">The description of the error.</param>
123 <param name="innerException">Indicates the previous exception that led to the current exception.</param>
125 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Int32)">
126 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
127 <param name="error">The error from the WebSocketError enumeration.</param>
128 <param name="nativeError">The native error code for the exception.</param>
130 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.String)">
131 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
132 <param name="error">The error from the WebSocketError enumeration.</param>
133 <param name="message">The description of the error.</param>
135 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.String)">
136 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
137 <param name="nativeError">The native error code for the exception.</param>
138 <param name="message">The description of the error.</param>
140 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32,System.Exception)">
141 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
142 <param name="nativeError">The native error code for the exception.</param>
143 <param name="innerException">Indicates the previous exception that led to the current exception.</param>
145 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.String)">
146 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
147 <param name="message">The description of the error.</param>
149 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError)">
150 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
151 <param name="error">The error from the WebSocketError enumeration.</param>
153 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Int32)">
154 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
155 <param name="nativeError">The native error code for the exception.</param>
157 <member name="M:System.Net.WebSockets.WebSocketException.#ctor(System.Net.WebSockets.WebSocketError,System.Exception)">
158 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketException"></see> class.</summary>
159 <param name="error">The error from the WebSocketError enumeration.</param>
160 <param name="innerException">Indicates the previous exception that led to the current exception.</param>
162 <member name="P:System.Net.WebSockets.WebSocketException.ErrorCode">
163 <summary>The native error code for the exception that occurred.</summary>
164 <returns>Returns <see cref="T:System.Int32"></see>.</returns>
166 <member name="M:System.Net.WebSockets.WebSocketException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
167 <summary>Sets the SerializationInfo object with the file name and line number where the exception occurred.</summary>
168 <param name="info">A SerializationInfo object.</param>
169 <param name="context">The contextual information about the source or destination.</param>
171 <member name="P:System.Net.WebSockets.WebSocketException.WebSocketErrorCode">
172 <summary>Returns a WebSocketError indicating the type of error that occurred.</summary>
173 <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketError"></see>.</returns>
175 <member name="T:System.Net.WebSockets.WebSocketError">
176 <summary>Contains the list of possible WebSocket errors.</summary>
178 <member name="F:System.Net.WebSockets.WebSocketError.ConnectionClosedPrematurely">
179 <summary>Indicates that the connection was terminated unexpectedly.</summary>
182 <member name="F:System.Net.WebSockets.WebSocketError.Faulted">
183 <summary>Indicates a general error.</summary>
186 <member name="F:System.Net.WebSockets.WebSocketError.HeaderError">
187 <summary>Indicates an error occurred when parsing the HTTP headers during the opening handshake.</summary>
190 <member name="F:System.Net.WebSockets.WebSocketError.InvalidMessageType">
191 <summary>Indicates that a WebSocket frame with an unknown opcode was received.</summary>
194 <member name="F:System.Net.WebSockets.WebSocketError.InvalidState">
195 <summary>Indicates the WebSocket is an invalid state for the given operation (such as being closed or aborted).</summary>
198 <member name="F:System.Net.WebSockets.WebSocketError.NativeError">
199 <summary>Indicates that an unknown native error occurred.</summary>
202 <member name="F:System.Net.WebSockets.WebSocketError.NotAWebSocket">
203 <summary>Indicates that the incoming request was not a valid websocket request.</summary>
206 <member name="F:System.Net.WebSockets.WebSocketError.Success">
207 <summary>Indicates that there was no native error information for the exception.</summary>
210 <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedProtocol">
211 <summary>Indicates that the client requested an unsupported WebSocket subprotocol.</summary>
214 <member name="F:System.Net.WebSockets.WebSocketError.UnsupportedVersion">
215 <summary>Indicates that the client requested an unsupported version of the WebSocket protocol.</summary>
218 <member name="T:System.Net.WebSockets.WebSocketContext">
219 <summary>Used for accessing the information in the WebSocket handshake.</summary>
221 <member name="M:System.Net.WebSockets.WebSocketContext.#ctor">
222 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketContext"></see> class.</summary>
224 <member name="P:System.Net.WebSockets.WebSocketContext.CookieCollection">
225 <summary>The cookies that were passed to the server during the opening handshake.</summary>
226 <returns>Returns <see cref="T:System.Net.CookieCollection"></see>.</returns>
228 <member name="P:System.Net.WebSockets.WebSocketContext.Headers">
229 <summary>The HTTP headers that were sent to the server during the opening handshake.</summary>
230 <returns>Returns <see cref="T:System.Collections.Specialized.NameValueCollection"></see>.</returns>
232 <member name="P:System.Net.WebSockets.WebSocketContext.IsAuthenticated">
233 <summary>Whether the WebSocket client is authenticated.</summary>
234 <returns>Returns <see cref="T:System.Boolean"></see>.</returns>
236 <member name="P:System.Net.WebSockets.WebSocketContext.IsLocal">
237 <summary>Whether the WebSocket client connected from the local machine.</summary>
238 <returns>Returns <see cref="T:System.Boolean"></see>.</returns>
240 <member name="P:System.Net.WebSockets.WebSocketContext.IsSecureConnection">
241 <summary>Whether the WebSocket connection is secured using Secure Sockets Layer (SSL).</summary>
242 <returns>Returns <see cref="T:System.Boolean"></see>.</returns>
244 <member name="P:System.Net.WebSockets.WebSocketContext.Origin">
245 <summary>The value of the Origin HTTP header included in the opening handshake.</summary>
246 <returns>Returns <see cref="T:System.String"></see>.</returns>
248 <member name="P:System.Net.WebSockets.WebSocketContext.RequestUri">
249 <summary>The URI requested by the WebSocket client.</summary>
250 <returns>Returns <see cref="T:System.Uri"></see>.</returns>
252 <member name="P:System.Net.WebSockets.WebSocketContext.SecWebSocketKey">
253 <summary>The value of the SecWebSocketKey HTTP header included in the opening handshake.</summary>
254 <returns>Returns <see cref="T:System.String"></see>.</returns>
256 <member name="P:System.Net.WebSockets.WebSocketContext.SecWebSocketProtocols">
257 <summary>The value of the SecWebSocketKey HTTP header included in the opening handshake.</summary>
258 <returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1"></see>.</returns>
260 <member name="P:System.Net.WebSockets.WebSocketContext.SecWebSocketVersion">
261 <summary>The list of subprotocols requested by the WebSocket client.</summary>
262 <returns>Returns <see cref="T:System.String"></see>.</returns>
264 <member name="P:System.Net.WebSockets.WebSocketContext.User">
265 <summary>An object used to obtain identity, authentication information, and security roles for the WebSocket client.</summary>
266 <returns>Returns <see cref="T:System.Security.Principal.IPrincipal"></see>.</returns>
268 <member name="P:System.Net.WebSockets.WebSocketContext.WebSocket">
269 <summary>The WebSocket instance used to interact (send/receive/close/etc) with the WebSocket connection.</summary>
270 <returns>Returns <see cref="T:System.Net.WebSockets.WebSocket"></see>.</returns>
272 <member name="T:System.Net.WebSockets.WebSocketCloseStatus">
273 <summary>Represents well known WebSocket close codes as defined in section 11.7 of the WebSocket protocol spec.</summary>
275 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.Empty">
276 <summary>No error specified.</summary>
279 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.EndpointUnavailable">
280 <summary>(1001) Indicates an endpoint is being removed. Either the server or client will become unavailable.</summary>
283 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InternalServerError">
284 <summary>The connection will be closed by the server because of an error on the server.</summary>
287 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidMessageType">
288 <summary>(1003) The client or server is terminating the connection because it cannot accept the data type it received.</summary>
291 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.InvalidPayloadData">
292 <summary>(1007) The client or server is terminating the connection because it has received data inconsistent with the message type.</summary>
295 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MandatoryExtension">
296 <summary>(1010) The client is terminating the connection because it expected the server to negotiate an extension.</summary>
299 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.MessageTooBig">
300 <summary>(1004) Reserved for future use.</summary>
303 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.NormalClosure">
304 <summary>(1000) The connection has closed after the request was fulfilled.</summary>
307 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.PolicyViolation">
308 <summary>(1008) The connection will be closed because an endpoint has received a message that violates its policy.</summary>
311 <member name="F:System.Net.WebSockets.WebSocketCloseStatus.ProtocolError">
312 <summary>(1002) The client or server is terminating the connection because of a protocol error.</summary>
315 <member name="T:System.Net.WebSockets.WebSocket">
316 <summary>The WebSocket class allows applications to send and receive data after the WebSocket upgrade has completed.</summary>
318 <member name="M:System.Net.WebSockets.WebSocket.#ctor">
319 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocket"></see> class.</summary>
321 <member name="M:System.Net.WebSockets.WebSocket.Abort">
322 <summary>Aborts the WebSocket connection and cancels any pending IO operations.</summary>
324 <member name="M:System.Net.WebSockets.WebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
325 <summary>Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the WebSocket protocol specification section 7.</summary>
326 <param name="closeStatus">Indicates the reason for closing the WebSocket connection.</param>
327 <param name="statusDescription">Specifies a human readable explanation as to why the connection is closed.</param>
328 <param name="cancellationToken">The token that can be used to propagate notification that operations should be canceled.</param>
329 <returns>Returns <see cref="T:System.Threading.Tasks.Task"></see>.
330 The task object representing the asynchronous operation.</returns>
332 <member name="M:System.Net.WebSockets.WebSocket.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
333 <summary>Initiates or completes the close handshake defined in the WebSocket protocol specification section 7.</summary>
334 <param name="closeStatus">Indicates the reason for closing the WebSocket connection.</param>
335 <param name="statusDescription">Allows applications to specify a human readable explanation as to why the connection is closed.</param>
336 <param name="cancellationToken">The token that can be used to propagate notification that operations should be canceled.</param>
337 <returns>Returns <see cref="T:System.Threading.Tasks.Task"></see>.
338 The task object representing the asynchronous operation.</returns>
340 <member name="P:System.Net.WebSockets.WebSocket.CloseStatus">
341 <summary>Indicates the reason why the remote endpoint initiated the close handshake.</summary>
342 <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketCloseStatus"></see>.</returns>
344 <member name="P:System.Net.WebSockets.WebSocket.CloseStatusDescription">
345 <summary>Allows the remote endpoint to describe the reason why the connection was closed.</summary>
346 <returns>Returns <see cref="T:System.String"></see>.</returns>
348 <member name="M:System.Net.WebSockets.WebSocket.CreateClientBuffer(System.Int32,System.Int32)">
349 <summary>Create client buffers to use with this <see cref="T:System.Net.WebSockets.WebSocket"></see> instance.</summary>
350 <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
351 <param name="sendBufferSize">The size, in bytes, of the send buffer.</param>
352 <returns>Returns <see cref="T:System.ArraySegment`1"></see>.
353 An array with the client buffers.</returns>
355 <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})">
356 <summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.
357 Allows callers to create a client side WebSocket class which will use the WSPC for framing purposes.</summary>
358 <param name="innerStream">The connection to be used for IO operations.</param>
359 <param name="subProtocol">The subprotocol accepted by the client.</param>
360 <param name="receiveBufferSize">The size in bytes of the client WebSocket receive buffer.</param>
361 <param name="sendBufferSize">The size in bytes of the client WebSocket send buffer.</param>
362 <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>
363 <param name="useZeroMaskingKey">Indicates whether a random key or a static key (just zeros) should be used for the WebSocket masking.</param>
364 <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>
365 <returns>Returns <see cref="T:System.Net.WebSockets.WebSocket"></see>.</returns>
367 <member name="M:System.Net.WebSockets.WebSocket.CreateFromStream(System.IO.Stream,System.Boolean,System.String,System.TimeSpan)">
368 <param name="stream"></param>
369 <param name="isServer"></param>
370 <param name="subProtocol"></param>
371 <param name="keepAliveInterval"></param>
374 <member name="M:System.Net.WebSockets.WebSocket.CreateServerBuffer(System.Int32)">
375 <summary>Creates a WebSocket server buffer.</summary>
376 <param name="receiveBufferSize">The size, in bytes, of the desired buffer.</param>
377 <returns>Returns <see cref="T:System.ArraySegment`1"></see>.</returns>
379 <member name="P:System.Net.WebSockets.WebSocket.DefaultKeepAliveInterval">
380 <summary>Gets the default WebSocket protocol keep-alive interval in milliseconds.</summary>
381 <returns>Returns <see cref="T:System.TimeSpan"></see>.
382 The default WebSocket protocol keep-alive interval in milliseconds. The typical value for this interval is 30 seconds.</returns>
384 <member name="M:System.Net.WebSockets.WebSocket.Dispose">
385 <summary>Used to clean up unmanaged resources for ASP.NET and self-hosted implementations.</summary>
387 <member name="M:System.Net.WebSockets.WebSocket.IsApplicationTargeting45">
388 <summary>Returns a value that indicates if the WebSocket instance is targeting .NET Framework 4.5.</summary>
389 <returns>Returns <see cref="T:System.Boolean"></see>.
390 <see langword="true"></see> if the <see cref="T:System.Net.WebSockets.WebSocket"></see> is targeting .NET Framework 4.5; otherwise <see langword="false"></see>.</returns>
392 <member name="M:System.Net.WebSockets.WebSocket.IsStateTerminal(System.Net.WebSockets.WebSocketState)">
393 <summary>Returns a value that indicates if the state of the WebSocket instance is closed or aborted.</summary>
394 <param name="state">The current state of the WebSocket.</param>
395 <returns>Returns <see cref="T:System.Boolean"></see>.
396 <see langword="true"></see> if the <see cref="T:System.Net.WebSockets.WebSocket"></see> is closed or aborted; otherwise <see langword="false"></see>.</returns>
398 <member name="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
399 <summary>Receives data from the <see cref="T:System.Net.WebSockets.WebSocket"></see> connection asynchronously.</summary>
400 <param name="buffer">References the application buffer that is the storage location for the received data.</param>
401 <param name="cancellationToken">Propagates the notification that operations should be canceled.</param>
402 <returns>Returns <see cref="T:System.Threading.Tasks.Task`1"></see>.
403 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>
405 <member name="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
406 <param name="buffer"></param>
407 <param name="cancellationToken"></param>
410 <member name="M:System.Net.WebSockets.WebSocket.RegisterPrefixes">
411 <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>
413 <member name="M:System.Net.WebSockets.WebSocket.SendAsync(System.ArraySegment{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
414 <summary>Sends data over the <see cref="T:System.Net.WebSockets.WebSocket"></see> connection asynchronously.</summary>
415 <param name="buffer">The buffer to be sent over the connection.</param>
416 <param name="messageType">Indicates whether the application is sending a binary or text message.</param>
417 <param name="endOfMessage">Indicates whether the data in &quot;buffer&quot; is the last part of a message.</param>
418 <param name="cancellationToken">The token that propagates the notification that operations should be canceled.</param>
419 <returns>The task object representing the asynchronous operation.</returns>
421 <member name="M:System.Net.WebSockets.WebSocket.SendAsync(System.ReadOnlyMemory{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
422 <param name="buffer"></param>
423 <param name="messageType"></param>
424 <param name="endOfMessage"></param>
425 <param name="cancellationToken"></param>
428 <member name="P:System.Net.WebSockets.WebSocket.State">
429 <summary>Returns the current state of the WebSocket connection.</summary>
430 <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketState"></see>.</returns>
432 <member name="P:System.Net.WebSockets.WebSocket.SubProtocol">
433 <summary>The subprotocol that was negotiated during the opening handshake.</summary>
434 <returns>Returns <see cref="T:System.String"></see>.</returns>
436 <member name="M:System.Net.WebSockets.WebSocket.ThrowOnInvalidState(System.Net.WebSockets.WebSocketState,System.Net.WebSockets.WebSocketState[])">
437 <summary>Verifies that the connection is in an expected state.</summary>
438 <param name="state">The current state of the WebSocket to be tested against the list of valid states.</param>
439 <param name="validStates">List of valid connection states.</param>
441 <member name="T:System.Net.WebSockets.ValueWebSocketReceiveResult">
444 <member name="M:System.Net.WebSockets.ValueWebSocketReceiveResult.#ctor(System.Int32,System.Net.WebSockets.WebSocketMessageType,System.Boolean)">
445 <param name="count"></param>
446 <param name="messageType"></param>
447 <param name="endOfMessage"></param>
449 <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.Count">
452 <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.EndOfMessage">
455 <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.MessageType">