diff options
Diffstat (limited to '.packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Net.WebSockets.Client.xml')
| -rwxr-xr-x | .packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Net.WebSockets.Client.xml | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/.packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Net.WebSockets.Client.xml b/.packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Net.WebSockets.Client.xml new file mode 100755 index 0000000000..8be9914b01 --- /dev/null +++ b/.packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Net.WebSockets.Client.xml @@ -0,0 +1,147 @@ +<?xml version="1.0" encoding="utf-8"?> +<doc> + <assembly> + <name>System.Net.WebSockets.Client</name> + </assembly> + <members> + <member name="T:System.Net.WebSockets.ClientWebSocket"> + <summary>Provides a client for connecting to WebSocket services.</summary> + </member> + <member name="M:System.Net.WebSockets.ClientWebSocket.#ctor"> + <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> class.</summary> + </member> + <member name="M:System.Net.WebSockets.ClientWebSocket.Abort"> + <summary>Aborts the connection and cancels any pending IO operations.</summary> + </member> + <member name="M:System.Net.WebSockets.ClientWebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)"> + <summary>Close the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance as an asynchronous operation.</summary> + <param name="closeStatus">The WebSocket close status.</param> + <param name="statusDescription">A description of the close status.</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> + </member> + <member name="M:System.Net.WebSockets.ClientWebSocket.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)"> + <summary>Close the output for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance as an asynchronous operation.</summary> + <param name="closeStatus">The WebSocket close status.</param> + <param name="statusDescription">A description of the close status.</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> + </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> + <param name="cancellationToken">A cancellation token used to propagate notification that the operation should be canceled.</param> + <returns>The task object representing the asynchronous operation.</returns> + </member> + <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> + </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" /> 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> + </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="buffer">The buffer containing the message to be sent.</param> + <param name="messageType">One of the enumeration values that specifies whether the buffer is clear text or in a binary format.</param> + <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> + </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="buffer">The region of memory containing the message to be sent.</param> + <param name="messageType">One of the enumeration values that specifies whether the buffer is clear text or in a binary format.</param> + <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> + </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> + <returns>The WebSocket state of the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</returns> + </member> + <member name="P:System.Net.WebSockets.ClientWebSocket.SubProtocol"> + <summary>Gets the supported WebSocket sub-protocol for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary> + <returns>The supported WebSocket sub-protocol.</returns> + </member> + <member name="T:System.Net.WebSockets.ClientWebSocketOptions"> + <summary>Options to use with a <see cref="T:System.Net.WebSockets.ClientWebSocket" /> object.</summary> + </member> + <member name="M:System.Net.WebSockets.ClientWebSocketOptions.AddSubProtocol(System.String)"> + <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="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> + </member> + <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Cookies"> + <summary>Gets or sets the cookies associated with the request.</summary> + <returns>The cookies associated with the request.</returns> + </member> + <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Credentials"> + <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.KeepAliveInterval"> + <summary>Gets or sets the WebSocket protocol keep-alive interval.</summary> + <returns>The WebSocket protocol keep-alive interval.</returns> + </member> + <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Proxy"> + <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" /> + <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> + <returns> + <see langword="true" /> if default credentials should be used during WebSocket handshake; otherwise, <see langword="false" />. The default is <see langword="true" />.</returns> + </member> + </members> +</doc>
\ No newline at end of file |