1 <?xml version="1.0" encoding="utf-8"?>
4 <name>System.Net.WebSockets.Client</name>
7 <member name="T:System.Net.WebSockets.ClientWebSocket">
8 <summary>Provides a client for connecting to WebSocket services.</summary>
10 <member name="M:System.Net.WebSockets.ClientWebSocket.#ctor">
11 <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> class.</summary>
13 <member name="M:System.Net.WebSockets.ClientWebSocket.Abort">
14 <summary>Aborts the connection and cancels any pending IO operations.</summary>
16 <member name="M:System.Net.WebSockets.ClientWebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
17 <summary>Close the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance as an asynchronous operation.</summary>
18 <param name="closeStatus">The WebSocket close status.</param>
19 <param name="statusDescription">A description of the close status.</param>
20 <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
21 <returns>The task object representing the asynchronous operation.</returns>
23 <member name="M:System.Net.WebSockets.ClientWebSocket.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
24 <summary>Close the output for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance as an asynchronous operation.</summary>
25 <param name="closeStatus">The WebSocket close status.</param>
26 <param name="statusDescription">A description of the close status.</param>
27 <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
28 <returns>The task object representing the asynchronous operation.</returns>
30 <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatus">
31 <summary>Gets the reason why the close handshake was initiated on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
32 <returns>The reason why the close handshake was initiated.</returns>
34 <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatusDescription">
35 <summary>Gets a description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance was closed.</summary>
36 <returns>The description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance was closed.</returns>
38 <member name="M:System.Net.WebSockets.ClientWebSocket.ConnectAsync(System.Uri,System.Threading.CancellationToken)">
39 <summary>Connect to a WebSocket server as an asynchronous operation.</summary>
40 <param name="uri">The URI of the WebSocket server to connect to.</param>
41 <param name="cancellationToken">A cancellation token used to propagate notification that the operation should be canceled.</param>
42 <returns>The task object representing the asynchronous operation.</returns>
44 <member name="M:System.Net.WebSockets.ClientWebSocket.Dispose">
45 <summary>Releases the unmanaged resources used by the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
47 <member name="P:System.Net.WebSockets.ClientWebSocket.Options">
48 <summary>Gets the WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
49 <returns>The WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</returns>
51 <member name="M:System.Net.WebSockets.ClientWebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
52 <summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
53 <param name="buffer">The buffer to receive the response.</param>
54 <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
55 <returns>The task object representing the asynchronous operation.</returns>
56 <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
57 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
59 <member name="M:System.Net.WebSockets.ClientWebSocket.ReceiveAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
60 <summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> to a byte memory range as an asynchronous operation.</summary>
61 <param name="buffer">The region of memory to receive the response.</param>
62 <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
63 <returns>The task object representing the asynchronous operation.</returns>
64 <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
65 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
67 <member name="M:System.Net.WebSockets.ClientWebSocket.SendAsync(System.ArraySegment{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
68 <summary>Sends data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
69 <param name="buffer">The buffer containing the message to be sent.</param>
70 <param name="messageType">One of the enumeration values that specifies whether the buffer is clear text or in a binary format.</param>
71 <param name="endOfMessage">
72 <see langword="true" /> to indicate this is the final asynchronous send; otherwise, <see langword="false" />.</param>
73 <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
74 <returns>The task object representing the asynchronous operation.</returns>
75 <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
76 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
78 <member name="M:System.Net.WebSockets.ClientWebSocket.SendAsync(System.ReadOnlyMemory{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
79 <summary>Sends data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> from a read-only byte memory range as an asynchronous operation.</summary>
80 <param name="buffer">The region of memory containing the message to be sent.</param>
81 <param name="messageType">One of the enumeration values that specifies whether the buffer is clear text or in a binary format.</param>
82 <param name="endOfMessage">
83 <see langword="true" /> to indicate this is the final asynchronous send; otherwise, <see langword="false" />.</param>
84 <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
85 <returns>The task object representing the asynchronous operation.</returns>
86 <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
87 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
89 <member name="P:System.Net.WebSockets.ClientWebSocket.State">
90 <summary>Gets the WebSocket state of the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
91 <returns>The WebSocket state of the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</returns>
93 <member name="P:System.Net.WebSockets.ClientWebSocket.SubProtocol">
94 <summary>Gets the supported WebSocket sub-protocol for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
95 <returns>The supported WebSocket sub-protocol.</returns>
97 <member name="T:System.Net.WebSockets.ClientWebSocketOptions">
98 <summary>Options to use with a <see cref="T:System.Net.WebSockets.ClientWebSocket" /> object.</summary>
100 <member name="M:System.Net.WebSockets.ClientWebSocketOptions.AddSubProtocol(System.String)">
101 <summary>Adds a sub-protocol to be negotiated during the WebSocket connection handshake.</summary>
102 <param name="subProtocol">The WebSocket sub-protocol to add.</param>
104 <member name="P:System.Net.WebSockets.ClientWebSocketOptions.ClientCertificates">
105 <summary>Gets or sets a collection of client side certificates.</summary>
106 <returns>A collection of client side certificates.</returns>
108 <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Cookies">
109 <summary>Gets or sets the cookies associated with the request.</summary>
110 <returns>The cookies associated with the request.</returns>
112 <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Credentials">
113 <summary>Gets or sets the credential information for the client.</summary>
114 <returns>The credential information for the client.</returns>
116 <member name="P:System.Net.WebSockets.ClientWebSocketOptions.KeepAliveInterval">
117 <summary>Gets or sets the WebSocket protocol keep-alive interval.</summary>
118 <returns>The WebSocket protocol keep-alive interval.</returns>
120 <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Proxy">
121 <summary>Gets or sets the proxy for WebSocket requests.</summary>
122 <returns>The proxy for WebSocket requests.</returns>
124 <member name="P:System.Net.WebSockets.ClientWebSocketOptions.RemoteCertificateValidationCallback" />
125 <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32)">
126 <summary>Sets the client buffer parameters.</summary>
127 <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
128 <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
130 <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32,System.ArraySegment{System.Byte})">
131 <summary>Sets client buffer parameters.</summary>
132 <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
133 <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
134 <param name="buffer">The receive buffer to use.</param>
136 <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetRequestHeader(System.String,System.String)">
137 <summary>Creates a HTTP request header and its value.</summary>
138 <param name="headerName">The name of the HTTP header.</param>
139 <param name="headerValue">The value of the HTTP header.</param>
141 <member name="P:System.Net.WebSockets.ClientWebSocketOptions.UseDefaultCredentials">
142 <summary>Gets or sets a <see cref="T:System.Boolean" /> value that indicates if default credentials should be used during WebSocket handshake.</summary>
144 <see langword="true" /> if default credentials should be used during WebSocket handshake; otherwise, <see langword="false" />. The default is <see langword="true" />.</returns>