You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
949 lines
44 KiB
XML
949 lines
44 KiB
XML
<Type Name="WebHeaderCollection" FullName="WebSocketSharp.Net.WebHeaderCollection">
|
|
<TypeSignature Language="C#" Value="public class WebHeaderCollection : System.Collections.Specialized.NameValueCollection, System.Runtime.Serialization.ISerializable" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable WebHeaderCollection extends System.Collections.Specialized.NameValueCollection implements class System.Runtime.Serialization.ISerializable" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>websocket-sharp</AssemblyName>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Collections.Specialized.NameValueCollection</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<summary>
|
|
Provides a collection of the HTTP headers associated with a request or response.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebHeaderCollection ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> class.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected WebHeaderCollection (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Runtime.Serialization.SerializationInfo serializationInfo, valuetype System.Runtime.Serialization.StreamingContext streamingContext) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
|
|
<Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="serializationInfo">
|
|
A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that contains the data to need to serialize the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> object.
|
|
</param>
|
|
<param name="streamingContext">
|
|
A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains the source of the serialized stream associated with the new <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> class
|
|
with the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> and <see cref="T:System.Runtime.Serialization.StreamingContext" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="serializationInfo" /> is <see langword="null" />.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
An element with the specified name is not found in <paramref name="serializationInfo" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Add">
|
|
<MemberSignature Language="C#" Value="public void Add (string header);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Add(string header) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.String" /> that contains a header with the name and value separated by a colon (:).
|
|
</param>
|
|
<summary>
|
|
Adds the specified <paramref name="header" /> to the collection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="header" /> is <see langword="null" />, <see cref="F:System.String.Empty" />, or
|
|
the name part of <paramref name="header" /> is <see cref="F:System.String.Empty" />.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="header" /> does not contain a colon.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="header" /> is a restricted header.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
The name or value part of <paramref name="header" /> contains invalid characters.
|
|
</para>
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of the value part of <paramref name="header" /> is greater than 65535.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow the <paramref name="header" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Add">
|
|
<MemberSignature Language="C#" Value="public void Add (System.Net.HttpRequestHeader header, string value);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Add(valuetype System.Net.HttpRequestHeader header, string value) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.Net.HttpRequestHeader" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.Net.HttpRequestHeader" /> is a request header to add.
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.String" /> that contains the value of the header to add.
|
|
</param>
|
|
<summary>
|
|
Adds the specified request <paramref name="header" /> with the specified <paramref name="value" /> to the collection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of <paramref name="value" /> is greater than 65535.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow any of <see cref="T:System.Net.HttpRequestHeader" /> values.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="header" /> is a restricted header.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> contains invalid characters.
|
|
</para>
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Add">
|
|
<MemberSignature Language="C#" Value="public void Add (System.Net.HttpResponseHeader header, string value);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Add(valuetype System.Net.HttpResponseHeader header, string value) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.Net.HttpResponseHeader" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.Net.HttpResponseHeader" /> is a response header to add.
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.String" /> that contains the value of the header to add.
|
|
</param>
|
|
<summary>
|
|
Adds the specified response <paramref name="header" /> with the specified <paramref name="value" /> to the collection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of <paramref name="value" /> is greater than 65535.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow any of <see cref="T:System.Net.HttpResponseHeader" /> values.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="header" /> is a restricted header.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> contains invalid characters.
|
|
</para>
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Add">
|
|
<MemberSignature Language="C#" Value="public override void Add (string name, string value);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Add(string name, string value) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="name">
|
|
A <see cref="T:System.String" /> that contains the name of the header to add.
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.String" /> that contains the value of the header to add.
|
|
</param>
|
|
<summary>
|
|
Adds a header with the specified <paramref name="name" /> and <paramref name="value" /> to the collection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="name" /> or <paramref name="value" /> contains invalid characters.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="name" /> is a restricted header name.
|
|
</para>
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of <paramref name="value" /> is greater than 65535.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow the header <paramref name="name" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AddWithoutValidate">
|
|
<MemberSignature Language="C#" Value="protected void AddWithoutValidate (string headerName, string headerValue);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void AddWithoutValidate(string headerName, string headerValue) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="headerName" Type="System.String" />
|
|
<Parameter Name="headerValue" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="headerName">
|
|
A <see cref="T:System.String" /> that contains the name of the header to add.
|
|
</param>
|
|
<param name="headerValue">
|
|
A <see cref="T:System.String" /> that contains the value of the header to add.
|
|
</param>
|
|
<summary>
|
|
Adds a header to the collection without checking whether the header is on the restricted header list.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="headerName" /> or <paramref name="headerValue" /> contains invalid characters.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="headerName" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of <paramref name="headerValue" /> is greater than 65535.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow the <paramref name="headerName" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AllKeys">
|
|
<MemberSignature Language="C#" Value="public override string[] AllKeys { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string[] AllKeys" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String[]</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets all header names in the collection.
|
|
</summary>
|
|
<value>
|
|
An array of <see cref="T:System.String" /> that contains all header names in the collection.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Clear">
|
|
<MemberSignature Language="C#" Value="public override void Clear ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Clear() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Removes all headers from the collection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Count">
|
|
<MemberSignature Language="C#" Value="public override int Count { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the number of headers in the collection.
|
|
</summary>
|
|
<value>
|
|
An <see cref="T:System.Int32" /> that indicates the number of headers in the collection.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Get">
|
|
<MemberSignature Language="C#" Value="public override string Get (int index);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string Get(int32 index) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="index" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="index">
|
|
An <see cref="T:System.Int32" /> that is the zero-based index of the header to get.
|
|
</param>
|
|
<summary>
|
|
Get the value of the header with the specified <paramref name="index" /> in the collection.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:System.String" /> that receives the value of the header.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Get">
|
|
<MemberSignature Language="C#" Value="public override string Get (string name);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string Get(string name) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="name">
|
|
A <see cref="T:System.String" /> that contains the name of the header to get.
|
|
</param>
|
|
<summary>
|
|
Get the value of the header with the specified <paramref name="name" /> in the collection.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:System.String" /> that receives the value of the header.
|
|
<see langword="null" /> if there is no header with <paramref name="name" /> in the collection.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetEnumerator">
|
|
<MemberSignature Language="C#" Value="public override System.Collections.IEnumerator GetEnumerator ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Collections.IEnumerator GetEnumerator() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.IEnumerator</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Gets the enumerator to use to iterate through the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
|
|
</summary>
|
|
<returns>
|
|
An instance of an implementation of the <see cref="T:System.Collections.IEnumerator" /> interface
|
|
to use to iterate through the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetKey">
|
|
<MemberSignature Language="C#" Value="public override string GetKey (int index);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string GetKey(int32 index) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="index" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="index">
|
|
An <see cref="T:System.Int32" /> is the zero-based index of the key to get from the collection.
|
|
</param>
|
|
<summary>
|
|
Get the header name at the specified <paramref name="index" /> position in the collection.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:System.String" /> that receives the header name.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetObjectData">
|
|
<MemberSignature Language="C#" Value="public override void GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void GetObjectData(class System.Runtime.Serialization.SerializationInfo serializationInfo, valuetype System.Runtime.Serialization.StreamingContext streamingContext) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
|
|
<Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="serializationInfo">
|
|
A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the data to need to serialize the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> object.
|
|
</param>
|
|
<param name="streamingContext">
|
|
A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that specifies the destination for the serialization.
|
|
</param>
|
|
<summary>
|
|
Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data to need to
|
|
serialize the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> object.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="serializationInfo" /> is <see langword="null" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetValues">
|
|
<MemberSignature Language="C#" Value="public override string[] GetValues (int index);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string[] GetValues(int32 index) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="index" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="index">
|
|
An <see cref="T:System.Int32" /> is the zero-based index of the header in the collection.
|
|
</param>
|
|
<summary>
|
|
Gets an array of header values stored in the specified <paramref name="index" /> position of the header collection.
|
|
</summary>
|
|
<returns>
|
|
An array of <see cref="T:System.String" /> that receives the header values.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetValues">
|
|
<MemberSignature Language="C#" Value="public override string[] GetValues (string header);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string[] GetValues(string header) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.String" /> that contains a header name.
|
|
</param>
|
|
<summary>
|
|
Gets an array of header values stored in the specified <paramref name="header" /> name.
|
|
</summary>
|
|
<returns>
|
|
An array of <see cref="T:System.String" /> that receives the header values.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IsRestricted">
|
|
<MemberSignature Language="C#" Value="public static bool IsRestricted (string headerName);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsRestricted(string headerName) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="headerName" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="headerName">
|
|
A <see cref="T:System.String" /> that contains the name of the header to test.
|
|
</param>
|
|
<summary>
|
|
Determines whether the specified header can be set for the request.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the header is restricted; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="headerName" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="headerName" /> contains invalid characters.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IsRestricted">
|
|
<MemberSignature Language="C#" Value="public static bool IsRestricted (string headerName, bool response);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsRestricted(string headerName, bool response) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="headerName" Type="System.String" />
|
|
<Parameter Name="response" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="headerName">
|
|
A <see cref="T:System.String" /> that contains the name of the header to test.
|
|
</param>
|
|
<param name="response">
|
|
<c>true</c> if does the test for the response; for the request, <c>false</c>.
|
|
</param>
|
|
<summary>
|
|
Determines whether the specified header can be set for the request or the response.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the header is restricted; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="headerName" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="headerName" /> contains invalid characters.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Item">
|
|
<MemberSignature Language="C#" Value="public string this[System.Net.HttpRequestHeader header] { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Item(valuetype System.Net.HttpRequestHeader)" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.Net.HttpRequestHeader" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.Net.HttpRequestHeader" /> that indicates a request header.
|
|
</param>
|
|
<summary>
|
|
Gets or sets the specified request <paramref name="header" /> in the collection.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains the value of the specified request <paramref name="header" />.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow any of <see cref="T:System.Net.HttpRequestHeader" /> values.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="header" /> is a restricted header.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> contains invalid characters.
|
|
</para>
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of <paramref name="value" /> is greater than 65535.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Item">
|
|
<MemberSignature Language="C#" Value="public string this[System.Net.HttpResponseHeader header] { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Item(valuetype System.Net.HttpResponseHeader)" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.Net.HttpResponseHeader" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.Net.HttpResponseHeader" /> that indicates a response header.
|
|
</param>
|
|
<summary>
|
|
Gets or sets the specified response <paramref name="header" /> in the collection.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains the value of the specified response <paramref name="header" />.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow any of <see cref="T:System.Net.HttpResponseHeader" /> values.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="header" /> is a restricted header.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> contains invalid characters.
|
|
</para>
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of <paramref name="value" /> is greater than 65535.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Keys">
|
|
<MemberSignature Language="C#" Value="public override System.Collections.Specialized.NameObjectCollectionBase.KeysCollection Keys { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Specialized.NameObjectCollectionBase/KeysCollection Keys" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Specialized.NameObjectCollectionBase+KeysCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets a collection of header names in the collection.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.Collections.Specialized.NameObjectCollectionBase.KeysCollection" /> that contains a collection of header names in the collection.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnDeserialization">
|
|
<MemberSignature Language="C#" Value="public override void OnDeserialization (object sender);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnDeserialization(object sender) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="sender" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="sender">
|
|
An <see cref="T:System.Object" /> that contains the source of the deserialization event.
|
|
</param>
|
|
<summary>
|
|
Implements the <see cref="T:System.Runtime.Serialization.ISerializable" /> interface and raises the deserialization event
|
|
when the deserialization is complete.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Remove">
|
|
<MemberSignature Language="C#" Value="public void Remove (System.Net.HttpRequestHeader header);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Remove(valuetype System.Net.HttpRequestHeader header) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.Net.HttpRequestHeader" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.Net.HttpRequestHeader" /> to remove from the collection.
|
|
</param>
|
|
<summary>
|
|
Removes the specified header from the collection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow any of <see cref="T:System.Net.HttpRequestHeader" /> values.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="header" /> is a restricted header.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Remove">
|
|
<MemberSignature Language="C#" Value="public void Remove (System.Net.HttpResponseHeader header);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Remove(valuetype System.Net.HttpResponseHeader header) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.Net.HttpResponseHeader" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.Net.HttpResponseHeader" /> to remove from the collection.
|
|
</param>
|
|
<summary>
|
|
Removes the specified header from the collection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow any of <see cref="T:System.Net.HttpResponseHeader" /> values.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="header" /> is a restricted header.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Remove">
|
|
<MemberSignature Language="C#" Value="public override void Remove (string name);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Remove(string name) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="name">
|
|
A <see cref="T:System.String" /> that contains the name of the header to remove from the collection.
|
|
</param>
|
|
<summary>
|
|
Removes the specified header from the collection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="name" /> contains invalid characters.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="name" /> is a restricted header name.
|
|
</para>
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow the header <paramref name="name" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Set">
|
|
<MemberSignature Language="C#" Value="public void Set (System.Net.HttpRequestHeader header, string value);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Set(valuetype System.Net.HttpRequestHeader header, string value) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.Net.HttpRequestHeader" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.Net.HttpRequestHeader" /> to set.
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.String" /> that contains the value of the header to set.
|
|
</param>
|
|
<summary>
|
|
Sets the specified header to the specified value.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow any of <see cref="T:System.Net.HttpRequestHeader" /> values.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="header" /> is a restricted header.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> contains invalid characters.
|
|
</para>
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of <paramref name="value" /> is greater than 65535.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Set">
|
|
<MemberSignature Language="C#" Value="public void Set (System.Net.HttpResponseHeader header, string value);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Set(valuetype System.Net.HttpResponseHeader header, string value) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="header" Type="System.Net.HttpResponseHeader" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="header">
|
|
A <see cref="T:System.Net.HttpResponseHeader" /> to set.
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.String" /> that contains the value of the header to set.
|
|
</param>
|
|
<summary>
|
|
Sets the specified header to the specified value.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow any of <see cref="T:System.Net.HttpResponseHeader" /> values.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="header" /> is a restricted header.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> contains invalid characters.
|
|
</para>
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of <paramref name="value" /> is greater than 65535.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Set">
|
|
<MemberSignature Language="C#" Value="public override void Set (string name, string value);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Set(string name, string value) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="name">
|
|
A <see cref="T:System.String" /> that contains the name of the header to set.
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.String" /> that contains the value of the header to set.
|
|
</param>
|
|
<summary>
|
|
Sets the specified header to the specified value.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<para>
|
|
<paramref name="name" /> or <paramref name="value" /> contain invalid characters.
|
|
</para>
|
|
<para>
|
|
-or-
|
|
</para>
|
|
<para>
|
|
<paramref name="name" /> is a restricted header name.
|
|
</para>
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The length of <paramref name="value" /> is greater than 65535.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> instance does not allow the header <paramref name="name" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.Runtime.Serialization.ISerializable.GetObjectData">
|
|
<MemberSignature Language="C#" Value="void ISerializable.GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
|
|
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.Runtime.Serialization.ISerializable.GetObjectData(class System.Runtime.Serialization.SerializationInfo serializationInfo, valuetype System.Runtime.Serialization.StreamingContext streamingContext) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
|
|
<Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="serializationInfo">
|
|
A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the data to need to serialize the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> object.
|
|
</param>
|
|
<param name="streamingContext">
|
|
A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that specifies the destination for the serialization.
|
|
</param>
|
|
<summary>
|
|
Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data to need to
|
|
serialize the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> object.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="serializationInfo" /> is <see langword="null" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ToByteArray">
|
|
<MemberSignature Language="C#" Value="public byte[] ToByteArray ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] ToByteArray() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Byte[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Converts the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> to an array of <see cref="T:System.Byte" />.
|
|
</summary>
|
|
<returns>
|
|
An array of <see cref="T:System.Byte" /> that receives the converted current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ToString">
|
|
<MemberSignature Language="C#" Value="public override string ToString ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Returns a <see cref="T:System.String" /> that represents the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:System.String" /> that represents the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|