253 lines
11 KiB
XML
253 lines
11 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="ClientWebSocketOptions" FullName="System.Net.WebSockets.ClientWebSocketOptions">
|
|
<TypeSignature Language="C#" Value="public sealed class ClientWebSocketOptions" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ClientWebSocketOptions extends System.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System</AssemblyName>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Options to use with a <see cref="T:System.Net.WebSockets.ClientWebSocket" /> object.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ClientWebSocketOptions ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AddSubProtocol">
|
|
<MemberSignature Language="C#" Value="public void AddSubProtocol (string subProtocol);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddSubProtocol(string subProtocol) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="subProtocol" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Adds a sub-protocol to be negotiated during the WebSocket connection handshake.</para>
|
|
</summary>
|
|
<param name="subProtocol">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The WebSocket sub-protocol to add.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ClientCertificates">
|
|
<MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509CertificateCollection ClientCertificates { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.X509Certificates.X509CertificateCollection ClientCertificates" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Security.Cryptography.X509Certificates.X509CertificateCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a collection of client side certificates.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Cookies">
|
|
<MemberSignature Language="C#" Value="public System.Net.CookieContainer Cookies { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.CookieContainer Cookies" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.CookieContainer</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the cookies associated with the request.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Credentials">
|
|
<MemberSignature Language="C#" Value="public System.Net.ICredentials Credentials { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.ICredentials Credentials" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.ICredentials</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the credential information for the client.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="KeepAliveInterval">
|
|
<MemberSignature Language="C#" Value="public TimeSpan KeepAliveInterval { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan KeepAliveInterval" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the WebSocket protocol keep-alive interval in milliseconds.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Proxy">
|
|
<MemberSignature Language="C#" Value="public System.Net.IWebProxy Proxy { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IWebProxy Proxy" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.IWebProxy</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the proxy for WebSocket requests.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetBuffer">
|
|
<MemberSignature Language="C#" Value="public void SetBuffer (int receiveBufferSize, int sendBufferSize);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetBuffer(int32 receiveBufferSize, int32 sendBufferSize) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="receiveBufferSize" Type="System.Int32" />
|
|
<Parameter Name="sendBufferSize" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Sets the client buffer parameters.</para>
|
|
</summary>
|
|
<param name="receiveBufferSize">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The size, in bytes, of the client receive buffer.</param>
|
|
<param name="sendBufferSize">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The size, in bytes, of the client send buffer.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetBuffer">
|
|
<MemberSignature Language="C#" Value="public void SetBuffer (int receiveBufferSize, int sendBufferSize, ArraySegment<byte> buffer);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetBuffer(int32 receiveBufferSize, int32 sendBufferSize, valuetype System.ArraySegment`1<unsigned int8> buffer) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="receiveBufferSize" Type="System.Int32" />
|
|
<Parameter Name="sendBufferSize" Type="System.Int32" />
|
|
<Parameter Name="buffer" Type="System.ArraySegment<System.Byte>" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Sets client buffer parameters.</para>
|
|
</summary>
|
|
<param name="receiveBufferSize">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The size, in bytes, of the client receive buffer.</param>
|
|
<param name="sendBufferSize">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The size, in bytes, of the client send buffer.</param>
|
|
<param name="buffer">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The receive buffer to use.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetRequestHeader">
|
|
<MemberSignature Language="C#" Value="public void SetRequestHeader (string headerName, string headerValue);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetRequestHeader(string headerName, string headerValue) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="headerName" Type="System.String" />
|
|
<Parameter Name="headerValue" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a HTTP request header and its value.</para>
|
|
</summary>
|
|
<param name="headerName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the HTTP header.</param>
|
|
<param name="headerValue">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The value of the HTTP header.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="UseDefaultCredentials">
|
|
<MemberSignature Language="C#" Value="public bool UseDefaultCredentials { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool UseDefaultCredentials" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a <see cref="T:System.Boolean" /> value that indicates if default credentials should be used during WebSocket handshake.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |