DevWiki/websocket-sharp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added some XML documentation comments

Browse Source
This commit is contained in:
sta 2013-03-14 15:47:27 +09:00
parent 75164c0652
commit e370d0f879
28 changed files with 1935 additions and 713 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
Example/bin/Debug_Ubuntu/example.exe
View File

Binary file not shown.

BIN
Example/bin/Debug_Ubuntu/example.exe.mdb
View File

Binary file not shown.

BIN
Example/bin/Debug_Ubuntu/websocket-sharp.dll
View File

Binary file not shown.

BIN
Example/bin/Debug_Ubuntu/websocket-sharp.dll.mdb
View File

Binary file not shown.

BIN
Example1/bin/Debug_Ubuntu/example1.exe
View File

Binary file not shown.

BIN
Example1/bin/Debug_Ubuntu/example1.exe.mdb
View File

Binary file not shown.

BIN
Example1/bin/Debug_Ubuntu/websocket-sharp.dll
View File

Binary file not shown.

BIN
Example1/bin/Debug_Ubuntu/websocket-sharp.dll.mdb
View File

Binary file not shown.

BIN
Example2/bin/Debug_Ubuntu/example2.exe
View File

Binary file not shown.

BIN
Example2/bin/Debug_Ubuntu/example2.exe.mdb
View File

Binary file not shown.

BIN
Example2/bin/Debug_Ubuntu/websocket-sharp.dll
View File

Binary file not shown.

BIN
Example2/bin/Debug_Ubuntu/websocket-sharp.dll.mdb
View File

Binary file not shown.

BIN
Example3/bin/Debug_Ubuntu/Example3.exe
View File

Binary file not shown.

BIN
Example3/bin/Debug_Ubuntu/Example3.exe.mdb
View File

Binary file not shown.

BIN
Example3/bin/Debug_Ubuntu/websocket-sharp.dll
View File

Binary file not shown.

BIN
Example3/bin/Debug_Ubuntu/websocket-sharp.dll.mdb
View File

Binary file not shown.

23
websocket-sharp/Ext.cs
View File

@ -79,6 +79,29 @@ namespace WebSocketSharp {
#region Internal Method #region Internal Method
internal static bool IsText(this string value)
{
int len = value.Length;
for (int i = 0; i < len; i++)
{
char c = value[i];
if (c < 0x20 && !"\r\n\t".Contains(c))
return false;
if (c == 0x7f)
return false;
if (c == '\n' && ++i < len)
{
c = value[i];
if (!" \t".Contains(c))
return false;
}
}
return true;
}
internal static bool IsToken(this string value) internal static bool IsToken(this string value)
{ {
foreach (char c in value) foreach (char c in value)

1057
websocket-sharp/Net/WebHeaderCollection.cs
View File

File diff suppressed because it is too large Load Diff

BIN
websocket-sharp/bin/Debug_Ubuntu/websocket-sharp.dll
View File

Binary file not shown.

BIN
websocket-sharp/bin/Debug_Ubuntu/websocket-sharp.dll.mdb
View File

Binary file not shown.

BIN
websocket-sharp/bin/Release_Ubuntu/websocket-sharp.dll
View File

Binary file not shown.

397
websocket-sharp/bin/Release_Ubuntu/websocket-sharp.xml
View File

@ -2954,6 +2954,403 @@
<param name="s">The string to encode.</param> <param name="s">The string to encode.</param>
<param name="output">The TextWriter output stream containing the encoded string.</param> <param name="output">The TextWriter output stream containing the encoded string.</param>
</member> </member>
<member name="T:WebSocketSharp.Net.WebHeaderCollection">
<summary>
Provides a collection of the HTTP headers associated with a request or response.
</summary>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<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>
<param name="serializationInfo">
A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.
</param>
<param name="streamingContext">
A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains the contextual information about the source or destination.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> class.
</summary>
</member>
<member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(System.Net.HttpRequestHeader)">
<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>
<param name="header">
A <see cref="T:System.Net.HttpRequestHeader" /> that contains a request header name.
</param>
</member>
<member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(System.Net.HttpResponseHeader)">
<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>
<param name="header">
A <see cref="T:System.Net.HttpResponseHeader" /> that contains a response header name.
</param>
</member>
<member name="P:WebSocketSharp.Net.WebHeaderCollection.AllKeys">
<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>
</member>
<member name="P:WebSocketSharp.Net.WebHeaderCollection.Count">
<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>
</member>
<member name="P:WebSocketSharp.Net.WebHeaderCollection.Keys">
<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>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data needed to serialize the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
</summary>
<param name="serializationInfo">
A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.
</param>
<param name="streamingContext">
A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that specifies the destination for the serialization.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.AddWithoutValidate(System.String,System.String)">
<summary>
Adds a header to the collection without checking whether the header is on the restricted header list.
</summary>
<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>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="headerName" /> is <see langword="null" />, <see cref="F:System.String.Empty" />, or
contains invalid characters.
</para>
<para>
-or-
</para>
<para>
<paramref name="headerValue" /> contains invalid characters.
</para>
</exception>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String)">
<summary>
Adds the specified <paramref name="header" /> to the collection.
</summary>
<param name="header">
A <see cref="T:System.String" /> that contains a header with the name and value separated by a colon (:).
</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="header" /> is <see langword="null" /> or a <see cref="F:System.String.Empty" />.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="header" /> does not contain a colon.
</exception>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.Net.HttpRequestHeader,System.String)">
<summary>
Adds the specified request <paramref name="header" /> with the specified <paramref name="value" /> to the collection.
</summary>
<param name="header">
A <see cref="T:System.Net.HttpRequestHeader" /> that contains the name of the request header to add.
</param>
<param name="value">
A <see cref="T:System.String" /> that contains the value of the header to add.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.Net.HttpResponseHeader,System.String)">
<summary>
Adds the specified response <paramref name="header" /> with the specified <paramref name="value" /> to the collection.
</summary>
<param name="header">
A <see cref="T:System.Net.HttpResponseHeader" /> that contains the name of the response header to add.
</param>
<param name="value">
A <see cref="T:System.String" /> that contains the value of the header to add.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String,System.String)">
<summary>
Adds a header with the specified <paramref name="name" /> and <paramref name="value" /> to the collection.
</summary>
<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>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="name" /> is <see langword="null" /> or a <see cref="F:System.String.Empty" />.
</para>
<para>
-or-
</para>
<para>
<paramref name="name" /> is a restricted header that must be set with a property setting.
</para>
<para>
-or-
</para>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
The length of <paramref name="value" /> is greater than 65535.
</exception>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Clear">
<summary>
Removes all headers from the collection.
</summary>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.Int32)">
<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>
<param name="index">
An <see cref="T:System.Int32" /> that is the zero-based index of the header to get.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.String)">
<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>
<param name="name">
A <see cref="T:System.String" /> that contains the name of the header to get.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.GetEnumerator">
<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>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.GetKey(System.Int32)">
<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>
<param name="index">
An <see cref="T:System.Int32" /> is the zero-based index of the key to get from the collection.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.String)">
<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>
<param name="header">
A <see cref="T:System.String" /> that contains a header name.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.Int32)">
<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>
<param name="index">
An <see cref="T:System.Int32" /> is the zero-based index of the header in the collection.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data needed to serialize the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
</summary>
<param name="serializationInfo">
A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.
</param>
<param name="streamingContext">
A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that specifies the destination for the serialization.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String)">
<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>
<param name="headerName">
A <see cref="T:System.String" /> that contains the name of the header to test.
</param>
<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>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String,System.Boolean)">
<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>
<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>
<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>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.OnDeserialization(System.Object)">
<summary>
Implements the <see cref="T:System.Runtime.Serialization.ISerializable" /> interface and raises the deserialization event
when the deserialization is complete.
</summary>
<param name="sender">
An <see cref="T:System.Object" /> that contains the source of the deserialization event.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(System.Net.HttpRequestHeader)">
<summary>
Removes the specified header from the collection.
</summary>
<param name="header">
A <see cref="T:System.Net.HttpRequestHeader" /> to remove from the collection.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(System.Net.HttpResponseHeader)">
<summary>
Removes the specified header from the collection.
</summary>
<param name="header">
A <see cref="T:System.Net.HttpResponseHeader" /> to remove from the collection.
</param>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(System.String)">
<summary>
Removes the specified header from the collection.
</summary>
<param name="name">
A <see cref="T:System.String" /> that contains the name of the header to remove from the collection.
</param>
<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>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(System.Net.HttpRequestHeader,System.String)">
<summary>
Sets the specified header to the specified value.
</summary>
<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>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(System.Net.HttpResponseHeader,System.String)">
<summary>
Sets the specified header to the specified value.
</summary>
<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>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(System.String,System.String)">
<summary>
Sets the specified header to the specified value.
</summary>
<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>
<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>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.ToByteArray">
<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>
</member>
<member name="M:WebSocketSharp.Net.WebHeaderCollection.ToString">
<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>
</member>
<member name="T:WebSocketSharp.Server.HttpServer"> <member name="T:WebSocketSharp.Server.HttpServer">
<summary> <summary>
Provides a simple HTTP server that allows to accept the WebSocket connection requests. Provides a simple HTTP server that allows to accept the WebSocket connection requests.

513
websocket-sharp/doc/html/WebSocketSharp.Net/WebHeaderCollection.html
View File

File diff suppressed because it is too large Load Diff

2
websocket-sharp/doc/html/WebSocketSharp.Net/index.html
View File

@ -311,7 +311,7 @@
<a href="./WebHeaderCollection.html">WebHeaderCollection</a> <a href="./WebHeaderCollection.html">WebHeaderCollection</a>
</td> </td>
<td> <td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span> Provides a collection of the HTTP headers associated with a request or response.
</td> </td>
</tr> </tr>
</table> </table>

2
websocket-sharp/doc/html/index.html
View File

@ -403,7 +403,7 @@
<a href="WebSocketSharp.Net/WebHeaderCollection.html">WebHeaderCollection</a> <a href="WebSocketSharp.Net/WebHeaderCollection.html">WebHeaderCollection</a>
</td> </td>
<td> <td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span> Provides a collection of the HTTP headers associated with a request or response.
</td> </td>
</tr> </tr>
</table> </table>

422
websocket-sharp/doc/mdoc/WebSocketSharp.Net/WebHeaderCollection.xml
View File

@ -18,7 +18,9 @@
</Attribute> </Attribute>
</Attributes> </Attributes>
<Docs> <Docs>
<summary>To be added.</summary> <summary>
Provides a collection of the HTTP headers associated with a request or response.
</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
<Members> <Members>
@ -28,7 +30,9 @@
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" /> class.
</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -41,9 +45,16 @@
<Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" /> <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="serializationInfo">To be added.</param> <param name="serializationInfo">
<param name="streamingContext">To be added.</param> A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.
<summary>To be added.</summary> </param>
<param name="streamingContext">
A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains the contextual information about the source or destination.
</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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -58,9 +69,19 @@
<Parameter Name="header" Type="System.String" /> <Parameter Name="header" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="header">To be added.</param> <param name="header">
<summary>To be added.</summary> 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> <remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="header" /> is <see langword="null" /> or a <see cref="F:System.String.Empty" />.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="header" /> does not contain a colon.
</exception>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Add"> <Member MemberName="Add">
@ -75,9 +96,15 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="header">To be added.</param> <param name="header">
<param name="value">To be added.</param> A <see cref="T:System.Net.HttpRequestHeader" /> that contains the name of the request header to add.
<summary>To be added.</summary> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -93,9 +120,15 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="header">To be added.</param> <param name="header">
<param name="value">To be added.</param> A <see cref="T:System.Net.HttpResponseHeader" /> that contains the name of the response header to add.
<summary>To be added.</summary> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -111,10 +144,33 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="name">To be added.</param> <param name="name">
<param name="value">To be added.</param> A <see cref="T:System.String" /> that contains the name of the header to add.
<summary>To be added.</summary> </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> <remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="name" /> is <see langword="null" /> or a <see cref="F:System.String.Empty" />.
</para>
<para>
-or-
</para>
<para>
<paramref name="name" /> is a restricted header that must be set with a property setting.
</para>
<para>
-or-
</para>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
The length of <paramref name="value" /> is greater than 65535.
</exception>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddWithoutValidate"> <Member MemberName="AddWithoutValidate">
@ -129,10 +185,28 @@
<Parameter Name="headerValue" Type="System.String" /> <Parameter Name="headerValue" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="headerName">To be added.</param> <param name="headerName">
<param name="headerValue">To be added.</param> A <see cref="T:System.String" /> that contains the name of the header to add.
<summary>To be added.</summary> </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> <remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="headerName" /> is <see langword="null" />, <see cref="F:System.String.Empty" />, or
contains invalid characters.
</para>
<para>
-or-
</para>
<para>
<paramref name="headerValue" /> contains invalid characters.
</para>
</exception>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AllKeys"> <Member MemberName="AllKeys">
@ -143,8 +217,12 @@
<ReturnType>System.String[]</ReturnType> <ReturnType>System.String[]</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>
<value>To be added.</value> 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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -157,7 +235,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>
Removes all headers from the collection.
</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -169,8 +249,12 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>
<value>To be added.</value> 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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -185,9 +269,15 @@
<Parameter Name="index" Type="System.Int32" /> <Parameter Name="index" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="index">To be added.</param> <param name="index">
<summary>To be added.</summary> An <see cref="T:System.Int32" /> that is the zero-based index of the header to get.
<returns>To be added.</returns> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -202,9 +292,16 @@
<Parameter Name="name" Type="System.String" /> <Parameter Name="name" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="name">To be added.</param> <param name="name">
<summary>To be added.</summary> A <see cref="T:System.String" /> that contains the name of the header to get.
<returns>To be added.</returns> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -217,8 +314,13 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>
<returns>To be added.</returns> 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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -233,9 +335,15 @@
<Parameter Name="index" Type="System.Int32" /> <Parameter Name="index" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="index">To be added.</param> <param name="index">
<summary>To be added.</summary> An <see cref="T:System.Int32" /> is the zero-based index of the key to get from the collection.
<returns>To be added.</returns> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -251,9 +359,15 @@
<Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" /> <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="serializationInfo">To be added.</param> <param name="serializationInfo">
<param name="streamingContext">To be added.</param> A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.
<summary>To be added.</summary> </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 needed to serialize the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -268,9 +382,15 @@
<Parameter Name="index" Type="System.Int32" /> <Parameter Name="index" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="index">To be added.</param> <param name="index">
<summary>To be added.</summary> An <see cref="T:System.Int32" /> is the zero-based index of the header in the collection.
<returns>To be added.</returns> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -285,9 +405,15 @@
<Parameter Name="header" Type="System.String" /> <Parameter Name="header" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="header">To be added.</param> <param name="header">
<summary>To be added.</summary> A <see cref="T:System.String" /> that contains a header name.
<returns>To be added.</returns> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -302,10 +428,22 @@
<Parameter Name="headerName" Type="System.String" /> <Parameter Name="headerName" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="headerName">To be added.</param> <param name="headerName">
<summary>To be added.</summary> A <see cref="T:System.String" /> that contains the name of the header to test.
<returns>To be added.</returns> </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> <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> </Docs>
</Member> </Member>
<Member MemberName="IsRestricted"> <Member MemberName="IsRestricted">
@ -320,44 +458,70 @@
<Parameter Name="response" Type="System.Boolean" /> <Parameter Name="response" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="headerName">To be added.</param> <param name="headerName">
<param name="response">To be added.</param> A <see cref="T:System.String" /> that contains the name of the header to test.
<summary>To be added.</summary> </param>
<returns>To be added.</returns> <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> <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> </Docs>
</Member> </Member>
<Member MemberName="Item"> <Member MemberName="Item">
<MemberSignature Language="C#" Value="public string this[System.Net.HttpRequestHeader hrh] { get; set; }" /> <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)" /> <MemberSignature Language="ILAsm" Value=".property instance string Item(valuetype System.Net.HttpRequestHeader)" />
<MemberType>Property</MemberType> <MemberType>Property</MemberType>
<ReturnValue> <ReturnValue>
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="hrh" Type="System.Net.HttpRequestHeader" /> <Parameter Name="header" Type="System.Net.HttpRequestHeader" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="hrh">To be added.</param> <param name="header">
<summary>To be added.</summary> A <see cref="T:System.Net.HttpRequestHeader" /> that contains a request header name.
<value>To be added.</value> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Item"> <Member MemberName="Item">
<MemberSignature Language="C#" Value="public string this[System.Net.HttpResponseHeader hrh] { get; set; }" /> <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)" /> <MemberSignature Language="ILAsm" Value=".property instance string Item(valuetype System.Net.HttpResponseHeader)" />
<MemberType>Property</MemberType> <MemberType>Property</MemberType>
<ReturnValue> <ReturnValue>
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="hrh" Type="System.Net.HttpResponseHeader" /> <Parameter Name="header" Type="System.Net.HttpResponseHeader" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="hrh">To be added.</param> <param name="header">
<summary>To be added.</summary> A <see cref="T:System.Net.HttpResponseHeader" /> that contains a response header name.
<value>To be added.</value> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -369,8 +533,12 @@
<ReturnType>System.Collections.Specialized.NameObjectCollectionBase+KeysCollection</ReturnType> <ReturnType>System.Collections.Specialized.NameObjectCollectionBase+KeysCollection</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>
<value>To be added.</value> 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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -385,8 +553,13 @@
<Parameter Name="sender" Type="System.Object" /> <Parameter Name="sender" Type="System.Object" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="sender">To be added.</param> <param name="sender">
<summary>To be added.</summary> 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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -401,8 +574,12 @@
<Parameter Name="header" Type="System.Net.HttpRequestHeader" /> <Parameter Name="header" Type="System.Net.HttpRequestHeader" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="header">To be added.</param> <param name="header">
<summary>To be added.</summary> 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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -417,8 +594,12 @@
<Parameter Name="header" Type="System.Net.HttpResponseHeader" /> <Parameter Name="header" Type="System.Net.HttpResponseHeader" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="header">To be added.</param> <param name="header">
<summary>To be added.</summary> 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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -433,9 +614,27 @@
<Parameter Name="name" Type="System.String" /> <Parameter Name="name" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="name">To be added.</param> <param name="name">
<summary>To be added.</summary> 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> <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>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Set"> <Member MemberName="Set">
@ -450,9 +649,15 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="header">To be added.</param> <param name="header">
<param name="value">To be added.</param> A <see cref="T:System.Net.HttpRequestHeader" /> to set.
<summary>To be added.</summary> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -468,9 +673,15 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="header">To be added.</param> <param name="header">
<param name="value">To be added.</param> A <see cref="T:System.Net.HttpResponseHeader" /> to set.
<summary>To be added.</summary> </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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -486,10 +697,33 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="name">To be added.</param> <param name="name">
<param name="value">To be added.</param> A <see cref="T:System.String" /> that contains the name of the header to set.
<summary>To be added.</summary> </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> <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>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="System.Runtime.Serialization.ISerializable.GetObjectData"> <Member MemberName="System.Runtime.Serialization.ISerializable.GetObjectData">
@ -504,9 +738,15 @@
<Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" /> <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="serializationInfo">To be added.</param> <param name="serializationInfo">
<param name="streamingContext">To be added.</param> A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.
<summary>To be added.</summary> </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 needed to serialize the <see cref="T:WebSocketSharp.Net.WebHeaderCollection" />.
</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -519,8 +759,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>
<returns>To be added.</returns> 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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -533,8 +777,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>
<returns>To be added.</returns> 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> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>

2
websocket-sharp/doc/mdoc/index.xml
View File

@ -1,6 +1,6 @@
<Overview> <Overview>
<Assemblies> <Assemblies>
<Assembly Name="websocket-sharp" Version="1.0.2.30644"> <Assembly Name="websocket-sharp" Version="1.0.2.28338">
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 11 00 00 00 29 17 fb 89 fe c3 91 f7 2b cb 8b e2 61 d2 3f 05 93 6d 65 a8 9e 63 72 a6 f5 d5 2c f2 9d 20 fa 0b c0 70 6a f6 88 7e 8b 90 3f 39 f5 76 c8 48 e0 bb 7b b2 7b ed d3 10 a7 1a 0f 70 98 0f 7f f4 4b 53 09 d2 a5 ef 36 c3 56 b4 aa f0 91 72 63 25 07 89 e0 93 3e 3f 2e f2 b9 73 0e 12 15 5d 43 56 c3 f4 70 a5 89 fe f7 f6 ac 3e 77 c2 d8 d0 84 91 f4 0c d1 f3 8e dc c3 c3 b8 38 3d 0c bf 17 de 20 78 c1 ]</AssemblyPublicKey> <AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 11 00 00 00 29 17 fb 89 fe c3 91 f7 2b cb 8b e2 61 d2 3f 05 93 6d 65 a8 9e 63 72 a6 f5 d5 2c f2 9d 20 fa 0b c0 70 6a f6 88 7e 8b 90 3f 39 f5 76 c8 48 e0 bb 7b b2 7b ed d3 10 a7 1a 0f 70 98 0f 7f f4 4b 53 09 d2 a5 ef 36 c3 56 b4 aa f0 91 72 63 25 07 89 e0 93 3e 3f 2e f2 b9 73 0e 12 15 5d 43 56 c3 f4 70 a5 89 fe f7 f6 ac 3e 77 c2 d8 d0 84 91 f4 0c d1 f3 8e dc c3 c3 b8 38 3d 0c bf 17 de 20 78 c1 ]</AssemblyPublicKey>
<Attributes> <Attributes>
<Attribute> <Attribute>

BIN
websocket-sharp/websocket-sharp.pidb
View File

Binary file not shown.