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-02-19 22:08:02 +09:00
parent a376daedf0
commit a9d5e06166
74 changed files with 355 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
websocket-sharp/Net/HttpListenerContext.cs
View File

@@ -31,13 +31,18 @@
using System;
using System.Collections.Specialized;
using System.IO;
using System.Net;
using System.Security.Principal;
using System.Text;
using WebSocketSharp.Net.WebSockets;
namespace WebSocketSharp.Net {
/// <summary>
/// Provides access to the HTTP request and response objects used by the <see cref="HttpListener"/> class.
/// </summary>
/// <remarks>
/// The HttpListenerContext class cannot be inherited.
/// </remarks>
public sealed class HttpListenerContext {
#region Private Fields
@@ -93,14 +98,33 @@ namespace WebSocketSharp.Net {
#region Public Properties
/// <summary>
/// Gets the <see cref="HttpListenerRequest"/> that contains the HTTP request from a client.
/// </summary>
/// <value>
/// A <see cref="HttpListenerRequest"/> that contains the HTTP request objects.
/// </value>
public HttpListenerRequest Request {
get { return request; }
}
/// <summary>
/// Gets the <see cref="HttpListenerResponse"/> that contains the HTTP response to send to
/// the client in response to the client's request.
/// </summary>
/// <value>
/// A <see cref="HttpListenerResponse"/> that contains the HTTP response objects.
/// </value>
public HttpListenerResponse Response {
get { return response; }
}
/// <summary>
/// Gets the client information (identity, authentication information and security roles).
/// </summary>
/// <value>
/// A <see cref="IPrincipal"/> contains the client information.
/// </value>
public IPrincipal User {
get { return user; }
}
@@ -125,7 +149,7 @@ namespace WebSocketSharp.Net {
}
// TODO: throw if malformed -> 400 bad request
}
internal IPrincipal ParseBasicAuthentication (string authData)
{
try {
@@ -135,29 +159,29 @@ namespace WebSocketSharp.Net {
string password = null;
int pos = -1;
string authString = Encoding.Default.GetString (Convert.FromBase64String (authData));
// The format is DOMAIN\username:password
// Domain is optional
pos = authString.IndexOf (':');
// parse the password off the end
password = authString.Substring (pos+1);
// discard the password
authString = authString.Substring (0, pos);
// check if there is a domain
pos = authString.IndexOf ('\\');
if (pos > 0) {
//domain = authString.Substring (0, pos);
user = authString.Substring (pos);
} else {
user = authString;
}
HttpListenerBasicIdentity identity = new HttpListenerBasicIdentity (user, password);
var identity = new System.Net.HttpListenerBasicIdentity (user, password);
// TODO: What are the roles MS sets
return new GenericPrincipal (identity, new string [0]);
} catch (Exception) {
@@ -170,6 +194,12 @@ namespace WebSocketSharp.Net {
#region Public Method
/// <summary>
/// Accepts a WebSocket connection by the <see cref="HttpListener"/>.
/// </summary>
/// <returns>
/// A <see cref="HttpListenerWebSocketContext"/> that contains a WebSocket connection.
/// </returns>
public HttpListenerWebSocketContext AcceptWebSocket ()
{
return new HttpListenerWebSocketContext (this);

58
websocket-sharp/Net/HttpListenerException.cs
View File

@@ -1,6 +1,6 @@
//
// HttpListenerException.cs
// Copied from System.Net.HttpListenerException
// Copied from System.Net.HttpListenerException.cs
//
// Author:
// Gonzalo Paniagua Javier (gonzalo@novell.com)
@@ -33,27 +33,79 @@ using System.Runtime.Serialization;
namespace WebSocketSharp.Net {
/// <summary>
/// The exception that is thrown when an error occurs processing an HTTP request.
/// </summary>
[Serializable]
public class HttpListenerException : Win32Exception
{
public class HttpListenerException : Win32Exception {
#region Public Constructors
/// <summary>
/// Initializes a new instance of the <see cref="HttpListenerException"/> class.
/// </summary>
public HttpListenerException ()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="HttpListenerException"/> class
/// with the specified <paramref name="errorCode"/>.
/// </summary>
/// <param name="errorCode">
/// An <see cref="int"/> that contains an error code.
/// </param>
public HttpListenerException (int errorCode) : base (errorCode)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="HttpListenerException"/> class
/// with the specified <paramref name="errorCode"/> and <paramref name="message"/>.
/// </summary>
/// <param name="errorCode">
/// An <see cref="int"/> that contains an error code.
/// </param>
/// <param name="message">
/// A <see cref="string"/> that describes the error.
/// </param>
public HttpListenerException (int errorCode, string message) : base (errorCode, message)
{
}
#endregion
#region Protected Constructor
/// <summary>
/// Initializes a new instance of the <see cref="HttpListenerException"/> class
/// from the specified <see cref="SerializationInfo"/> and <see cref="StreamingContext"/> classes.
/// </summary>
/// <param name="serializationInfo">
/// A <see cref="SerializationInfo"/> that contains the information required to deserialize
/// the new <see cref="HttpListenerException"/> object.
/// </param>
/// <param name="streamingContext">
/// A <see cref="StreamingContext"/>.
/// </param>
protected HttpListenerException (SerializationInfo serializationInfo, StreamingContext streamingContext) : base (serializationInfo, streamingContext)
{
}
#endregion
#region Property
/// <summary>
/// Gets a value that represents the error that occurred.
/// </summary>
/// <value>
/// An <see cref="int"/> that contains an error code.
/// </value>
public override int ErrorCode {
get { return base.ErrorCode; }
}
#endregion
}
}

2
websocket-sharp/Net/WebSockets/HttpListenerWebSocketContext.cs
View File

@@ -234,7 +234,7 @@ namespace WebSocketSharp.Net.WebSockets {
/// Gets the client information (identity, authentication information and security roles).
/// </summary>
/// <value>
/// An <see cref="IPrincipal"/> that contains the client information.
/// A <see cref="IPrincipal"/> that contains the client information.
/// </value>
public override IPrincipal User {
get {

2
websocket-sharp/Net/WebSockets/TcpListenerWebSocketContext.cs
View File

@@ -248,7 +248,7 @@ namespace WebSocketSharp.Net.WebSockets {
/// Gets the client information (identity, authentication information and security roles).
/// </summary>
/// <value>
/// An <see cref="IPrincipal"/> that contains the client information.
/// A <see cref="IPrincipal"/> that contains the client information.
/// </value>
/// <exception cref="NotImplementedException">
/// This property is not implemented.

2
websocket-sharp/Net/WebSockets/WebSocketContext.cs
View File

@@ -147,7 +147,7 @@ namespace WebSocketSharp.Net.WebSockets {
/// Gets the client information (identity, authentication information and security roles).
/// </summary>
/// <value>
/// An <see cref="IPrincipal"/> that contains the client information.
/// A <see cref="IPrincipal"/> that contains the client information.
/// </value>
public abstract IPrincipal User { get; }

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

Binary file not shown.

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

Binary file not shown.

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/websocket-sharp.dll
View File

Binary file not shown.

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

Binary file not shown.

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

@@ -1590,6 +1590,99 @@
Stops receiving incoming requests.
</summary>
</member>
<member name="T:WebSocketSharp.Net.HttpListenerContext">
<summary>
Provides access to the HTTP request and response objects used by the <see cref="T:WebSocketSharp.Net.HttpListener" /> class.
</summary>
<remarks>
The HttpListenerContext class cannot be inherited.
</remarks>
</member>
<member name="P:WebSocketSharp.Net.HttpListenerContext.Request">
<summary>
Gets the <see cref="T:WebSocketSharp.Net.HttpListenerRequest" /> that contains the HTTP request from a client.
</summary>
<value>
A <see cref="T:WebSocketSharp.Net.HttpListenerRequest" /> that contains the HTTP request objects.
</value>
</member>
<member name="P:WebSocketSharp.Net.HttpListenerContext.Response">
<summary>
Gets the <see cref="T:WebSocketSharp.Net.HttpListenerResponse" /> that contains the HTTP response to send to
the client in response to the client's request.
</summary>
<value>
A <see cref="T:WebSocketSharp.Net.HttpListenerResponse" /> that contains the HTTP response objects.
</value>
</member>
<member name="P:WebSocketSharp.Net.HttpListenerContext.User">
<summary>
Gets the client information (identity, authentication information and security roles).
</summary>
<value>
A <see cref="T:System.Security.Principal.IPrincipal" /> contains the client information.
</value>
</member>
<member name="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket">
<summary>
Accepts a WebSocket connection by the <see cref="T:WebSocketSharp.Net.HttpListener" />.
</summary>
<returns>
A <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext" /> that contains a WebSocket connection.
</returns>
</member>
<member name="T:WebSocketSharp.Net.HttpListenerException">
<summary>
The exception that is thrown when an error occurs processing an HTTP request.
</summary>
</member>
<member name="M:WebSocketSharp.Net.HttpListenerException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException" /> class.
</summary>
</member>
<member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException" /> class
with the specified <paramref name="errorCode" />.
</summary>
<param name="errorCode">
An <see cref="T:System.Int32" /> that contains an error code.
</param>
</member>
<member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32,System.String)">
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException" /> class
with the specified <paramref name="errorCode" /> and <paramref name="message" />.
</summary>
<param name="errorCode">
An <see cref="T:System.Int32" /> that contains an error code.
</param>
<param name="message">
A <see cref="T:System.String" /> that describes the error.
</param>
</member>
<member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException" /> class
from the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> and <see cref="T:System.Runtime.Serialization.StreamingContext" /> classes.
</summary>
<param name="serializationInfo">
A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that contains the information required to deserialize
the new <see cref="T:WebSocketSharp.Net.HttpListenerException" /> object.
</param>
<param name="streamingContext">
A <see cref="T:System.Runtime.Serialization.StreamingContext" />.
</param>
</member>
<member name="P:WebSocketSharp.Net.HttpListenerException.ErrorCode">
<summary>
Gets a value that represents the error that occurred.
</summary>
<value>
An <see cref="T:System.Int32" /> that contains an error code.
</value>
</member>
<member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String)">
<summary>
Decodes an HTML-encoded string and returns the decoded string.
@@ -2687,7 +2780,7 @@
Gets the client information (identity, authentication information and security roles).
</summary>
<value>
An <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
A <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
</value>
</member>
<member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.UserEndPoint">
@@ -2832,7 +2925,7 @@
Gets the client information (identity, authentication information and security roles).
</summary>
<value>
An <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
A <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
</value>
<exception cref="T:System.NotImplementedException">
This property is not implemented.
@@ -2961,7 +3054,7 @@
Gets the client information (identity, authentication information and security roles).
</summary>
<value>
An <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
A <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
</value>
</member>
<member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.WebSocket">

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

@@ -895,7 +895,7 @@
<div class="Signature">public override <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> <b>User</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.User:Value">
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> that contains the client information.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> that contains the client information.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.User:Remarks">

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

@@ -946,7 +946,7 @@
<div class="Signature">public override <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> <b>User</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.User:Value">
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> that contains the client information.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> that contains the client information.
</blockquote>
<h4 class="Subsection">Exceptions</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.User:Exceptions">

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

@@ -684,7 +684,7 @@
<div class="Signature">public abstract <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> <b>User</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.WebSockets.WebSocketContext.User:Value">
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> that contains the client information.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> that contains the client information.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.Net.WebSockets.WebSocketContext.User:Remarks">

58
websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerContext.html
View File

@@ -207,8 +207,8 @@
</div>
<h1 class="PageTitle" id="T:WebSocketSharp.Net.HttpListenerContext">HttpListenerContext Class</h1>
<p class="Summary" id="T:WebSocketSharp.Net.HttpListenerContext:Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Provides access to the HTTP request and response objects used by the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> class.
</p>
<div id="T:WebSocketSharp.Net.HttpListenerContext:Signature">
<h2>Syntax</h2>
<div class="Signature">public sealed class <b>HttpListenerContext</b></div>
@@ -216,8 +216,8 @@
<div class="Remarks" id="T:WebSocketSharp.Net.HttpListenerContext:Docs">
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="T:WebSocketSharp.Net.HttpListenerContext:Docs:Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</div>
The HttpListenerContext class cannot be inherited.
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="T:WebSocketSharp.Net.HttpListenerContext:Docs:Version Information">
<b>Namespace: </b>WebSocketSharp.Net<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
@@ -241,7 +241,9 @@
<td>
<i>
<a href="../WebSocketSharp.Net/HttpListenerRequest.html">HttpListenerRequest</a>
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
</i>.
Gets the <a href="../WebSocketSharp.Net/HttpListenerRequest.html">WebSocketSharp.Net.HttpListenerRequest</a> that contains the HTTP request from a client.
</td>
</tr>
<tr valign="top">
<td>[read-only]<div></div></td>
@@ -253,7 +255,10 @@
<td>
<i>
<a href="../WebSocketSharp.Net/HttpListenerResponse.html">HttpListenerResponse</a>
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
</i>.
Gets the <a href="../WebSocketSharp.Net/HttpListenerResponse.html">WebSocketSharp.Net.HttpListenerResponse</a> that contains the HTTP response to send to
the client in response to the client's request.
</td>
</tr>
<tr valign="top">
<td>[read-only]<div></div></td>
@@ -265,7 +270,9 @@
<td>
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a>
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
</i>.
Gets the client information (identity, authentication information and security roles).
</td>
</tr>
</table>
</div>
@@ -282,7 +289,9 @@
<td colspan="2">
<b>
<a href="#M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket">AcceptWebSocket</a>
</b>()<nobr> : <a href="../WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext</a></nobr><blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
</b>()<nobr> : <a href="../WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext</a></nobr><blockquote>
Accepts a WebSocket connection by the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
</blockquote></td>
</tr>
</table>
</div>
@@ -325,14 +334,14 @@
<h3 id="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket">AcceptWebSocket Method</h3>
<blockquote id="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket:member">
<p class="Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Accepts a WebSocket connection by the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="../WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext</a> <b>AcceptWebSocket</b> ()</div>
<h4 class="Subsection">Returns</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket:Returns">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</blockquote>
A <a href="../WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext</a> that contains a WebSocket connection.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket:Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
@@ -345,14 +354,14 @@
<h3 id="P:WebSocketSharp.Net.HttpListenerContext.Request">Request Property</h3>
<blockquote id="P:WebSocketSharp.Net.HttpListenerContext.Request:member">
<p class="Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Gets the <a href="../WebSocketSharp.Net/HttpListenerRequest.html">WebSocketSharp.Net.HttpListenerRequest</a> that contains the HTTP request from a client.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="../WebSocketSharp.Net/HttpListenerRequest.html">HttpListenerRequest</a> <b>Request</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListenerContext.Request:Value">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</blockquote>
A <a href="../WebSocketSharp.Net/HttpListenerRequest.html">WebSocketSharp.Net.HttpListenerRequest</a> that contains the HTTP request objects.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListenerContext.Request:Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
@@ -365,14 +374,15 @@
<h3 id="P:WebSocketSharp.Net.HttpListenerContext.Response">Response Property</h3>
<blockquote id="P:WebSocketSharp.Net.HttpListenerContext.Response:member">
<p class="Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Gets the <a href="../WebSocketSharp.Net/HttpListenerResponse.html">WebSocketSharp.Net.HttpListenerResponse</a> that contains the HTTP response to send to
the client in response to the client's request.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="../WebSocketSharp.Net/HttpListenerResponse.html">HttpListenerResponse</a> <b>Response</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListenerContext.Response:Value">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</blockquote>
A <a href="../WebSocketSharp.Net/HttpListenerResponse.html">WebSocketSharp.Net.HttpListenerResponse</a> that contains the HTTP response objects.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListenerContext.Response:Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
@@ -385,14 +395,14 @@
<h3 id="P:WebSocketSharp.Net.HttpListenerContext.User">User Property</h3>
<blockquote id="P:WebSocketSharp.Net.HttpListenerContext.User:member">
<p class="Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Gets the client information (identity, authentication information and security roles).
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> <b>User</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListenerContext.User:Value">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</blockquote>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Security.Principal.IPrincipal">System.Security.Principal.IPrincipal</a> contains the client information.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListenerContext.User:Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>

75
websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerException.html
View File

@@ -207,8 +207,8 @@
</div>
<h1 class="PageTitle" id="T:WebSocketSharp.Net.HttpListenerException">HttpListenerException Class</h1>
<p class="Summary" id="T:WebSocketSharp.Net.HttpListenerException:Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
The exception that is thrown when an error occurs processing an HTTP request.
</p>
<div id="T:WebSocketSharp.Net.HttpListenerException:Signature">
<h2>Syntax</h2>
<div class="Signature">public class <b>HttpListenerException</b> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.ComponentModel.Win32Exception">System.ComponentModel.Win32Exception</a></div>
@@ -243,8 +243,8 @@
</b>()</div>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
Initializes a new instance of the <a href="../WebSocketSharp.Net/HttpListenerException.html">WebSocketSharp.Net.HttpListenerException</a> class.
</td>
</tr>
<tr valign="top">
<td>
@@ -258,8 +258,9 @@
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>)</div>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
Initializes a new instance of the <a href="../WebSocketSharp.Net/HttpListenerException.html">WebSocketSharp.Net.HttpListenerException</a> class
with the specified <i>errorCode</i>.
</td>
</tr>
<tr valign="top">
<td>
@@ -273,8 +274,9 @@
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)</div>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
Initializes a new instance of the <a href="../WebSocketSharp.Net/HttpListenerException.html">WebSocketSharp.Net.HttpListenerException</a> class
with the specified <i>errorCode</i> and <i>message</i>.
</td>
</tr>
</table>
</div>
@@ -295,8 +297,9 @@
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.SerializationInfo">System.Runtime.Serialization.SerializationInfo</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.StreamingContext">System.Runtime.Serialization.StreamingContext</a>)</div>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
Initializes a new instance of the <a href="../WebSocketSharp.Net/HttpListenerException.html">WebSocketSharp.Net.HttpListenerException</a> class
from the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.SerializationInfo">System.Runtime.Serialization.SerializationInfo</a> and <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.StreamingContext">System.Runtime.Serialization.StreamingContext</a> classes.
</td>
</tr>
</table>
</div>
@@ -315,7 +318,9 @@
<td>
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
</i>.
Gets a value that represents the error that occurred.
</td>
</tr>
</table>
</div>
@@ -358,8 +363,8 @@
<h3 id="C:WebSocketSharp.Net.HttpListenerException">HttpListenerException Constructor</h3>
<blockquote id="C:WebSocketSharp.Net.HttpListenerException:member">
<p class="Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Initializes a new instance of the <a href="../WebSocketSharp.Net/HttpListenerException.html">WebSocketSharp.Net.HttpListenerException</a> class.
</p>
<h2>Syntax</h2>
<div class="Signature">public <b>HttpListenerException</b> ()</div>
<h2 class="Section">Remarks</h2>
@@ -374,8 +379,9 @@
<h3 id="C:WebSocketSharp.Net.HttpListenerException(System.Int32)">HttpListenerException Constructor</h3>
<blockquote id="C:WebSocketSharp.Net.HttpListenerException(System.Int32):member">
<p class="Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Initializes a new instance of the <a href="../WebSocketSharp.Net/HttpListenerException.html">WebSocketSharp.Net.HttpListenerException</a> class
with the specified <i>errorCode</i>.
</p>
<h2>Syntax</h2>
<div class="Signature">public <b>HttpListenerException</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> errorCode)</div>
<h4 class="Subsection">Parameters</h4>
@@ -385,8 +391,8 @@
<i>errorCode</i>
</dt>
<dd>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</dd>
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> that contains an error code.
</dd>
</dl>
</blockquote>
<h2 class="Section">Remarks</h2>
@@ -401,8 +407,9 @@
<h3 id="C:WebSocketSharp.Net.HttpListenerException(System.Int32,System.String)">HttpListenerException Constructor</h3>
<blockquote id="C:WebSocketSharp.Net.HttpListenerException(System.Int32,System.String):member">
<p class="Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Initializes a new instance of the <a href="../WebSocketSharp.Net/HttpListenerException.html">WebSocketSharp.Net.HttpListenerException</a> class
with the specified <i>errorCode</i> and <i>message</i>.
</p>
<h2>Syntax</h2>
<div class="Signature">public <b>HttpListenerException</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> errorCode, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> message)</div>
<h4 class="Subsection">Parameters</h4>
@@ -412,14 +419,14 @@
<i>errorCode</i>
</dt>
<dd>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</dd>
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> that contains an error code.
</dd>
<dt>
<i>message</i>
</dt>
<dd>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that describes the error.
</dd>
</dl>
</blockquote>
<h2 class="Section">Remarks</h2>
@@ -434,8 +441,9 @@
<h3 id="C:WebSocketSharp.Net.HttpListenerException(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">HttpListenerException Constructor</h3>
<blockquote id="C:WebSocketSharp.Net.HttpListenerException(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext):member">
<p class="Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Initializes a new instance of the <a href="../WebSocketSharp.Net/HttpListenerException.html">WebSocketSharp.Net.HttpListenerException</a> class
from the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.SerializationInfo">System.Runtime.Serialization.SerializationInfo</a> and <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.StreamingContext">System.Runtime.Serialization.StreamingContext</a> classes.
</p>
<h2>Syntax</h2>
<div class="Signature">protected <b>HttpListenerException</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.SerializationInfo">System.Runtime.Serialization.SerializationInfo</a> serializationInfo, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.StreamingContext">System.Runtime.Serialization.StreamingContext</a> streamingContext)</div>
<h4 class="Subsection">Parameters</h4>
@@ -445,14 +453,15 @@
<i>serializationInfo</i>
</dt>
<dd>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.SerializationInfo">System.Runtime.Serialization.SerializationInfo</a> that contains the information required to deserialize
the new <a href="../WebSocketSharp.Net/HttpListenerException.html">WebSocketSharp.Net.HttpListenerException</a> object.
</dd>
<dt>
<i>streamingContext</i>
</dt>
<dd>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Runtime.Serialization.StreamingContext">System.Runtime.Serialization.StreamingContext</a>.
</dd>
</dl>
</blockquote>
<h2 class="Section">Remarks</h2>
@@ -467,14 +476,14 @@
<h3 id="P:WebSocketSharp.Net.HttpListenerException.ErrorCode">ErrorCode Property</h3>
<blockquote id="P:WebSocketSharp.Net.HttpListenerException.ErrorCode:member">
<p class="Summary">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</p>
Gets a value that represents the error that occurred.
</p>
<h2>Syntax</h2>
<div class="Signature">public override <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> <b>ErrorCode</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListenerException.ErrorCode:Value">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</blockquote>
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> that contains an error code.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListenerException.ErrorCode:Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>

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

@@ -255,16 +255,16 @@
<a href="./HttpListenerContext.html">HttpListenerContext</a>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
Provides access to the HTTP request and response objects used by the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> class.
</td>
</tr>
<tr valign="top">
<td>
<a href="./HttpListenerException.html">HttpListenerException</a>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
The exception that is thrown when an error occurs processing an HTTP request.
</td>
</tr>
<tr valign="top">
<td>

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

@@ -347,16 +347,16 @@
<a href="WebSocketSharp.Net/HttpListenerContext.html">HttpListenerContext</a>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
Provides access to the HTTP request and response objects used by the <a href="./WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> class.
</td>
</tr>
<tr valign="top">
<td>
<a href="WebSocketSharp.Net/HttpListenerException.html">HttpListenerException</a>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
The exception that is thrown when an error occurs processing an HTTP request.
</td>
</tr>
<tr valign="top">
<td>

2
websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.xml
View File

@@ -237,7 +237,7 @@
Gets the client information (identity, authentication information and security roles).
</summary>
<value>
An <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
A <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
</value>
<remarks>To be added.</remarks>
</Docs>

2
websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.xml
View File

@@ -246,7 +246,7 @@
Gets the client information (identity, authentication information and security roles).
</summary>
<value>
An <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
A <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
</value>
<remarks>To be added.</remarks>
<exception cref="T:System.NotImplementedException">

2
websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/WebSocketContext.xml
View File

@@ -217,7 +217,7 @@
Gets the client information (identity, authentication information and security roles).
</summary>
<value>
An <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
A <see cref="T:System.Security.Principal.IPrincipal" /> that contains the client information.
</value>
<remarks>To be added.</remarks>
</Docs>

41
websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerContext.xml
View File

@@ -9,8 +9,12 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>
Provides access to the HTTP request and response objects used by the <see cref="T:WebSocketSharp.Net.HttpListener" /> class.
</summary>
<remarks>
The HttpListenerContext class cannot be inherited.
</remarks>
</Docs>
<Members>
<Member MemberName="AcceptWebSocket">
@@ -22,8 +26,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>
Accepts a WebSocket connection by the <see cref="T:WebSocketSharp.Net.HttpListener" />.
</summary>
<returns>
A <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext" /> that contains a WebSocket connection.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -35,8 +43,12 @@
<ReturnType>WebSocketSharp.Net.HttpListenerRequest</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>
Gets the <see cref="T:WebSocketSharp.Net.HttpListenerRequest" /> that contains the HTTP request from a client.
</summary>
<value>
A <see cref="T:WebSocketSharp.Net.HttpListenerRequest" /> that contains the HTTP request objects.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -48,8 +60,13 @@
<ReturnType>WebSocketSharp.Net.HttpListenerResponse</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>
Gets the <see cref="T:WebSocketSharp.Net.HttpListenerResponse" /> that contains the HTTP response to send to
the client in response to the client's request.
</summary>
<value>
A <see cref="T:WebSocketSharp.Net.HttpListenerResponse" /> that contains the HTTP response objects.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -61,8 +78,12 @@
<ReturnType>System.Security.Principal.IPrincipal</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>
Gets the client information (identity, authentication information and security roles).
</summary>
<value>
A <see cref="T:System.Security.Principal.IPrincipal" /> contains the client information.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>

52
websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerException.xml
View File

@@ -9,7 +9,9 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>
The exception that is thrown when an error occurs processing an HTTP request.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
@@ -19,7 +21,9 @@
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -31,8 +35,13 @@
<Parameter Name="errorCode" Type="System.Int32" />
</Parameters>
<Docs>
<param name="errorCode">To be added.</param>
<summary>To be added.</summary>
<param name="errorCode">
An <see cref="T:System.Int32" /> that contains an error code.
</param>
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException" /> class
with the specified <paramref name="errorCode" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -45,9 +54,16 @@
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="errorCode">To be added.</param>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<param name="errorCode">
An <see cref="T:System.Int32" /> that contains an error code.
</param>
<param name="message">
A <see cref="T:System.String" /> that describes the error.
</param>
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException" /> class
with the specified <paramref name="errorCode" /> and <paramref name="message" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -60,9 +76,17 @@
<Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<param name="serializationInfo">To be added.</param>
<param name="streamingContext">To be added.</param>
<summary>To be added.</summary>
<param name="serializationInfo">
A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that contains the information required to deserialize
the new <see cref="T:WebSocketSharp.Net.HttpListenerException" /> object.
</param>
<param name="streamingContext">
A <see cref="T:System.Runtime.Serialization.StreamingContext" />.
</param>
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException" /> class
from the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> and <see cref="T:System.Runtime.Serialization.StreamingContext" /> classes.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -74,8 +98,12 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>
Gets a value that represents the error that occurred.
</summary>
<value>
An <see cref="T:System.Int32" /> that contains an error code.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>

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

@@ -1,6 +1,6 @@
<Overview>
<Assemblies>
<Assembly Name="websocket-sharp" Version="1.0.2.31269">
<Assembly Name="websocket-sharp" Version="1.0.2.39586">
<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>
<Attribute>

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

Binary file not shown.