<param name="endOfMessage">
<see langword="true" /> to indicate the messsage has been received completely; otherwise, <see langword="false" />.</param>
</member>
- <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.Count">
- <summary>Gets the number of bytes that the <see cref="T:System.Net.WebSockets.WebSocket" /> received.</summary>
- <returns>The number of bytes that the <see cref="T:System.Net.WebSockets.WebSocket" /> received.</returns>
- </member>
- <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.EndOfMessage">
- <summary>Gets whether the message has been received completely.</summary>
- <returns>
- <see langword="true" /> if the message was received completely; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.MessageType">
- <summary>Gets the type of the current message.</summary>
- <returns>One of the enumeration values that specifies if the current message is a UTF-8, binary, or close message.</returns>
- </member>
+ <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.Count" />
+ <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.EndOfMessage" />
+ <member name="P:System.Net.WebSockets.ValueWebSocketReceiveResult.MessageType" />
<member name="T:System.Net.WebSockets.WebSocket">
<summary>The WebSocket class allows applications to send and receive data after the WebSocket upgrade has completed.</summary>
</member>
<param name="cancellationToken">The token that can be used to propagate notification that operations should be canceled.</param>
<returns>The task object representing the asynchronous operation.</returns>
</member>
+ <member name="P:System.Net.WebSockets.WebSocket.CloseStatus">
+ <summary>Indicates the reason why the remote endpoint initiated the close handshake.</summary>
+ <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" />.</returns>
+ </member>
+ <member name="P:System.Net.WebSockets.WebSocket.CloseStatusDescription">
+ <summary>Allows the remote endpoint to describe the reason why the connection was closed.</summary>
+ <returns>Returns <see cref="T:System.String" />.</returns>
+ </member>
<member name="M:System.Net.WebSockets.WebSocket.CreateClientBuffer(System.Int32,System.Int32)">
<summary>Create client buffers to use with this <see cref="T:System.Net.WebSockets.WebSocket" /> instance.</summary>
<param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
<param name="keepAliveInterval">The keep-alive interval to use, or <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to disable keep-alives.</param>
<returns>The new web socket.</returns>
</member>
- <member name="M:System.Net.WebSockets.WebSocket.CreateFromStream(System.IO.Stream,System.Net.WebSockets.WebSocketCreationOptions)">
- <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>
- <param name="stream">The <see cref="T:System.IO.Stream" /> for the connection.</param>
- <param name="options">The options with which the websocket must be created.</param>
- <returns>The created web socket.</returns>
- </member>
<member name="M:System.Net.WebSockets.WebSocket.CreateServerBuffer(System.Int32)">
<summary>Creates a WebSocket server buffer.</summary>
<param name="receiveBufferSize">The size, in bytes, of the desired buffer.</param>
<returns>Returns <see cref="T:System.ArraySegment`1" />.</returns>
</member>
+ <member name="P:System.Net.WebSockets.WebSocket.DefaultKeepAliveInterval">
+ <summary>Gets the default WebSocket protocol keep-alive interval.</summary>
+ <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>
+ </member>
<member name="M:System.Net.WebSockets.WebSocket.Dispose">
<summary>Used to clean up unmanaged resources for ASP.NET and self-hosted implementations.</summary>
</member>
<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>
</member>
<member name="M:System.Net.WebSockets.WebSocket.ReceiveAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
- <summary>Receives data from the <see cref="T:System.Net.WebSockets.WebSocket" /> connection asynchronously.</summary>
- <param name="buffer">The application buffer that is the storage location for the received data.</param>
- <param name="cancellationToken">The cancellation token to use to cancel the receive operation.</param>
- <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>
+ <param name="buffer" />
+ <param name="cancellationToken" />
</member>
<member name="M:System.Net.WebSockets.WebSocket.RegisterPrefixes">
<summary>Allows callers to register prefixes for WebSocket requests (ws and wss).</summary>
<returns>The task object representing the asynchronous operation.</returns>
</member>
<member name="M:System.Net.WebSockets.WebSocket.SendAsync(System.ReadOnlyMemory{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
- <summary>Sends data over the <see cref="T:System.Net.WebSockets.WebSocket" /> connection asynchronously.</summary>
- <param name="buffer">The buffer to be sent over the connection.</param>
- <param name="messageType">One of the enumeration values that indicates whether the application is sending a binary or text message.</param>
- <param name="endOfMessage">
- <see langword="true" /> to indicate the data in "buffer" is the last part of a message; otherwise, <see langword="false" />.</param>
- <param name="cancellationToken">The cancellation token to use to cancel the send operation.</param>
- <returns>The task object representing the asynchronous operation.</returns>
- </member>
- <member name="M:System.Net.WebSockets.WebSocket.SendAsync(System.ReadOnlyMemory{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Net.WebSockets.WebSocketMessageFlags,System.Threading.CancellationToken)">
- <summary>Sends data over the <see cref="T:System.Net.WebSockets.WebSocket" /> connection asynchronously.</summary>
- <param name="buffer">The buffer to be sent over the connection.</param>
- <param name="messageType">One of the enumeration values that indicates whether the application is sending a binary or text message.</param>
- <param name="messageFlags">Flags for controlling how the <see cref="T:System.Net.WebSockets.WebSocket" /> should send a message.</param>
- <param name="cancellationToken">The cancellation token to use to cancel the send operation.</param>
- <returns>The task object representing the asynchronous operation.</returns>
- </member>
- <member name="M:System.Net.WebSockets.WebSocket.ThrowOnInvalidState(System.Net.WebSockets.WebSocketState,System.Net.WebSockets.WebSocketState[])">
- <summary>Verifies that the connection is in an expected state.</summary>
- <param name="state">The current state of the WebSocket to be tested against the list of valid states.</param>
- <param name="validStates">List of valid connection states.</param>
- </member>
- <member name="P:System.Net.WebSockets.WebSocket.CloseStatus">
- <summary>Indicates the reason why the remote endpoint initiated the close handshake.</summary>
- <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketCloseStatus" />.</returns>
- </member>
- <member name="P:System.Net.WebSockets.WebSocket.CloseStatusDescription">
- <summary>Allows the remote endpoint to describe the reason why the connection was closed.</summary>
- <returns>Returns <see cref="T:System.String" />.</returns>
- </member>
- <member name="P:System.Net.WebSockets.WebSocket.DefaultKeepAliveInterval">
- <summary>Gets the default WebSocket protocol keep-alive interval.</summary>
- <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>
+ <param name="buffer" />
+ <param name="messageType" />
+ <param name="endOfMessage" />
+ <param name="cancellationToken" />
</member>
<member name="P:System.Net.WebSockets.WebSocket.State">
<summary>Returns the current state of the WebSocket connection.</summary>
<summary>Gets the subprotocol that was negotiated during the opening handshake.</summary>
<returns>The subprotocol that was negotiated during the opening handshake.</returns>
</member>
+ <member name="M:System.Net.WebSockets.WebSocket.ThrowOnInvalidState(System.Net.WebSockets.WebSocketState,System.Net.WebSockets.WebSocketState[])">
+ <summary>Verifies that the connection is in an expected state.</summary>
+ <param name="state">The current state of the WebSocket to be tested against the list of valid states.</param>
+ <param name="validStates">List of valid connection states.</param>
+ </member>
<member name="T:System.Net.WebSockets.WebSocketCloseStatus">
<summary>Represents well known WebSocket close codes as defined in section 11.7 of the WebSocket protocol spec.</summary>
</member>
<summary>The WebSocket instance used to interact (send/receive/close/etc) with the WebSocket connection.</summary>
<returns>Returns <see cref="T:System.Net.WebSockets.WebSocket" />.</returns>
</member>
- <member name="T:System.Net.WebSockets.WebSocketCreationOptions">
- <summary>Options that control how a <see cref="T:System.Net.WebSockets.WebSocket" /> is created.</summary>
- </member>
- <member name="M:System.Net.WebSockets.WebSocketCreationOptions.#ctor">
- <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketCreationOptions" /> class.</summary>
- </member>
- <member name="P:System.Net.WebSockets.WebSocketCreationOptions.DangerousDeflateOptions">
- <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.
- 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>
- </member>
- <member name="P:System.Net.WebSockets.WebSocketCreationOptions.IsServer">
- <summary>Defines if this websocket is the server-side of the connection. The default value is <see langword="false" />.</summary>
- </member>
- <member name="P:System.Net.WebSockets.WebSocketCreationOptions.KeepAliveInterval">
- <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.
- The default is <see cref="F:System.TimeSpan.Zero" />.</summary>
- </member>
- <member name="P:System.Net.WebSockets.WebSocketCreationOptions.SubProtocol">
- <summary>The agreed upon sub-protocol that was used when creating the connection.</summary>
- </member>
- <member name="T:System.Net.WebSockets.WebSocketDeflateOptions">
- <summary>Options to enable per-message deflate compression for <see cref="T:System.Net.WebSockets.WebSocket" />.</summary>
- </member>
- <member name="M:System.Net.WebSockets.WebSocketDeflateOptions.#ctor">
- <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketDeflateOptions" /> class.</summary>
- </member>
- <member name="P:System.Net.WebSockets.WebSocketDeflateOptions.ClientContextTakeover">
- <summary>When <see langword="true" /> the client-side of the connection indicates that it will persist the deflate context accross messages.
- The default is <see langword="true" />.</summary>
- </member>
- <member name="P:System.Net.WebSockets.WebSocketDeflateOptions.ClientMaxWindowBits">
- <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.
- Must be a value between 9 and 15. The default is 15.</summary>
- </member>
- <member name="P:System.Net.WebSockets.WebSocketDeflateOptions.ServerContextTakeover">
- <summary>When <see langword="true" /> the server-side of the connection indicates that it will persist the deflate context accross messages.
- The default is <see langword="true" />.</summary>
- </member>
- <member name="P:System.Net.WebSockets.WebSocketDeflateOptions.ServerMaxWindowBits">
- <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.
- Must be a value between 9 and 15. The default is 15.</summary>
- </member>
<member name="T:System.Net.WebSockets.WebSocketError">
<summary>Contains the list of possible WebSocket errors.</summary>
</member>
<param name="message">The description of the error.</param>
<param name="innerException">Indicates the previous exception that led to the current exception.</param>
</member>
+ <member name="P:System.Net.WebSockets.WebSocketException.ErrorCode">
+ <summary>The native error code for the exception that occurred.</summary>
+ <returns>Returns <see cref="T:System.Int32" />.</returns>
+ </member>
<member name="M:System.Net.WebSockets.WebSocketException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>Sets the SerializationInfo object with the file name and line number where the exception occurred.</summary>
<param name="info">A SerializationInfo object.</param>
<param name="context">The contextual information about the source or destination.</param>
</member>
- <member name="P:System.Net.WebSockets.WebSocketException.ErrorCode">
- <summary>The native error code for the exception that occurred.</summary>
- <returns>Returns <see cref="T:System.Int32" />.</returns>
- </member>
<member name="P:System.Net.WebSockets.WebSocketException.WebSocketErrorCode">
<summary>Returns a WebSocketError indicating the type of error that occurred.</summary>
<returns>Returns <see cref="T:System.Net.WebSockets.WebSocketError" />.</returns>
</member>
- <member name="T:System.Net.WebSockets.WebSocketMessageFlags">
- <summary>Flags for controlling how the <see cref="T:System.Net.WebSockets.WebSocket" /> should send a message.</summary>
- </member>
- <member name="F:System.Net.WebSockets.WebSocketMessageFlags.DisableCompression">
- <summary>Disables compression for the message if compression has been enabled for the <see cref="T:System.Net.WebSockets.WebSocket" /> instance.</summary>
- </member>
- <member name="F:System.Net.WebSockets.WebSocketMessageFlags.EndOfMessage">
- <summary>Indicates that the data in "buffer" is the last part of a message.</summary>
- </member>
- <member name="F:System.Net.WebSockets.WebSocketMessageFlags.None">
- <summary>None</summary>
- </member>
<member name="T:System.Net.WebSockets.WebSocketMessageType">
<summary>Indicates the message type.</summary>
</member>
<summary>Defines the different states a WebSockets instance can be in.</summary>
</member>
<member name="F:System.Net.WebSockets.WebSocketState.Aborted">
- <summary>Indicates that the WebSocket has been aborted.</summary>
+ <summary>Reserved for future use.</summary>
</member>
<member name="F:System.Net.WebSockets.WebSocketState.Closed">
<summary>Indicates the WebSocket close handshake completed gracefully.</summary>
projects / platform / core / csapi / tizenfx.git / blobdiff