Tools/dotnetcli/sdk/NuGetFallbackFolder/microsoft.netcore.app/2.0.0/ref/netcoreapp2.0/System.Net.WebSockets.Client.xml

   1 <?xml version="1.0" encoding="utf-8"?><span>
   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"></see> 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"></see> 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>Returns <see cref="T:System.Threading.Tasks.Task"></see>.   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"></see> 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>Returns <see cref="T:System.Threading.Tasks.Task"></see>.   The task object representing the asynchronous operation.</returns>
  29     </member>
  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"></see> instance.</summary>
  32       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketCloseStatus"></see>.   The reason why the close handshake was initiated.</returns>
  33     </member>
  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"></see> instance was closed.</summary>
  36       <returns>Returns <see cref="T:System.String"></see>.   The description of the reason why the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance was closed.</returns>
  37     </member>
  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>Returns <see cref="T:System.Threading.Tasks.Task"></see>.   The task object representing the asynchronous operation.</returns>
  43     </member>
  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"></see> instance.</summary>
  46     </member>
  47     <member name="P:System.Net.WebSockets.ClientWebSocket.Options">
  48       <summary>Gets the WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</summary>
  49       <returns>Returns <see cref="T:System.Net.WebSockets.ClientWebSocketOptions"></see>.   The WebSocket options for the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</returns>
  50     </member>
  51     <member name="M:System.Net.WebSockets.ClientWebSocket.ReceiveAsync(System.ArraySegment{System.Byte},System.Threading.CancellationToken)">
  52       <summary>Receive data on <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> 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>Returns <see cref="T:System.Threading.Tasks.Task`1"></see>.   The task object representing the asynchronous operation.</returns>
  56     </member>
  57     <member name="M:System.Net.WebSockets.ClientWebSocket.SendAsync(System.ArraySegment{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Boolean,System.Threading.CancellationToken)">
  58       <summary>Send data on <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> as an asynchronous operation.</summary>
  59       <param name="buffer">The buffer containing the message to be sent.</param>
  60       <param name="messageType">Specifies whether the buffer is clear text or in a binary format.</param>
  61       <param name="endOfMessage">Specifies whether this is the final asynchronous send. Set to true if this is the final send; false otherwise.</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     </member>
  65     <member name="P:System.Net.WebSockets.ClientWebSocket.State">
  66       <summary>Get the WebSocket state of the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</summary>
  67       <returns>Returns <see cref="T:System.Net.WebSockets.WebSocketState"></see>.   The WebSocket state of the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</returns>
  68     </member>
  69     <member name="P:System.Net.WebSockets.ClientWebSocket.SubProtocol">
  70       <summary>Gets the supported WebSocket sub-protocol for the <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> instance.</summary>
  71       <returns>Returns <see cref="T:System.String"></see>.   The supported WebSocket sub-protocol.</returns>
  72     </member>
  73     <member name="T:System.Net.WebSockets.ClientWebSocketOptions">
  74       <summary>Options to use with a  <see cref="T:System.Net.WebSockets.ClientWebSocket"></see> object.</summary>
  75     </member>
  76     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.AddSubProtocol(System.String)">
  77       <summary>Adds a sub-protocol to be negotiated during the WebSocket connection handshake.</summary>
  78       <param name="subProtocol">The WebSocket sub-protocol to add.</param>
  79     </member>
  80     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.ClientCertificates">
  81       <summary>Gets or sets a collection of client side certificates.</summary>
  82       <returns>Returns <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection"></see>.   A collection of client side certificates.</returns>
  83     </member>
  84     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Cookies">
  85       <summary>Gets or sets the cookies associated with the request.</summary>
  86       <returns>Returns <see cref="T:System.Net.CookieContainer"></see>.   The cookies associated with the request.</returns>
  87     </member>
  88     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Credentials">
  89       <summary>Gets or sets the credential information for the client.</summary>
  90       <returns>Returns <see cref="T:System.Net.ICredentials"></see>.   The credential information for the client.</returns>
  91     </member>
  92     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.KeepAliveInterval">
  93       <summary>Gets or sets the WebSocket protocol keep-alive interval in milliseconds.</summary>
  94       <returns>Returns <see cref="T:System.TimeSpan"></see>.   The WebSocket protocol keep-alive interval in milliseconds.</returns>
  95     </member>
  96     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.Proxy">
  97       <summary>Gets or sets the proxy for WebSocket requests.</summary>
  98       <returns>Returns <see cref="T:System.Net.IWebProxy"></see>.   The proxy for WebSocket requests.</returns>
  99     </member>
 100     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32)">
 101       <summary>Sets the client buffer parameters.</summary>
 102       <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
 103       <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
 104     </member>
 105     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetBuffer(System.Int32,System.Int32,System.ArraySegment{System.Byte})">
 106       <summary>Sets client buffer parameters.</summary>
 107       <param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
 108       <param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
 109       <param name="buffer">The receive buffer to use.</param>
 110     </member>
 111     <member name="M:System.Net.WebSockets.ClientWebSocketOptions.SetRequestHeader(System.String,System.String)">
 112       <summary>Creates a HTTP request header and its value.</summary>
 113       <param name="headerName">The name of the HTTP header.</param>
 114       <param name="headerValue">The value of the HTTP header.</param>
 115     </member>
 116     <member name="P:System.Net.WebSockets.ClientWebSocketOptions.UseDefaultCredentials">
 117       <summary>Gets or sets a <see cref="T:System.Boolean"></see> value that indicates if default credentials should be used during WebSocket handshake.</summary>
 118       <returns>Returns <see cref="T:System.Boolean"></see>.  true if default credentials should be used during WebSocket handshake; otherwise false. The default is true.</returns>
 119     </member>
 120   </members>
 121 </doc></span>