pkg/Tizen.NET.API6/build/tizen60/ref/System.Net.WebSockets.Client.xml

   1 <?xml version="1.0" encoding="utf-8"?><doc>
   2   <assembly>
   3     <name>System.Net.WebSockets.Client</name>
   4   </assembly>
   5   <members>
   6     <member name="T:System.Net.WebSockets.ClientWebSocketOptions">
   7       <summary>Options to use with a  <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> object.</summary>
   8     </member>
   9     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.AddSubProtocol(System.String)">
  10       <summary>Adds a sub-protocol to be negotiated during the WebSocket connection handshake.</summary>
  11       <param name="subProtocol">The WebSocket sub-protocol to add.</param>
  12     </member>
  13     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.ClientCertificates">
  14       <summary>Gets or sets a collection of client side certificates.</summary>
  15       <returns>Returns <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection"></see>.
  16  A collection of client side certificates.</returns>
  17     </member>
  18     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Cookies">
  19       <summary>Gets or sets the cookies associated with the request.</summary>
  20       <returns>Returns <see cref="T:System.Net.CookieContainer"></see>.
  21  The cookies associated with the request.</returns>
  22     </member>
  23     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Credentials">
  24       <summary>Gets or sets the credential information for the client.</summary>
  25       <returns>Returns <see cref="T:System.Net.ICredentials"></see>.
  26  The credential information for the client.</returns>
  27     </member>
  28     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.KeepAliveInterval">
  29       <summary>Gets or sets the WebSocket protocol keep-alive interval in milliseconds.</summary>
  30       <returns>Returns <see cref="T:System.TimeSpan"></see>.
  31  The WebSocket protocol keep-alive interval in milliseconds.</returns>
  32     </member>
  33     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Proxy">
  34       <summary>Gets or sets the proxy for WebSocket requests.</summary>
  35       <returns>Returns <see cref="T:System.Net.IWebProxy"></see>.
  36  The proxy for WebSocket requests.</returns>
  37     </member>
  38     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.RemoteCertificateValidationCallback">
  39       <returns></returns>
  40     </member>
  41     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32)">
  42       <summary>Sets the client buffer parameters.</summary>
  43       <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
  44       <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
  45     </member>
  46     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32,System.ArraySegment{System.Byte})">
  47       <summary>Sets client buffer parameters.</summary>
  48       <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
  49       <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
  50       <param name="buffer">The receive buffer to use.</param>
  51     </member>
  52     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetRequestHeader(System.String,System.String)">
  53       <summary>Creates a HTTP request header and its value.</summary>
  54       <param name="headerName">The name of the HTTP header.</param>
  55       <param name="headerValue">The value of the HTTP header.</param>
  56     </member>
  57     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.UseDefaultCredentials">
  58       <summary>Gets or sets a <see cref="T:System.Boolean"></see> value that indicates if default credentials should be used during WebSocket handshake.</summary>
  59       <returns>Returns <see cref="T:System.Boolean"></see>.
  60  <see langword="true"></see> if default credentials should be used during WebSocket handshake; otherwise <see langword="false"></see>. The default is <see langword="true"></see>.</returns>
  61     </member>
  62     <member name="T:System.Net.WebSockets.ClientWebSocket">
  63       <summary>Provides a client for connecting to WebSocket services.</summary>
  64     </member>
  65     <member name="M:System.Net.WebSockets.ClientWebSocket.#ctor">
  66       <summary>Creates an instance of the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> class.</summary>
  67     </member>
  68     <member name="M:System.Net.WebSockets.ClientWebSocket.Abort">
  69       <summary>Aborts the connection and cancels any pending IO operations.</summary>
  70     </member>
  71     <member name="M:System.Net.WebSockets.ClientWebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  72       <summary>Close the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance as an asynchronous operation.</summary>
  73       <param name="closeStatus">The WebSocket close status.</param>
  74       <param name="statusDescription">A description of the close status.</param>
  75       <param name="cancellationToken">A cancellation token used to propagate notification that this  operation should be canceled.</param>
  76       <returns>Returns <see cref="T:System.Threading.Tasks.Task"></see>.
  77  The task object representing the asynchronous operation.</returns>
  78     </member>
  79     <member name="M:System.Net.WebSockets.ClientWebSocket.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus,System.String,System.Threading.CancellationToken)">
  80       <summary>Close the output for the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance as an asynchronous operation.</summary>
  81       <param name="closeStatus">The WebSocket close status.</param>
  82       <param name="statusDescription">A description of the close status.</param>
  83       <param name="cancellationToken">A cancellation token used to propagate notification that this  operation should be canceled.</param>
  84       <returns>Returns <see cref="T:System.Threading.Tasks.Task"></see>.
  85  The task object representing the asynchronous operation.</returns>
  86     </member>
  87     <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatus">
  88       <summary>Gets the reason why the close handshake was initiated on <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</summary>
  89       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketCloseStatus"></see>.
  90  The reason why the close handshake was initiated.</returns>
  91     </member>
  92     <member name="P:System.Net.WebSockets.ClientWebSocket.CloseStatusDescription">
  93       <summary>Gets a description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance was closed.</summary>
  94       <returns>Returns <see cref="T:System.String"></see>.
  95  The description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance was closed.</returns>
  96     </member>
  97     <member name="M:System.Net.WebSockets.ClientWebSocket.ConnectAsync(System.Uri,System.Threading.CancellationToken)">
  98       <summary>Connect to a WebSocket server as an asynchronous operation.</summary>
  99       <param name="uri">The URI of the WebSocket server to connect to.</param>
 100       <param name="cancellationToken">A cancellation token used to propagate notification that the  operation should be canceled.</param>
 101       <returns>Returns <see cref="T:System.Threading.Tasks.Task"></see>.
 102  The task object representing the asynchronous operation.</returns>
 103     </member>
 104     <member name="M:System.Net.WebSockets.ClientWebSocket.Dispose">
 105       <summary>Releases the unmanaged resources used by the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</summary>
 106     </member>
 107     <member name="P:System.Net.WebSockets.ClientWebSocket.Options">
 108       <summary>Gets the WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</summary>
 109       <returns>Returns <see cref="T:System.Net.WebSockets.ClientWebSocketOptions"></see>.
 110  The WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</returns>
 111     </member>
 112     <member name="M:System.Net.WebSockets.ClientWebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
 113       <summary>Receive data on <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> as an asynchronous operation.</summary>
 114       <param name="buffer">The buffer to receive the response.</param>
 115       <param name="cancellationToken">A cancellation token used to propagate notification that this  operation should be canceled.</param>
 116       <returns>Returns <see cref="T:System.Threading.Tasks.Task`1"></see>.
 117  The task object representing the asynchronous operation.</returns>
 118     </member>
 119     <member name="M:System.Net.WebSockets.ClientWebSocket.SendAsync(System.ArraySegment{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
 120       <summary>Send data on <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> as an asynchronous operation.</summary>
 121       <param name="buffer">The buffer containing the message to be sent.</param>
 122       <param name="messageType">Specifies whether the buffer is clear text or in a binary format.</param>
 123       <param name="endOfMessage">Specifies whether this is the final asynchronous send. Set to <see langword="true"></see> if this is the final send; <see langword="false"></see> otherwise.</param>
 124       <param name="cancellationToken">A cancellation token used to propagate notification that this  operation should be canceled.</param>
 125       <returns>The task object representing the asynchronous operation.</returns>
 126     </member>
 127     <member name="P:System.Net.WebSockets.ClientWebSocket.State">
 128       <summary>Get the WebSocket state of the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</summary>
 129       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketState"></see>.
 130  The WebSocket state of the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</returns>
 131     </member>
 132     <member name="P:System.Net.WebSockets.ClientWebSocket.SubProtocol">
 133       <summary>Gets the supported WebSocket sub-protocol for the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</summary>
 134       <returns>Returns <see cref="T:System.String"></see>.
 135  The supported WebSocket sub-protocol.</returns>
 136     </member>
 137   </members>
 138 </doc>