diff --git a/Example3/Example3.pidb b/Example3/Example3.pidb index cf7315be..4458a67b 100644 Binary files a/Example3/Example3.pidb and b/Example3/Example3.pidb differ diff --git a/websocket-sharp.userprefs b/websocket-sharp.userprefs index 9b182064..4f01e372 100644 --- a/websocket-sharp.userprefs +++ b/websocket-sharp.userprefs @@ -1,5 +1,5 @@  - + diff --git a/websocket-sharp/Net/AuthenticationSchemeSelector.cs b/websocket-sharp/Net/AuthenticationSchemeSelector.cs index 24e7dd03..a6b307dc 100644 --- a/websocket-sharp/Net/AuthenticationSchemeSelector.cs +++ b/websocket-sharp/Net/AuthenticationSchemeSelector.cs @@ -1,6 +1,6 @@ // // AuthenticationSchemeSelector.cs -// Copied from System.Net.AuthenticationSchemeSelector +// Copied from System.Net.AuthenticationSchemeSelector.cs // // Author: // Gonzalo Paniagua Javier @@ -31,5 +31,14 @@ using System; namespace WebSocketSharp.Net { + /// + /// Selects the authentication scheme for a instance. + /// + /// + /// One of the values that indicates the scheme used to authenticate the specified client request. + /// + /// + /// A that contains a client request information. + /// public delegate AuthenticationSchemes AuthenticationSchemeSelector (HttpListenerRequest httpRequest); } diff --git a/websocket-sharp/Net/AuthenticationSchemes.cs b/websocket-sharp/Net/AuthenticationSchemes.cs index e5fb7724..0068baa9 100644 --- a/websocket-sharp/Net/AuthenticationSchemes.cs +++ b/websocket-sharp/Net/AuthenticationSchemes.cs @@ -1,6 +1,6 @@ // // AuthenticationSchemes.cs -// Copied from System.Net.AuthenticationSchemes +// Copied from System.Net.AuthenticationSchemes.cs // // Author: // Atsushi Enomoto @@ -31,15 +31,39 @@ using System; namespace WebSocketSharp.Net { + /// + /// Contains the values of the schemes for authentication. + /// [Flags] public enum AuthenticationSchemes { + /// + /// Indicates that no authentication is allowed. + /// None, + /// + /// Indicates digest authentication. + /// Digest = 1, + /// + /// Indicates negotiating with the client to determine the authentication scheme. + /// Negotiate = 2, + /// + /// Indicates NTLM authentication. + /// Ntlm = 4, + /// + /// Indicates Windows authentication. + /// IntegratedWindowsAuthentication = 6, + /// + /// Indicates basic authentication. + /// Basic = 8, + /// + /// Indicates anonymous authentication. + /// Anonymous = 0x8000, } } diff --git a/websocket-sharp/Net/EndPointListener.cs b/websocket-sharp/Net/EndPointListener.cs index f9e84724..0ab7cce3 100644 --- a/websocket-sharp/Net/EndPointListener.cs +++ b/websocket-sharp/Net/EndPointListener.cs @@ -1,6 +1,6 @@ // // EndPointListener.cs -// Copied from System.Net.EndPointListener +// Copied from System.Net.EndPointListener.cs // // Author: // Gonzalo Paniagua Javier (gonzalo@novell.com) diff --git a/websocket-sharp/Net/HttpListener.cs b/websocket-sharp/Net/HttpListener.cs index d568f3a5..2cff724f 100644 --- a/websocket-sharp/Net/HttpListener.cs +++ b/websocket-sharp/Net/HttpListener.cs @@ -1,12 +1,12 @@ // // HttpListener.cs -// Copied from System.Net.HttpListener +// Copied from System.Net.HttpListener.cs // // Author: // Gonzalo Paniagua Javier (gonzalo@novell.com) // // Copyright (c) 2005 Novell, Inc. (http://www.novell.com) -// Copyright (c) 2012 sta.blockhead (sta.blockhead@gmail.com) +// Copyright (c) 2012-2013 sta.blockhead (sta.blockhead@gmail.com) // // Permission is hereby granted, free of charge, to any person obtaining // a copy of this software and associated documentation files (the @@ -31,12 +31,14 @@ using System; using System.Collections; using System.Collections.Generic; -using System.Net; using System.Threading; // TODO: logging namespace WebSocketSharp.Net { + /// + /// Provides a simple, programmatically controlled HTTP listener. + /// public sealed class HttpListener : IDisposable { #region Fields @@ -58,6 +60,9 @@ namespace WebSocketSharp.Net { #region Constructor + /// + /// Initializes a new instance of the class. + /// public HttpListener () { prefixes = new HttpListenerPrefixCollection (this); @@ -72,8 +77,15 @@ namespace WebSocketSharp.Net { #region Properties - // TODO: Digest, NTLM and Negotiate require ControlPrincipal + /// + /// Gets or sets the scheme used to authenticate the clients. + /// + /// + /// One of the values that indicates the scheme used to + /// authenticate the clients. The default value is . + /// public AuthenticationSchemes AuthenticationSchemes { + // TODO: Digest, NTLM and Negotiate require ControlPrincipal get { return auth_schemes; } set { CheckDisposed (); @@ -81,6 +93,13 @@ namespace WebSocketSharp.Net { } } + /// + /// Gets or sets the delegate called to determine the scheme used to authenticate clients. + /// + /// + /// A delegate that invokes the method(s) used to select + /// an authentication scheme. The default value is . + /// public AuthenticationSchemeSelector AuthenticationSchemeSelectorDelegate { get { return auth_selector; } set { @@ -97,14 +116,32 @@ namespace WebSocketSharp.Net { } } + /// + /// Gets a value indicating whether the has been started. + /// + /// + /// true if the has been started; otherwise, false. + /// public bool IsListening { get { return listening; } } + /// + /// Gets a value indicating whether the can be used with the current operating system. + /// + /// + /// true. + /// public static bool IsSupported { get { return true; } } + /// + /// Gets the URI prefixes handled by the . + /// + /// + /// A that contains the URI prefixes. + /// public HttpListenerPrefixCollection Prefixes { get { CheckDisposed (); @@ -112,8 +149,14 @@ namespace WebSocketSharp.Net { } } - // TODO: Use this + /// + /// Gets or sets the name of the realm associated with the . + /// + /// + /// A that contains the name of the realm. + /// public string Realm { + // TODO: Use this get { return realm; } set { CheckDisposed (); @@ -121,8 +164,8 @@ namespace WebSocketSharp.Net { } } - // TODO: Support for NTLM needs some loving. public bool UnsafeConnectionNtlmAuthentication { + // TODO: Support for NTLM needs some loving. get { return unsafe_ntlm_auth; } set { CheckDisposed (); @@ -191,15 +234,6 @@ namespace WebSocketSharp.Net { return context; } - void IDisposable.Dispose () - { - if (disposed) - return; - - Close (true); //TODO: Should we force here or not? - disposed = true; - } - #endregion #region Internal Methods @@ -230,6 +264,7 @@ namespace WebSocketSharp.Net { wait_queue.RemoveAt (0); } } + if (ares != null) ares.Complete (context); } @@ -251,6 +286,7 @@ namespace WebSocketSharp.Net { { lock (((ICollection)registry).SyncRoot) registry.Remove (context); + lock (((ICollection)ctx_queue).SyncRoot) { int idx = ctx_queue.IndexOf (context); if (idx >= 0) @@ -260,20 +296,61 @@ namespace WebSocketSharp.Net { #endregion + #region Explicit Interface Implementation + + /// + /// Releases all resource used by the . + /// + void IDisposable.Dispose () + { + if (disposed) + return; + + Close (true); // TODO: Should we force here or not? + disposed = true; + } + + #endregion + #region Public Methods + /// + /// Shuts down the immediately. + /// public void Abort () { if (disposed) return; if (!listening) { + disposed = true; return; } Close (true); + disposed = true; } + /// + /// Begins getting an incoming request information asynchronously. + /// + /// + /// This asynchronous operation must be completed by calling the method. + /// Typically, the method is invoked by the delegate. + /// + /// + /// An that contains the status of the asynchronous operation. + /// + /// + /// An delegate that references the method(s) + /// called when the asynchronous operation completes. + /// + /// + /// An that contains a user defined object to pass to the delegate. + /// + /// + /// The has not been started or is stopped currently. + /// public IAsyncResult BeginGetContext (AsyncCallback callback, Object state) { CheckDisposed (); @@ -298,6 +375,9 @@ namespace WebSocketSharp.Net { return ares; } + /// + /// Shuts down the . + /// public void Close () { if (disposed) @@ -308,10 +388,31 @@ namespace WebSocketSharp.Net { return; } - Close (true); + Close (false); disposed = true; } + /// + /// Ends an asynchronous operation to get an incoming request information. + /// + /// + /// This method completes an asynchronous operation started by calling the method. + /// + /// + /// A that contains a client's request information. + /// + /// + /// An obtained by calling the method. + /// + /// + /// is . + /// + /// + /// was not obtained by calling the method. + /// + /// + /// The EndGetContext method was already called for the specified . + /// public HttpListenerContext EndGetContext (IAsyncResult asyncResult) { CheckDisposed (); @@ -321,8 +422,9 @@ namespace WebSocketSharp.Net { ListenerAsyncResult ares = asyncResult as ListenerAsyncResult; if (ares == null) throw new ArgumentException ("Wrong IAsyncResult.", "asyncResult"); + if (ares.EndCalled) - throw new ArgumentException ("Cannot reuse this IAsyncResult"); + throw new InvalidOperationException ("Cannot reuse this IAsyncResult."); ares.EndCalled = true; if (!ares.IsCompleted) @@ -339,6 +441,19 @@ namespace WebSocketSharp.Net { return context; // This will throw on error. } + /// + /// Gets an incoming request information. + /// + /// + /// This method waits for an incoming request and returns the request information + /// when received the request. + /// + /// + /// A that contains a client's request information. + /// + /// + /// The does not have any URI prefixes to listen on. + /// public HttpListenerContext GetContext () { // The prefixes are not checked when using the async interface!? @@ -350,6 +465,9 @@ namespace WebSocketSharp.Net { return EndGetContext (ares); } + /// + /// Starts to receive incoming requests. + /// public void Start () { CheckDisposed (); @@ -360,11 +478,17 @@ namespace WebSocketSharp.Net { listening = true; } + /// + /// Stops receiving incoming requests. + /// public void Stop () { CheckDisposed (); + if (!listening) + return; + + EndPointManager.RemoveListener (this); listening = false; - Close (false); } #endregion diff --git a/websocket-sharp/Net/ListenerAsyncResult.cs b/websocket-sharp/Net/ListenerAsyncResult.cs index 78f64438..fee4a4be 100644 --- a/websocket-sharp/Net/ListenerAsyncResult.cs +++ b/websocket-sharp/Net/ListenerAsyncResult.cs @@ -1,6 +1,6 @@ // // ListenerAsyncResult.cs -// Copied from System.Net.ListenerAsyncResult +// Copied from System.Net.ListenerAsyncResult.cs // // Authors: // Gonzalo Paniagua Javier (gonzalo@ximian.com) @@ -35,8 +35,14 @@ namespace WebSocketSharp.Net { class ListenerAsyncResult : IAsyncResult { + #region Private Static Field + static WaitCallback InvokeCB = new WaitCallback (InvokeCallback); + #endregion + + #region Private Fields + AsyncCallback cb; bool completed; HttpListenerContext context; @@ -47,9 +53,17 @@ namespace WebSocketSharp.Net { object state; bool synch; + #endregion + + #region Internal Fields + internal bool EndCalled; internal bool InGet; + #endregion + + #region Constructor + public ListenerAsyncResult (AsyncCallback cb, object state) { this.cb = cb; @@ -57,10 +71,15 @@ namespace WebSocketSharp.Net { this.locker = new object(); } + #endregion + + #region Properties + public object AsyncState { get { if (forward != null) return forward.AsyncState; + return state; } } @@ -74,7 +93,7 @@ namespace WebSocketSharp.Net { if (handle == null) handle = new ManualResetEvent (completed); } - + return handle; } } @@ -83,9 +102,9 @@ namespace WebSocketSharp.Net { get { if (forward != null) return forward.CompletedSynchronously; + return synch; } - } public bool IsCompleted { @@ -99,6 +118,10 @@ namespace WebSocketSharp.Net { } } + #endregion + + #region Private Method + static void InvokeCallback (object o) { ListenerAsyncResult ares = (ListenerAsyncResult) o; @@ -106,21 +129,28 @@ namespace WebSocketSharp.Net { InvokeCallback (ares.forward); return; } + try { ares.cb (ares); } catch { } } + #endregion + + #region Internal Methods + internal void Complete (Exception exc) { if (forward != null) { forward.Complete (exc); return; } + exception = exc; if (InGet && (exc is ObjectDisposedException)) exception = new HttpListenerException (500, "Listener closed"); + lock (locker) { completed = true; if (handle != null) @@ -142,6 +172,7 @@ namespace WebSocketSharp.Net { forward.Complete (context, synch); return; } + this.synch = synch; this.context = context; lock (locker) { @@ -156,10 +187,12 @@ namespace WebSocketSharp.Net { if (handle != null) forward.handle = handle; } + ListenerAsyncResult next = forward; for (int i = 0; next.forward != null; i++) { if (i > 20) Complete (new HttpListenerException (400, "Too many authentication errors")); + next = next.forward; } } else { @@ -177,10 +210,13 @@ namespace WebSocketSharp.Net { { if (forward != null) return forward.GetContext (); + if (exception != null) throw exception; return context; } + + #endregion } } diff --git a/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.dll b/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.dll index 25a32dc9..06855dcd 100755 Binary files a/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.dll and b/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.dll differ diff --git a/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.xml b/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.xml index 0630c4d6..40441524 100644 --- a/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.xml +++ b/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.xml @@ -1364,6 +1364,202 @@ A that contains a reason for stop. + + + Selects the authentication scheme for a instance. + + + One of the values that indicates the scheme used to authenticate the specified client request. + + + A that contains a client request information. + + + + + Contains the values of the schemes for authentication. + + + + + Indicates that no authentication is allowed. + + + + + Indicates digest authentication. + + + + + Indicates negotiating with the client to determine the authentication scheme. + + + + + Indicates NTLM authentication. + + + + + Indicates Windows authentication. + + + + + Indicates basic authentication. + + + + + Indicates anonymous authentication. + + + + + Provides a simple, programmatically controlled HTTP listener. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the scheme used to authenticate the clients. + + + One of the values that indicates the scheme used to + authenticate the clients. The default value is . + + + + + Gets or sets the delegate called to determine the scheme used to authenticate clients. + + + A delegate that invokes the method(s) used to select + an authentication scheme. The default value is . + + + + + Gets a value indicating whether the has been started. + + + true if the has been started; otherwise, false. + + + + + Gets a value indicating whether the can be used with the current operating system. + + + true. + + + + + Gets the URI prefixes handled by the . + + + A that contains the URI prefixes. + + + + + Gets or sets the name of the realm associated with the . + + + A that contains the name of the realm. + + + + + Releases all resource used by the . + + + + + Shuts down the immediately. + + + + + Begins getting an incoming request information asynchronously. + + + This asynchronous operation must be completed by calling the method. + Typically, the method is invoked by the delegate. + + + An that contains the status of the asynchronous operation. + + + An delegate that references the method(s) + called when the asynchronous operation completes. + + + An that contains a user defined object to pass to the delegate. + + + The has not been started or is stopped currently. + + + + + Shuts down the . + + + + + Ends an asynchronous operation to get an incoming request information. + + + This method completes an asynchronous operation started by calling the method. + + + A that contains a client's request information. + + + An obtained by calling the method. + + + is . + + + was not obtained by calling the method. + + + The EndGetContext method was already called for the specified . + + + + + Gets an incoming request information. + + + This method waits for an incoming request and returns the request information + when received the request. + + + A that contains a client's request information. + + + The does not have any URI prefixes to listen on. + + + + + Starts to receive incoming requests. + + + + + Stops receiving incoming requests. + + Decodes an HTML-encoded string and returns the decoded string. diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemeSelector.html b/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemeSelector.html index d84ded36..6a0abf94 100644 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemeSelector.html +++ b/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemeSelector.html @@ -207,8 +207,8 @@

AuthenticationSchemeSelector Delegate

- Documentation for this section has not yet been entered. -

+ Selects the authentication scheme for a WebSocketSharp.Net.HttpListener instance. +

Syntax

public delegate AuthenticationSchemes AuthenticationSchemeSelector (HttpListenerRequest httpRequest)
@@ -221,14 +221,14 @@ httpRequest
- Documentation for this section has not yet been entered. -
+ A WebSocketSharp.Net.HttpListenerRequest that contains a client request information. +

Returns

- Documentation for this section has not yet been entered. -
+ One of the WebSocketSharp.Net.AuthenticationSchemes values that indicates the scheme used to authenticate the specified client request. +

Remarks

Documentation for this section has not yet been entered. diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemes.html b/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemes.html index e5e8e098..edacaf47 100644 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemes.html +++ b/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemes.html @@ -207,8 +207,8 @@

AuthenticationSchemes Enum

- Documentation for this section has not yet been entered. -

+ Contains the values of the schemes for authentication. +

Syntax

[System.Flags]
public enum AuthenticationSchemes
@@ -230,7 +230,7 @@ Anonymous - Documentation for this section has not yet been entered. + Indicates anonymous authentication. @@ -238,7 +238,7 @@ Basic - Documentation for this section has not yet been entered. + Indicates basic authentication. @@ -246,7 +246,7 @@ Digest - Documentation for this section has not yet been entered. + Indicates digest authentication. @@ -254,7 +254,7 @@ IntegratedWindowsAuthentication - Documentation for this section has not yet been entered. + Indicates Windows authentication. @@ -262,7 +262,7 @@ Negotiate - Documentation for this section has not yet been entered. + Indicates negotiating with the client to determine the authentication scheme. @@ -270,7 +270,7 @@ None - Documentation for this section has not yet been entered. + Indicates that no authentication is allowed. @@ -278,7 +278,7 @@ Ntlm - Documentation for this section has not yet been entered. + Indicates NTLM authentication. diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListener.html b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListener.html index d8766d31..277e81d6 100644 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListener.html +++ b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListener.html @@ -207,8 +207,8 @@

HttpListener Class

- Documentation for this section has not yet been entered. -

+ Provides a simple, programmatically controlled HTTP listener. +

Syntax

public sealed class HttpListener : IDisposable
@@ -243,8 +243,8 @@ ()
- Documentation for this section has not yet been entered. - + Initializes a new instance of the WebSocketSharp.Net.HttpListener class. +
@@ -266,7 +266,9 @@ AuthenticationSchemes - . Documentation for this section has not yet been entered. + . + Gets or sets the scheme used to authenticate the clients. + @@ -281,7 +283,9 @@ AuthenticationSchemeSelector - . Documentation for this section has not yet been entered. + . + Gets or sets the delegate called to determine the scheme used to authenticate clients. + @@ -308,7 +312,9 @@ bool - . Documentation for this section has not yet been entered. + . + Gets a value indicating whether the WebSocketSharp.Net.HttpListener has been started. + [read-only]
static
@@ -320,7 +326,9 @@ bool - . Documentation for this section has not yet been entered. + . + Gets a value indicating whether the WebSocketSharp.Net.HttpListener can be used with the current operating system. + [read-only]
@@ -332,7 +340,9 @@ HttpListenerPrefixCollection - . Documentation for this section has not yet been entered. + . + Gets the URI prefixes handled by the WebSocketSharp.Net.HttpListener. + @@ -347,7 +357,9 @@ string - . Documentation for this section has not yet been entered. + . + Gets or sets the name of the realm associated with the WebSocketSharp.Net.HttpListener. + @@ -379,7 +391,9 @@ Abort - ()
Documentation for this section has not yet been entered.
+ ()
+ Shuts down the WebSocketSharp.Net.HttpListener immediately. +
@@ -389,7 +403,9 @@ BeginGetContext - (AsyncCallback, object) : IAsyncResult
Documentation for this section has not yet been entered.
+ (AsyncCallback, object) : IAsyncResult
+ Begins getting an incoming request information asynchronously. +
@@ -399,7 +415,9 @@ Close - ()
Documentation for this section has not yet been entered.
+ ()
+ Shuts down the WebSocketSharp.Net.HttpListener. +
@@ -409,7 +427,9 @@ EndGetContext - (IAsyncResult) : HttpListenerContext
Documentation for this section has not yet been entered.
+ (IAsyncResult) : HttpListenerContext
+ Ends an asynchronous operation to get an incoming request information. +
@@ -419,7 +439,9 @@ GetContext - () : HttpListenerContext
Documentation for this section has not yet been entered.
+ () : HttpListenerContext
+ Gets an incoming request information. +
@@ -429,7 +451,9 @@ Start - ()
Documentation for this section has not yet been entered.
+ ()
+ Starts to receive incoming requests. +
@@ -439,7 +463,9 @@ Stop - ()
Documentation for this section has not yet been entered.
+ ()
+ Stops receiving incoming requests. +
@@ -459,8 +485,8 @@ - Documentation for this section has not yet been entered. - + Releases all resource used by the WebSocketSharp.Net.HttpListener. + @@ -503,8 +529,8 @@

HttpListener Constructor

- Documentation for this section has not yet been entered. -

+ Initializes a new instance of the WebSocketSharp.Net.HttpListener class. +

Syntax

public HttpListener ()

Remarks

@@ -519,8 +545,8 @@

Abort Method

- Documentation for this section has not yet been entered. -

+ Shuts down the WebSocketSharp.Net.HttpListener immediately. +

Syntax

public void Abort ()

Remarks

@@ -535,14 +561,15 @@

AuthenticationSchemes Property

- Documentation for this section has not yet been entered. -

+ Gets or sets the scheme used to authenticate the clients. +

Syntax

public AuthenticationSchemes AuthenticationSchemes { get; set; }

Value

- Documentation for this section has not yet been entered. -
+ One of the WebSocketSharp.Net.AuthenticationSchemes values that indicates the scheme used to + authenticate the clients. The default value is AuthenticationSchemes.Anonymous. +

Remarks

Documentation for this section has not yet been entered. @@ -555,14 +582,15 @@

AuthenticationSchemeSelectorDelegate Property

- Documentation for this section has not yet been entered. -

+ Gets or sets the delegate called to determine the scheme used to authenticate clients. +

Syntax

public AuthenticationSchemeSelector AuthenticationSchemeSelectorDelegate { get; set; }

Value

- Documentation for this section has not yet been entered. -
+ A WebSocketSharp.Net.AuthenticationSchemeSelector delegate that invokes the method(s) used to select + an authentication scheme. The default value is null. +

Remarks

Documentation for this section has not yet been entered. @@ -575,8 +603,8 @@

BeginGetContext Method

- Documentation for this section has not yet been entered. -

+ Begins getting an incoming request information asynchronously. +

Syntax

public IAsyncResult BeginGetContext (AsyncCallback callback, object state)

Parameters

@@ -586,24 +614,43 @@ callback
- Documentation for this section has not yet been entered. -
+ An AsyncCallback delegate that references the method(s) + called when the asynchronous operation completes. +
state
- Documentation for this section has not yet been entered. -
+ An object that contains a user defined object to pass to the callback delegate. +

Returns

- Documentation for this section has not yet been entered. + An IAsyncResult that contains the status of the asynchronous operation. +
+

Exceptions

+
+ + + + + + + + + +
TypeReason
+ InvalidOperationException + + The WebSocketSharp.Net.HttpListener has not been started or is stopped currently. +

Remarks

- Documentation for this section has not yet been entered. -
+ This asynchronous operation must be completed by calling the HttpListener.EndGetContext(IAsyncResult) method. + Typically, the method is invoked by the callback delegate. +

Requirements

Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
@@ -612,8 +659,8 @@

Close Method

- Documentation for this section has not yet been entered. -

+ Shuts down the WebSocketSharp.Net.HttpListener. +

Syntax

public void Close ()

Remarks

@@ -628,8 +675,8 @@

EndGetContext Method

- Documentation for this section has not yet been entered. -

+ Ends an asynchronous operation to get an incoming request information. +

Syntax

public HttpListenerContext EndGetContext (IAsyncResult asyncResult)

Parameters

@@ -639,18 +686,51 @@ asyncResult
- Documentation for this section has not yet been entered. -
+ An IAsyncResult obtained by calling the HttpListener.BeginGetContext(AsyncCallback, object) method. +

Returns

- Documentation for this section has not yet been entered. + A WebSocketSharp.Net.HttpListenerContext that contains a client's request information. +
+

Exceptions

+
+ + + + + + + + + + + + + + + + + +
TypeReason
+ ArgumentNullException + + asyncResult is null. +
+ ArgumentException + + asyncResult was not obtained by calling the HttpListener.BeginGetContext(AsyncCallback, object) method. +
+ InvalidOperationException + + The EndGetContext method was already called for the specified asyncResult. +

Remarks

- Documentation for this section has not yet been entered. -
+ This method completes an asynchronous operation started by calling the HttpListener.BeginGetContext(AsyncCallback, object) method. +

Requirements

Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
@@ -659,18 +739,36 @@

GetContext Method

- Documentation for this section has not yet been entered. -

+ Gets an incoming request information. +

Syntax

public HttpListenerContext GetContext ()

Returns

- Documentation for this section has not yet been entered. + A WebSocketSharp.Net.HttpListenerContext that contains a client's request information. +
+

Exceptions

+
+ + + + + + + + + +
TypeReason
+ InvalidOperationException + + The WebSocketSharp.Net.HttpListener does not have any URI prefixes to listen on. +

Remarks

- Documentation for this section has not yet been entered. -
+ This method waits for an incoming request and returns the request information + when received the request. +

Requirements

Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
@@ -699,14 +797,14 @@

IsListening Property

- Documentation for this section has not yet been entered. -

+ Gets a value indicating whether the WebSocketSharp.Net.HttpListener has been started. +

Syntax

public bool IsListening { get; }

Value

- Documentation for this section has not yet been entered. -
+ true if the WebSocketSharp.Net.HttpListener has been started; otherwise, false. +

Remarks

Documentation for this section has not yet been entered. @@ -719,14 +817,14 @@

IsSupported Property

- Documentation for this section has not yet been entered. -

+ Gets a value indicating whether the WebSocketSharp.Net.HttpListener can be used with the current operating system. +

Syntax

public static bool IsSupported { get; }

Value

- Documentation for this section has not yet been entered. -
+ true. +

Remarks

Documentation for this section has not yet been entered. @@ -739,14 +837,14 @@

Prefixes Property

- Documentation for this section has not yet been entered. -

+ Gets the URI prefixes handled by the WebSocketSharp.Net.HttpListener. +

Syntax

public HttpListenerPrefixCollection Prefixes { get; }

Value

- Documentation for this section has not yet been entered. -
+ A WebSocketSharp.Net.HttpListenerPrefixCollection that contains the URI prefixes. +

Remarks

Documentation for this section has not yet been entered. @@ -759,14 +857,14 @@

Realm Property

- Documentation for this section has not yet been entered. -

+ Gets or sets the name of the realm associated with the WebSocketSharp.Net.HttpListener. +

Syntax

public string Realm { get; set; }

Value

- Documentation for this section has not yet been entered. -
+ A string that contains the name of the realm. +

Remarks

Documentation for this section has not yet been entered. @@ -779,8 +877,8 @@

Start Method

- Documentation for this section has not yet been entered. -

+ Starts to receive incoming requests. +

Syntax

public void Start ()

Remarks

@@ -795,8 +893,8 @@

Stop Method

- Documentation for this section has not yet been entered. -

+ Stops receiving incoming requests. +

Syntax

public void Stop ()

Remarks

@@ -811,8 +909,8 @@

System.IDisposable.Dispose Method

- Documentation for this section has not yet been entered. -

+ Releases all resource used by the WebSocketSharp.Net.HttpListener. +

Syntax

void System.IDisposable.Dispose ()
diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/index.html b/websocket-sharp/doc/html/WebSocketSharp.Net/index.html index 77a44458..db8dd350 100644 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/index.html +++ b/websocket-sharp/doc/html/WebSocketSharp.Net/index.html @@ -207,16 +207,16 @@ AuthenticationSchemes - Documentation for this section has not yet been entered. - + Contains the values of the schemes for authentication. + AuthenticationSchemeSelector - Documentation for this section has not yet been entered. - + Selects the authentication scheme for a WebSocketSharp.Net.HttpListener instance. + @@ -247,8 +247,8 @@ HttpListener - Documentation for this section has not yet been entered. - + Provides a simple, programmatically controlled HTTP listener. + diff --git a/websocket-sharp/doc/html/index.html b/websocket-sharp/doc/html/index.html index 795907d4..874ef5c5 100644 --- a/websocket-sharp/doc/html/index.html +++ b/websocket-sharp/doc/html/index.html @@ -299,16 +299,16 @@ AuthenticationSchemes - Documentation for this section has not yet been entered. - + Contains the values of the schemes for authentication. + AuthenticationSchemeSelector - Documentation for this section has not yet been entered. - + Selects the authentication scheme for a WebSocketSharp.Net.HttpListener instance. + @@ -339,8 +339,8 @@ HttpListener - Documentation for this section has not yet been entered. - + Provides a simple, programmatically controlled HTTP listener. + diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemeSelector.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemeSelector.xml index ca7db288..2d9ce538 100644 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemeSelector.xml +++ b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemeSelector.xml @@ -14,9 +14,15 @@ WebSocketSharp.Net.AuthenticationSchemes - To be added. - To be added. - To be added. + + A that contains a client request information. + + + Selects the authentication scheme for a instance. + + + One of the values that indicates the scheme used to authenticate the specified client request. + To be added. diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemes.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemes.xml index 8ada0a06..1507c035 100644 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemes.xml +++ b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemes.xml @@ -13,7 +13,9 @@ - To be added. + + Contains the values of the schemes for authentication. + To be added. @@ -25,7 +27,9 @@ WebSocketSharp.Net.AuthenticationSchemes - To be added. + + Indicates anonymous authentication. + @@ -36,7 +40,9 @@ WebSocketSharp.Net.AuthenticationSchemes - To be added. + + Indicates basic authentication. + @@ -47,7 +53,9 @@ WebSocketSharp.Net.AuthenticationSchemes - To be added. + + Indicates digest authentication. + @@ -58,7 +66,9 @@ WebSocketSharp.Net.AuthenticationSchemes - To be added. + + Indicates Windows authentication. + @@ -69,7 +79,9 @@ WebSocketSharp.Net.AuthenticationSchemes - To be added. + + Indicates negotiating with the client to determine the authentication scheme. + @@ -80,7 +92,9 @@ WebSocketSharp.Net.AuthenticationSchemes - To be added. + + Indicates that no authentication is allowed. + @@ -91,7 +105,9 @@ WebSocketSharp.Net.AuthenticationSchemes - To be added. + + Indicates NTLM authentication. + diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListener.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListener.xml index 05d80175..244acf07 100644 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListener.xml +++ b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListener.xml @@ -13,7 +13,9 @@ - To be added. + + Provides a simple, programmatically controlled HTTP listener. + To be added. @@ -23,7 +25,9 @@ Constructor - To be added. + + Initializes a new instance of the class. + To be added. @@ -36,7 +40,9 @@ - To be added. + + Shuts down the immediately. + To be added. @@ -48,8 +54,13 @@ WebSocketSharp.Net.AuthenticationSchemes - To be added. - To be added. + + Gets or sets the scheme used to authenticate the clients. + + + One of the values that indicates the scheme used to + authenticate the clients. The default value is . + To be added. @@ -61,8 +72,13 @@ WebSocketSharp.Net.AuthenticationSchemeSelector - To be added. - To be added. + + Gets or sets the delegate called to determine the scheme used to authenticate clients. + + + A delegate that invokes the method(s) used to select + an authentication scheme. The default value is . + To be added. @@ -78,11 +94,26 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + + An delegate that references the method(s) + called when the asynchronous operation completes. + + + An that contains a user defined object to pass to the delegate. + + + Begins getting an incoming request information asynchronously. + + + An that contains the status of the asynchronous operation. + + + This asynchronous operation must be completed by calling the method. + Typically, the method is invoked by the delegate. + + + The has not been started or is stopped currently. + @@ -94,7 +125,9 @@ - To be added. + + Shuts down the . + To be added. @@ -109,10 +142,27 @@ - To be added. - To be added. - To be added. - To be added. + + An obtained by calling the method. + + + Ends an asynchronous operation to get an incoming request information. + + + A that contains a client's request information. + + + This method completes an asynchronous operation started by calling the method. + + + is . + + + was not obtained by calling the method. + + + The EndGetContext method was already called for the specified . + @@ -124,9 +174,19 @@ - To be added. - To be added. - To be added. + + Gets an incoming request information. + + + A that contains a client's request information. + + + This method waits for an incoming request and returns the request information + when received the request. + + + The does not have any URI prefixes to listen on. + @@ -150,8 +210,12 @@ System.Boolean - To be added. - To be added. + + Gets a value indicating whether the has been started. + + + true if the has been started; otherwise, false. + To be added. @@ -163,8 +227,12 @@ System.Boolean - To be added. - To be added. + + Gets a value indicating whether the can be used with the current operating system. + + + true. + To be added. @@ -176,8 +244,12 @@ WebSocketSharp.Net.HttpListenerPrefixCollection - To be added. - To be added. + + Gets the URI prefixes handled by the . + + + A that contains the URI prefixes. + To be added. @@ -189,8 +261,12 @@ System.String - To be added. - To be added. + + Gets or sets the name of the realm associated with the . + + + A that contains the name of the realm. + To be added. @@ -203,7 +279,9 @@ - To be added. + + Starts to receive incoming requests. + To be added. @@ -216,7 +294,9 @@ - To be added. + + Stops receiving incoming requests. + To be added. @@ -229,7 +309,9 @@ - To be added. + + Releases all resource used by the . + To be added. diff --git a/websocket-sharp/doc/mdoc/index.xml b/websocket-sharp/doc/mdoc/index.xml index 8267cddc..0bee7d1f 100644 --- a/websocket-sharp/doc/mdoc/index.xml +++ b/websocket-sharp/doc/mdoc/index.xml @@ -1,6 +1,6 @@ - + [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 ] diff --git a/websocket-sharp/websocket-sharp.pidb b/websocket-sharp/websocket-sharp.pidb index 8aba8585..7c3f3d2d 100644 Binary files a/websocket-sharp/websocket-sharp.pidb and b/websocket-sharp/websocket-sharp.pidb differ