<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
<returns>The task object representing the asynchronous operation.</returns>
</member>
+ <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatus">
+ <summary>Gets the reason why the close handshake was initiated on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
+ <returns>The reason why the close handshake was initiated.</returns>
+ </member>
+ <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatusDescription">
+ <summary>Gets a description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance was closed.</summary>
+ <returns>The description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance was closed.</returns>
+ </member>
<member name="M:System.Net.WebSockets.ClientWebSocket.ConnectAsync(System.Uri,System.Threading.CancellationToken)">
<summary>Connect to a WebSocket server as an asynchronous operation.</summary>
<param name="uri">The URI of the WebSocket server to connect to.</param>
<member name="M:System.Net.WebSockets.ClientWebSocket.Dispose">
<summary>Releases the unmanaged resources used by the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
</member>
+ <member name="P:System.Net.WebSockets.ClientWebSocket.Options">
+ <summary>Gets the WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
+ <returns>The WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</returns>
+ </member>
<member name="M:System.Net.WebSockets.ClientWebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
<summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
<param name="buffer">The buffer to receive the response.</param>
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
+ <returns>The task object representing the asynchronous operation.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
- <returns>The task object representing the asynchronous operation.</returns>
</member>
<member name="M:System.Net.WebSockets.ClientWebSocket.ReceiveAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
- <summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
+ <summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> to a byte memory range as an asynchronous operation.</summary>
<param name="buffer">The region of memory to receive the response.</param>
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
+ <returns>The task object representing the asynchronous operation.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
- <returns>The task object representing the asynchronous operation.</returns>
</member>
<member name="M:System.Net.WebSockets.ClientWebSocket.SendAsync(System.ArraySegment{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
<summary>Sends data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
<param name="endOfMessage">
<see langword="true" /> to indicate this is the final asynchronous send; otherwise, <see langword="false" />.</param>
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
+ <returns>The task object representing the asynchronous operation.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
- <returns>The task object representing the asynchronous operation.</returns>
</member>
<member name="M:System.Net.WebSockets.ClientWebSocket.SendAsync(System.ReadOnlyMemory{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
<summary>Sends data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> from a read-only byte memory range as an asynchronous operation.</summary>
<param name="endOfMessage">
<see langword="true" /> to indicate this is the final asynchronous send; otherwise, <see langword="false" />.</param>
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
+ <returns>The task object representing the asynchronous operation.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
- <returns>The task object representing the asynchronous operation.</returns>
- </member>
- <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatus">
- <summary>Gets the reason why the close handshake was initiated on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
- <returns>The reason why the close handshake was initiated.</returns>
- </member>
- <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatusDescription">
- <summary>Gets a description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance was closed.</summary>
- <returns>The description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance was closed.</returns>
- </member>
- <member name="P:System.Net.WebSockets.ClientWebSocket.Options">
- <summary>Gets the WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
- <returns>The WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</returns>
</member>
<member name="P:System.Net.WebSockets.ClientWebSocket.State">
<summary>Gets the WebSocket state of the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
<summary>Adds a sub-protocol to be negotiated during the WebSocket connection handshake.</summary>
<param name="subProtocol">The WebSocket sub-protocol to add.</param>
</member>
- <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32)">
- <summary>Sets the client buffer parameters.</summary>
- <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
- <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
- </member>
- <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32,System.ArraySegment{System.Byte})">
- <summary>Sets client buffer parameters.</summary>
- <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
- <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
- <param name="buffer">The receive buffer to use.</param>
- </member>
- <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetRequestHeader(System.String,System.String)">
- <summary>Creates a HTTP request header and its value.</summary>
- <param name="headerName">The name of the HTTP header.</param>
- <param name="headerValue">The value of the HTTP header.</param>
- </member>
<member name="P:System.Net.WebSockets.ClientWebSocketOptions.ClientCertificates">
<summary>Gets or sets a collection of client side certificates.</summary>
<returns>A collection of client side certificates.</returns>
<summary>Gets or sets the credential information for the client.</summary>
<returns>The credential information for the client.</returns>
</member>
- <member name="P:System.Net.WebSockets.ClientWebSocketOptions.DangerousDeflateOptions">
- <summary>Gets or sets the options for the per-message-deflate extension.
- When present, the options are sent to the server during the handshake phase. If the server supports per-message-deflate and the options are accepted, the <see cref="T:System.Net.WebSockets.WebSocket" /> instance will be created with compression enabled by default for all messages.<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.ClientWebSocketOptions.KeepAliveInterval">
<summary>Gets or sets the WebSocket protocol keep-alive interval.</summary>
<returns>The WebSocket protocol keep-alive interval.</returns>
<summary>Gets or sets the proxy for WebSocket requests.</summary>
<returns>The proxy for WebSocket requests.</returns>
</member>
- <member name="P:System.Net.WebSockets.ClientWebSocketOptions.RemoteCertificateValidationCallback">
- <summary>Gets or sets the callback to validate a server certificate.</summary>
- <returns>A callback function to validate the server certificate.</returns>
+ <member name="P:System.Net.WebSockets.ClientWebSocketOptions.RemoteCertificateValidationCallback" />
+ <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32)">
+ <summary>Sets the client buffer parameters.</summary>
+ <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
+ <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
+ </member>
+ <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32,System.ArraySegment{System.Byte})">
+ <summary>Sets client buffer parameters.</summary>
+ <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
+ <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
+ <param name="buffer">The receive buffer to use.</param>
+ </member>
+ <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetRequestHeader(System.String,System.String)">
+ <summary>Creates a HTTP request header and its value.</summary>
+ <param name="headerName">The name of the HTTP header.</param>
+ <param name="headerValue">The value of the HTTP header.</param>
</member>
<member name="P:System.Net.WebSockets.ClientWebSocketOptions.UseDefaultCredentials">
<summary>Gets or sets a <see cref="T:System.Boolean" /> value that indicates if default credentials should be used during WebSocket handshake.</summary>
projects / platform / core / csapi / tizenfx.git / blobdiff