pkg/Tizen.NET.API11/build/tizen11.0/ref/System.Net.WebSockets.Client.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <doc>
   3   <assembly>
   4     <name>System.Net.WebSockets.Client</name>
   5   </assembly>
   6   <members>
   7     <member name="T:System.Net.WebSockets.ClientWebSocket">
   8       <summary>Provides a client for connecting to WebSocket services.</summary>
   9     </member>
  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>
  12     </member>
  13     <member name="M:System.Net.WebSockets.ClientWebSocket.Abort">
  14       <summary>Aborts the connection and cancels any pending IO operations.</summary>
  15     </member>
  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>
  22     </member>
  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>
  29     </member>
  30     <member name="M:System.Net.WebSockets.ClientWebSocket.ConnectAsync(System.Uri,System.Threading.CancellationToken)">
  31       <summary>Connect to a WebSocket server as an asynchronous operation.</summary>
  32       <param name="uri">The URI of the WebSocket server to connect to.</param>
  33       <param name="cancellationToken">A cancellation token used to propagate notification that the  operation should be canceled.</param>
  34       <returns>The task object representing the asynchronous operation.</returns>
  35     </member>
  36     <member name="M:System.Net.WebSockets.ClientWebSocket.Dispose">
  37       <summary>Releases the unmanaged resources used by the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
  38     </member>
  39     <member name="M:System.Net.WebSockets.ClientWebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
  40       <summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
  41       <param name="buffer">The buffer to receive the response.</param>
  42       <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
  43       <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
  44       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
  45       <returns>The task object representing the asynchronous operation.</returns>
  46     </member>
  47     <member name="M:System.Net.WebSockets.ClientWebSocket.ReceiveAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
  48       <summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
  49       <param name="buffer">The region of memory to receive the response.</param>
  50       <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
  51       <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
  52       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
  53       <returns>The task object representing the asynchronous operation.</returns>
  54     </member>
  55     <member name="M:System.Net.WebSockets.ClientWebSocket.SendAsync(System.ArraySegment{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
  56       <summary>Sends data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
  57       <param name="buffer">The buffer containing the message to be sent.</param>
  58       <param name="messageType">One of the enumeration values that specifies whether the buffer is clear text or in a binary format.</param>
  59       <param name="endOfMessage">
  60         <see langword="true" /> to indicate this is the final asynchronous send; otherwise, <see langword="false" />.</param>
  61       <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
  62       <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
  63       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
  64       <returns>The task object representing the asynchronous operation.</returns>
  65     </member>
  66     <member name="M:System.Net.WebSockets.ClientWebSocket.SendAsync(System.ReadOnlyMemory{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
  67       <summary>Sends data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> from a read-only byte memory range as an asynchronous operation.</summary>
  68       <param name="buffer">The region of memory containing the message to be sent.</param>
  69       <param name="messageType">One of the enumeration values that specifies whether the buffer is clear text or in a binary format.</param>
  70       <param name="endOfMessage">
  71         <see langword="true" /> to indicate this is the final asynchronous send; otherwise, <see langword="false" />.</param>
  72       <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
  73       <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
  74       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
  75       <returns>The task object representing the asynchronous operation.</returns>
  76     </member>
  77     <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatus">
  78       <summary>Gets the reason why the close handshake was initiated on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
  79       <returns>The reason why the close handshake was initiated.</returns>
  80     </member>
  81     <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatusDescription">
  82       <summary>Gets a description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance was closed.</summary>
  83       <returns>The description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance was closed.</returns>
  84     </member>
  85     <member name="P:System.Net.WebSockets.ClientWebSocket.Options">
  86       <summary>Gets the WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</summary>
  87       <returns>The WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket" /> instance.</returns>
  88     </member>
  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>
  92     </member>
  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>
  96     </member>
  97     <member name="T:System.Net.WebSockets.ClientWebSocketOptions">
  98       <summary>Options to use with a  <see cref="T:System.Net.WebSockets.ClientWebSocket" /> object.</summary>
  99     </member>
 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>
 103     </member>
 104     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32)">
 105       <summary>Sets the client buffer parameters.</summary>
 106       <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
 107       <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
 108     </member>
 109     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32,System.ArraySegment{System.Byte})">
 110       <summary>Sets client buffer parameters.</summary>
 111       <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
 112       <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
 113       <param name="buffer">The receive buffer to use.</param>
 114     </member>
 115     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetRequestHeader(System.String,System.String)">
 116       <summary>Creates a HTTP request header and its value.</summary>
 117       <param name="headerName">The name of the HTTP header.</param>
 118       <param name="headerValue">The value of the HTTP header.</param>
 119     </member>
 120     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.ClientCertificates">
 121       <summary>Gets or sets a collection of client side certificates.</summary>
 122       <returns>A collection of client side certificates.</returns>
 123     </member>
 124     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Cookies">
 125       <summary>Gets or sets the cookies associated with the request.</summary>
 126       <returns>The cookies associated with the request.</returns>
 127     </member>
 128     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Credentials">
 129       <summary>Gets or sets the credential information for the client.</summary>
 130       <returns>The credential information for the client.</returns>
 131     </member>
 132     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.DangerousDeflateOptions">
 133       <summary>Gets or sets the options for the per-message-deflate extension.
 134             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.
 135             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>
 136     </member>
 137     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.KeepAliveInterval">
 138       <summary>Gets or sets the WebSocket protocol keep-alive interval.</summary>
 139       <returns>The WebSocket protocol keep-alive interval.</returns>
 140     </member>
 141     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Proxy">
 142       <summary>Gets or sets the proxy for WebSocket requests.</summary>
 143       <returns>The proxy for WebSocket requests.</returns>
 144     </member>
 145     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.RemoteCertificateValidationCallback">
 146       <summary>Gets or sets the callback to validate a server certificate.</summary>
 147       <returns>A callback function to validate the server certificate.</returns>
 148     </member>
 149     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.UseDefaultCredentials">
 150       <summary>Gets or sets a <see cref="T:System.Boolean" /> value that indicates if default credentials should be used during WebSocket handshake.</summary>
 151       <returns>
 152         <see langword="true" /> if default credentials should be used during WebSocket handshake; otherwise, <see langword="false" />. The default is <see langword="true" />.</returns>
 153     </member>
 154   </members>
 155 </doc>