Added some XML documentation comments
This commit is contained in:
parent
9b1772e80a
commit
d3c21db2e3
Binary file not shown.
@ -1,5 +1,5 @@
|
||||
<Properties>
|
||||
<MonoDevelop.Ide.Workspace ActiveConfiguration="Debug_Ubuntu" />
|
||||
<MonoDevelop.Ide.Workspace ActiveConfiguration="Release_Ubuntu" />
|
||||
<MonoDevelop.Ide.Workbench />
|
||||
<MonoDevelop.Ide.DebuggingService.Breakpoints>
|
||||
<BreakpointStore />
|
||||
|
@ -1,6 +1,6 @@
|
||||
//
|
||||
// AuthenticationSchemeSelector.cs
|
||||
// Copied from System.Net.AuthenticationSchemeSelector
|
||||
// Copied from System.Net.AuthenticationSchemeSelector.cs
|
||||
//
|
||||
// Author:
|
||||
// Gonzalo Paniagua Javier <gonzalo@novell.com>
|
||||
@ -31,5 +31,14 @@ using System;
|
||||
|
||||
namespace WebSocketSharp.Net {
|
||||
|
||||
/// <summary>
|
||||
/// Selects the authentication scheme for a <see cref="HttpListener"/> instance.
|
||||
/// </summary>
|
||||
/// <returns>
|
||||
/// One of the <see cref="AuthenticationSchemes"/> values that indicates the scheme used to authenticate the specified client request.
|
||||
/// </returns>
|
||||
/// <param name="httpRequest">
|
||||
/// A <see cref="HttpListenerRequest"/> that contains a client request information.
|
||||
/// </param>
|
||||
public delegate AuthenticationSchemes AuthenticationSchemeSelector (HttpListenerRequest httpRequest);
|
||||
}
|
||||
|
@ -1,6 +1,6 @@
|
||||
//
|
||||
// AuthenticationSchemes.cs
|
||||
// Copied from System.Net.AuthenticationSchemes
|
||||
// Copied from System.Net.AuthenticationSchemes.cs
|
||||
//
|
||||
// Author:
|
||||
// Atsushi Enomoto <atsushi@ximian.com>
|
||||
@ -31,15 +31,39 @@ using System;
|
||||
|
||||
namespace WebSocketSharp.Net {
|
||||
|
||||
/// <summary>
|
||||
/// Contains the values of the schemes for authentication.
|
||||
/// </summary>
|
||||
[Flags]
|
||||
public enum AuthenticationSchemes {
|
||||
|
||||
/// <summary>
|
||||
/// Indicates that no authentication is allowed.
|
||||
/// </summary>
|
||||
None,
|
||||
/// <summary>
|
||||
/// Indicates digest authentication.
|
||||
/// </summary>
|
||||
Digest = 1,
|
||||
/// <summary>
|
||||
/// Indicates negotiating with the client to determine the authentication scheme.
|
||||
/// </summary>
|
||||
Negotiate = 2,
|
||||
/// <summary>
|
||||
/// Indicates NTLM authentication.
|
||||
/// </summary>
|
||||
Ntlm = 4,
|
||||
/// <summary>
|
||||
/// Indicates Windows authentication.
|
||||
/// </summary>
|
||||
IntegratedWindowsAuthentication = 6,
|
||||
/// <summary>
|
||||
/// Indicates basic authentication.
|
||||
/// </summary>
|
||||
Basic = 8,
|
||||
/// <summary>
|
||||
/// Indicates anonymous authentication.
|
||||
/// </summary>
|
||||
Anonymous = 0x8000,
|
||||
}
|
||||
}
|
||||
|
@ -1,6 +1,6 @@
|
||||
//
|
||||
// EndPointListener.cs
|
||||
// Copied from System.Net.EndPointListener
|
||||
// Copied from System.Net.EndPointListener.cs
|
||||
//
|
||||
// Author:
|
||||
// Gonzalo Paniagua Javier (gonzalo@novell.com)
|
||||
|
@ -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 {
|
||||
|
||||
/// <summary>
|
||||
/// Provides a simple, programmatically controlled HTTP listener.
|
||||
/// </summary>
|
||||
public sealed class HttpListener : IDisposable {
|
||||
|
||||
#region Fields
|
||||
@ -58,6 +60,9 @@ namespace WebSocketSharp.Net {
|
||||
|
||||
#region Constructor
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="HttpListener"/> class.
|
||||
/// </summary>
|
||||
public HttpListener ()
|
||||
{
|
||||
prefixes = new HttpListenerPrefixCollection (this);
|
||||
@ -72,8 +77,15 @@ namespace WebSocketSharp.Net {
|
||||
|
||||
#region Properties
|
||||
|
||||
// TODO: Digest, NTLM and Negotiate require ControlPrincipal
|
||||
/// <summary>
|
||||
/// Gets or sets the scheme used to authenticate the clients.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// One of the <see cref="AuthenticationSchemes"/> values that indicates the scheme used to
|
||||
/// authenticate the clients. The default value is <see cref="AuthenticationSchemes.Anonymous"/>.
|
||||
/// </value>
|
||||
public AuthenticationSchemes AuthenticationSchemes {
|
||||
// TODO: Digest, NTLM and Negotiate require ControlPrincipal
|
||||
get { return auth_schemes; }
|
||||
set {
|
||||
CheckDisposed ();
|
||||
@ -81,6 +93,13 @@ namespace WebSocketSharp.Net {
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the delegate called to determine the scheme used to authenticate clients.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="AuthenticationSchemeSelector"/> delegate that invokes the method(s) used to select
|
||||
/// an authentication scheme. The default value is <see langword="null"/>.
|
||||
/// </value>
|
||||
public AuthenticationSchemeSelector AuthenticationSchemeSelectorDelegate {
|
||||
get { return auth_selector; }
|
||||
set {
|
||||
@ -97,14 +116,32 @@ namespace WebSocketSharp.Net {
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the <see cref="HttpListener"/> has been started.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// <c>true</c> if the <see cref="HttpListener"/> has been started; otherwise, <c>false</c>.
|
||||
/// </value>
|
||||
public bool IsListening {
|
||||
get { return listening; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the <see cref="HttpListener"/> can be used with the current operating system.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// <c>true</c>.
|
||||
/// </value>
|
||||
public static bool IsSupported {
|
||||
get { return true; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the URI prefixes handled by the <see cref="HttpListener"/>.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="HttpListenerPrefixCollection"/> that contains the URI prefixes.
|
||||
/// </value>
|
||||
public HttpListenerPrefixCollection Prefixes {
|
||||
get {
|
||||
CheckDisposed ();
|
||||
@ -112,8 +149,14 @@ namespace WebSocketSharp.Net {
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: Use this
|
||||
/// <summary>
|
||||
/// Gets or sets the name of the realm associated with the <see cref="HttpListener"/>.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="string"/> that contains the name of the realm.
|
||||
/// </value>
|
||||
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
|
||||
|
||||
/// <summary>
|
||||
/// Releases all resource used by the <see cref="HttpListener"/>.
|
||||
/// </summary>
|
||||
void IDisposable.Dispose ()
|
||||
{
|
||||
if (disposed)
|
||||
return;
|
||||
|
||||
Close (true); // TODO: Should we force here or not?
|
||||
disposed = true;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Public Methods
|
||||
|
||||
/// <summary>
|
||||
/// Shuts down the <see cref="HttpListener"/> immediately.
|
||||
/// </summary>
|
||||
public void Abort ()
|
||||
{
|
||||
if (disposed)
|
||||
return;
|
||||
|
||||
if (!listening) {
|
||||
disposed = true;
|
||||
return;
|
||||
}
|
||||
|
||||
Close (true);
|
||||
disposed = true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Begins getting an incoming request information asynchronously.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This asynchronous operation must be completed by calling the <see cref="EndGetContext"/> method.
|
||||
/// Typically, the method is invoked by the <paramref name="callback"/> delegate.
|
||||
/// </remarks>
|
||||
/// <returns>
|
||||
/// An <see cref="IAsyncResult"/> that contains the status of the asynchronous operation.
|
||||
/// </returns>
|
||||
/// <param name="callback">
|
||||
/// An <see cref="AsyncCallback"/> delegate that references the method(s)
|
||||
/// called when the asynchronous operation completes.
|
||||
/// </param>
|
||||
/// <param name="state">
|
||||
/// An <see cref="object"/> that contains a user defined object to pass to the <paramref name="callback"/> delegate.
|
||||
/// </param>
|
||||
/// <exception cref="InvalidOperationException">
|
||||
/// The <see cref="HttpListener"/> has not been started or is stopped currently.
|
||||
/// </exception>
|
||||
public IAsyncResult BeginGetContext (AsyncCallback callback, Object state)
|
||||
{
|
||||
CheckDisposed ();
|
||||
@ -298,6 +375,9 @@ namespace WebSocketSharp.Net {
|
||||
return ares;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Shuts down the <see cref="HttpListener"/>.
|
||||
/// </summary>
|
||||
public void Close ()
|
||||
{
|
||||
if (disposed)
|
||||
@ -308,10 +388,31 @@ namespace WebSocketSharp.Net {
|
||||
return;
|
||||
}
|
||||
|
||||
Close (true);
|
||||
Close (false);
|
||||
disposed = true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Ends an asynchronous operation to get an incoming request information.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method completes an asynchronous operation started by calling the <see cref="BeginGetContext"/> method.
|
||||
/// </remarks>
|
||||
/// <returns>
|
||||
/// A <see cref="HttpListenerContext"/> that contains a client's request information.
|
||||
/// </returns>
|
||||
/// <param name="asyncResult">
|
||||
/// An <see cref="IAsyncResult"/> obtained by calling the <see cref="BeginGetContext"/> method.
|
||||
/// </param>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="asyncResult"/> is <see langword="null"/>.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <paramref name="asyncResult"/> was not obtained by calling the <see cref="BeginGetContext"/> method.
|
||||
/// </exception>
|
||||
/// <exception cref="InvalidOperationException">
|
||||
/// The EndGetContext method was already called for the specified <paramref name="asyncResult"/>.
|
||||
/// </exception>
|
||||
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.
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets an incoming request information.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method waits for an incoming request and returns the request information
|
||||
/// when received the request.
|
||||
/// </remarks>
|
||||
/// <returns>
|
||||
/// A <see cref="HttpListenerContext"/> that contains a client's request information.
|
||||
/// </returns>
|
||||
/// <exception cref="InvalidOperationException">
|
||||
/// The <see cref="HttpListener"/> does not have any URI prefixes to listen on.
|
||||
/// </exception>
|
||||
public HttpListenerContext GetContext ()
|
||||
{
|
||||
// The prefixes are not checked when using the async interface!?
|
||||
@ -350,6 +465,9 @@ namespace WebSocketSharp.Net {
|
||||
return EndGetContext (ares);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts to receive incoming requests.
|
||||
/// </summary>
|
||||
public void Start ()
|
||||
{
|
||||
CheckDisposed ();
|
||||
@ -360,11 +478,17 @@ namespace WebSocketSharp.Net {
|
||||
listening = true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Stops receiving incoming requests.
|
||||
/// </summary>
|
||||
public void Stop ()
|
||||
{
|
||||
CheckDisposed ();
|
||||
if (!listening)
|
||||
return;
|
||||
|
||||
EndPointManager.RemoveListener (this);
|
||||
listening = false;
|
||||
Close (false);
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
@ -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
|
||||
}
|
||||
}
|
||||
|
Binary file not shown.
@ -1364,6 +1364,202 @@
|
||||
A <see cref="T:System.String" /> that contains a reason for stop.
|
||||
</param>
|
||||
</member>
|
||||
<member name="T:WebSocketSharp.Net.AuthenticationSchemeSelector">
|
||||
<summary>
|
||||
Selects the authentication scheme for a <see cref="T:WebSocketSharp.Net.HttpListener" /> instance.
|
||||
</summary>
|
||||
<returns>
|
||||
One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes" /> values that indicates the scheme used to authenticate the specified client request.
|
||||
</returns>
|
||||
<param name="httpRequest">
|
||||
A <see cref="T:WebSocketSharp.Net.HttpListenerRequest" /> that contains a client request information.
|
||||
</param>
|
||||
</member>
|
||||
<member name="T:WebSocketSharp.Net.AuthenticationSchemes">
|
||||
<summary>
|
||||
Contains the values of the schemes for authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:WebSocketSharp.Net.AuthenticationSchemes.None">
|
||||
<summary>
|
||||
Indicates that no authentication is allowed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:WebSocketSharp.Net.AuthenticationSchemes.Digest">
|
||||
<summary>
|
||||
Indicates digest authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:WebSocketSharp.Net.AuthenticationSchemes.Negotiate">
|
||||
<summary>
|
||||
Indicates negotiating with the client to determine the authentication scheme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:WebSocketSharp.Net.AuthenticationSchemes.Ntlm">
|
||||
<summary>
|
||||
Indicates NTLM authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:WebSocketSharp.Net.AuthenticationSchemes.IntegratedWindowsAuthentication">
|
||||
<summary>
|
||||
Indicates Windows authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:WebSocketSharp.Net.AuthenticationSchemes.Basic">
|
||||
<summary>
|
||||
Indicates basic authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous">
|
||||
<summary>
|
||||
Indicates anonymous authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:WebSocketSharp.Net.HttpListener">
|
||||
<summary>
|
||||
Provides a simple, programmatically controlled HTTP listener.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpListener.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListener" /> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes">
|
||||
<summary>
|
||||
Gets or sets the scheme used to authenticate the clients.
|
||||
</summary>
|
||||
<value>
|
||||
One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes" /> values that indicates the scheme used to
|
||||
authenticate the clients. The default value is <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemeSelectorDelegate">
|
||||
<summary>
|
||||
Gets or sets the delegate called to determine the scheme used to authenticate clients.
|
||||
</summary>
|
||||
<value>
|
||||
A <see cref="T:WebSocketSharp.Net.AuthenticationSchemeSelector" /> delegate that invokes the method(s) used to select
|
||||
an authentication scheme. The default value is <see langword="null" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:WebSocketSharp.Net.HttpListener.IsListening">
|
||||
<summary>
|
||||
Gets a value indicating whether the <see cref="T:WebSocketSharp.Net.HttpListener" /> has been started.
|
||||
</summary>
|
||||
<value>
|
||||
<c>true</c> if the <see cref="T:WebSocketSharp.Net.HttpListener" /> has been started; otherwise, <c>false</c>.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:WebSocketSharp.Net.HttpListener.IsSupported">
|
||||
<summary>
|
||||
Gets a value indicating whether the <see cref="T:WebSocketSharp.Net.HttpListener" /> can be used with the current operating system.
|
||||
</summary>
|
||||
<value>
|
||||
<c>true</c>.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:WebSocketSharp.Net.HttpListener.Prefixes">
|
||||
<summary>
|
||||
Gets the URI prefixes handled by the <see cref="T:WebSocketSharp.Net.HttpListener" />.
|
||||
</summary>
|
||||
<value>
|
||||
A <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection" /> that contains the URI prefixes.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:WebSocketSharp.Net.HttpListener.Realm">
|
||||
<summary>
|
||||
Gets or sets the name of the realm associated with the <see cref="T:WebSocketSharp.Net.HttpListener" />.
|
||||
</summary>
|
||||
<value>
|
||||
A <see cref="T:System.String" /> that contains the name of the realm.
|
||||
</value>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpListener.System#IDisposable#Dispose">
|
||||
<summary>
|
||||
Releases all resource used by the <see cref="T:WebSocketSharp.Net.HttpListener" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpListener.Abort">
|
||||
<summary>
|
||||
Shuts down the <see cref="T:WebSocketSharp.Net.HttpListener" /> immediately.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">
|
||||
<summary>
|
||||
Begins getting an incoming request information asynchronously.
|
||||
</summary>
|
||||
<remarks>
|
||||
This asynchronous operation must be completed by calling the <see cref="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)" /> method.
|
||||
Typically, the method is invoked by the <paramref name="callback" /> delegate.
|
||||
</remarks>
|
||||
<returns>
|
||||
An <see cref="T:System.IAsyncResult" /> that contains the status of the asynchronous operation.
|
||||
</returns>
|
||||
<param name="callback">
|
||||
An <see cref="T:System.AsyncCallback" /> delegate that references the method(s)
|
||||
called when the asynchronous operation completes.
|
||||
</param>
|
||||
<param name="state">
|
||||
An <see cref="T:System.Object" /> that contains a user defined object to pass to the <paramref name="callback" /> delegate.
|
||||
</param>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
The <see cref="T:WebSocketSharp.Net.HttpListener" /> has not been started or is stopped currently.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpListener.Close">
|
||||
<summary>
|
||||
Shuts down the <see cref="T:WebSocketSharp.Net.HttpListener" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)">
|
||||
<summary>
|
||||
Ends an asynchronous operation to get an incoming request information.
|
||||
</summary>
|
||||
<remarks>
|
||||
This method completes an asynchronous operation started by calling the <see cref="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)" /> method.
|
||||
</remarks>
|
||||
<returns>
|
||||
A <see cref="T:WebSocketSharp.Net.HttpListenerContext" /> that contains a client's request information.
|
||||
</returns>
|
||||
<param name="asyncResult">
|
||||
An <see cref="T:System.IAsyncResult" /> obtained by calling the <see cref="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)" /> method.
|
||||
</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="asyncResult" /> is <see langword="null" />.
|
||||
</exception>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
<paramref name="asyncResult" /> was not obtained by calling the <see cref="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)" /> method.
|
||||
</exception>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
The EndGetContext method was already called for the specified <paramref name="asyncResult" />.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpListener.GetContext">
|
||||
<summary>
|
||||
Gets an incoming request information.
|
||||
</summary>
|
||||
<remarks>
|
||||
This method waits for an incoming request and returns the request information
|
||||
when received the request.
|
||||
</remarks>
|
||||
<returns>
|
||||
A <see cref="T:WebSocketSharp.Net.HttpListenerContext" /> that contains a client's request information.
|
||||
</returns>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
The <see cref="T:WebSocketSharp.Net.HttpListener" /> does not have any URI prefixes to listen on.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpListener.Start">
|
||||
<summary>
|
||||
Starts to receive incoming requests.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpListener.Stop">
|
||||
<summary>
|
||||
Stops receiving incoming requests.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String)">
|
||||
<summary>
|
||||
Decodes an HTML-encoded string and returns the decoded string.
|
||||
|
@ -207,8 +207,8 @@
|
||||
</div>
|
||||
<h1 class="PageTitle" id="T:WebSocketSharp.Net.AuthenticationSchemeSelector">AuthenticationSchemeSelector Delegate</h1>
|
||||
<p class="Summary" id="T:WebSocketSharp.Net.AuthenticationSchemeSelector:Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Selects the authentication scheme for a <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> instance.
|
||||
</p>
|
||||
<div id="T:WebSocketSharp.Net.AuthenticationSchemeSelector:Signature">
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public delegate <a href="../WebSocketSharp.Net/AuthenticationSchemes.html">AuthenticationSchemes</a> <b>AuthenticationSchemeSelector</b> (<a href="../WebSocketSharp.Net/HttpListenerRequest.html">HttpListenerRequest</a> httpRequest)</div>
|
||||
@ -221,14 +221,14 @@
|
||||
<i>httpRequest</i>
|
||||
</dt>
|
||||
<dd>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</dd>
|
||||
A <a href="../WebSocketSharp.Net/HttpListenerRequest.html">WebSocketSharp.Net.HttpListenerRequest</a> that contains a client request information.
|
||||
</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<h4 class="Subsection">Returns</h4>
|
||||
<blockquote class="SubsectionBox" id="T:WebSocketSharp.Net.AuthenticationSchemeSelector:Docs:Returns">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</blockquote>
|
||||
One of the <a href="../WebSocketSharp.Net/AuthenticationSchemes.html">WebSocketSharp.Net.AuthenticationSchemes</a> values that indicates the scheme used to authenticate the specified client request.
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="T:WebSocketSharp.Net.AuthenticationSchemeSelector:Docs:Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
|
@ -207,8 +207,8 @@
|
||||
</div>
|
||||
<h1 class="PageTitle" id="T:WebSocketSharp.Net.AuthenticationSchemes">AuthenticationSchemes Enum</h1>
|
||||
<p class="Summary" id="T:WebSocketSharp.Net.AuthenticationSchemes:Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Contains the values of the schemes for authentication.
|
||||
</p>
|
||||
<div id="T:WebSocketSharp.Net.AuthenticationSchemes:Signature">
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">[System.Flags]<br />public enum <b>AuthenticationSchemes</b></div>
|
||||
@ -230,7 +230,7 @@
|
||||
<b>Anonymous</b>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
Indicates anonymous authentication.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
@ -238,7 +238,7 @@
|
||||
<b>Basic</b>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
Indicates basic authentication.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
@ -246,7 +246,7 @@
|
||||
<b>Digest</b>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
Indicates digest authentication.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
@ -254,7 +254,7 @@
|
||||
<b>IntegratedWindowsAuthentication</b>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
Indicates Windows authentication.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
@ -262,7 +262,7 @@
|
||||
<b>Negotiate</b>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
Indicates negotiating with the client to determine the authentication scheme.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
@ -270,7 +270,7 @@
|
||||
<b>None</b>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
Indicates that no authentication is allowed.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
@ -278,7 +278,7 @@
|
||||
<b>Ntlm</b>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
Indicates NTLM authentication.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
@ -207,8 +207,8 @@
|
||||
</div>
|
||||
<h1 class="PageTitle" id="T:WebSocketSharp.Net.HttpListener">HttpListener Class</h1>
|
||||
<p class="Summary" id="T:WebSocketSharp.Net.HttpListener:Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Provides a simple, programmatically controlled HTTP listener.
|
||||
</p>
|
||||
<div id="T:WebSocketSharp.Net.HttpListener:Signature">
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public sealed class <b>HttpListener</b> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IDisposable">IDisposable</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/HttpListener.html">WebSocketSharp.Net.HttpListener</a> class.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
@ -266,7 +266,9 @@
|
||||
<td>
|
||||
<i>
|
||||
<a href="../WebSocketSharp.Net/AuthenticationSchemes.html">AuthenticationSchemes</a>
|
||||
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
|
||||
</i>.
|
||||
Gets or sets the scheme used to authenticate the clients.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -281,7 +283,9 @@
|
||||
<td>
|
||||
<i>
|
||||
<a href="../WebSocketSharp.Net/AuthenticationSchemeSelector.html">AuthenticationSchemeSelector</a>
|
||||
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
|
||||
</i>.
|
||||
Gets or sets the delegate called to determine the scheme used to authenticate clients.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -308,7 +312,9 @@
|
||||
<td>
|
||||
<i>
|
||||
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
|
||||
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
|
||||
</i>.
|
||||
Gets a value indicating whether the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> has been started.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>[read-only]<div>static </div></td>
|
||||
@ -320,7 +326,9 @@
|
||||
<td>
|
||||
<i>
|
||||
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
|
||||
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
|
||||
</i>.
|
||||
Gets a value indicating whether the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> can be used with the current operating system.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>[read-only]<div></div></td>
|
||||
@ -332,7 +340,9 @@
|
||||
<td>
|
||||
<i>
|
||||
<a href="../WebSocketSharp.Net/HttpListenerPrefixCollection.html">HttpListenerPrefixCollection</a>
|
||||
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
|
||||
</i>.
|
||||
Gets the URI prefixes handled by the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -347,7 +357,9 @@
|
||||
<td>
|
||||
<i>
|
||||
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>
|
||||
</i>. <span class="NotEntered">Documentation for this section has not yet been entered.</span></td>
|
||||
</i>.
|
||||
Gets or sets the name of the realm associated with the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -379,7 +391,9 @@
|
||||
<td colspan="2">
|
||||
<b>
|
||||
<a href="#M:WebSocketSharp.Net.HttpListener.Abort">Abort</a>
|
||||
</b>()<blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
|
||||
</b>()<blockquote>
|
||||
Shuts down the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> immediately.
|
||||
</blockquote></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -389,7 +403,9 @@
|
||||
<td colspan="2">
|
||||
<b>
|
||||
<a href="#M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">BeginGetContext</a>
|
||||
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.AsyncCallback">AsyncCallback</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Object">object</a>)<nobr> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IAsyncResult">IAsyncResult</a></nobr><blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
|
||||
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.AsyncCallback">AsyncCallback</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Object">object</a>)<nobr> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IAsyncResult">IAsyncResult</a></nobr><blockquote>
|
||||
Begins getting an incoming request information asynchronously.
|
||||
</blockquote></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -399,7 +415,9 @@
|
||||
<td colspan="2">
|
||||
<b>
|
||||
<a href="#M:WebSocketSharp.Net.HttpListener.Close">Close</a>
|
||||
</b>()<blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
|
||||
</b>()<blockquote>
|
||||
Shuts down the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
|
||||
</blockquote></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -409,7 +427,9 @@
|
||||
<td colspan="2">
|
||||
<b>
|
||||
<a href="#M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)">EndGetContext</a>
|
||||
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IAsyncResult">IAsyncResult</a>)<nobr> : <a href="../WebSocketSharp.Net/HttpListenerContext.html">HttpListenerContext</a></nobr><blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
|
||||
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IAsyncResult">IAsyncResult</a>)<nobr> : <a href="../WebSocketSharp.Net/HttpListenerContext.html">HttpListenerContext</a></nobr><blockquote>
|
||||
Ends an asynchronous operation to get an incoming request information.
|
||||
</blockquote></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -419,7 +439,9 @@
|
||||
<td colspan="2">
|
||||
<b>
|
||||
<a href="#M:WebSocketSharp.Net.HttpListener.GetContext">GetContext</a>
|
||||
</b>()<nobr> : <a href="../WebSocketSharp.Net/HttpListenerContext.html">HttpListenerContext</a></nobr><blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
|
||||
</b>()<nobr> : <a href="../WebSocketSharp.Net/HttpListenerContext.html">HttpListenerContext</a></nobr><blockquote>
|
||||
Gets an incoming request information.
|
||||
</blockquote></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -429,7 +451,9 @@
|
||||
<td colspan="2">
|
||||
<b>
|
||||
<a href="#M:WebSocketSharp.Net.HttpListener.Start">Start</a>
|
||||
</b>()<blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
|
||||
</b>()<blockquote>
|
||||
Starts to receive incoming requests.
|
||||
</blockquote></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -439,7 +463,9 @@
|
||||
<td colspan="2">
|
||||
<b>
|
||||
<a href="#M:WebSocketSharp.Net.HttpListener.Stop">Stop</a>
|
||||
</b>()<blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
|
||||
</b>()<blockquote>
|
||||
Stops receiving incoming requests.
|
||||
</blockquote></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
@ -459,8 +485,8 @@
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</td>
|
||||
Releases all resource used by the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
@ -503,8 +529,8 @@
|
||||
<h3 id="C:WebSocketSharp.Net.HttpListener">HttpListener Constructor</h3>
|
||||
<blockquote id="C:WebSocketSharp.Net.HttpListener: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/HttpListener.html">WebSocketSharp.Net.HttpListener</a> class.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <b>HttpListener</b> ()</div>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
@ -519,8 +545,8 @@
|
||||
<h3 id="M:WebSocketSharp.Net.HttpListener.Abort">Abort Method</h3>
|
||||
<blockquote id="M:WebSocketSharp.Net.HttpListener.Abort:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Shuts down the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> immediately.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Abort</b> ()</div>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
@ -535,14 +561,15 @@
|
||||
<h3 id="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes">AuthenticationSchemes Property</h3>
|
||||
<blockquote id="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Gets or sets the scheme used to authenticate the clients.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="../WebSocketSharp.Net/AuthenticationSchemes.html">AuthenticationSchemes</a> <b>AuthenticationSchemes</b> { get; set; }</div>
|
||||
<h4 class="Subsection">Value</h4>
|
||||
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes:Value">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</blockquote>
|
||||
One of the <a href="../WebSocketSharp.Net/AuthenticationSchemes.html">WebSocketSharp.Net.AuthenticationSchemes</a> values that indicates the scheme used to
|
||||
authenticate the clients. The default value is <a href="../WebSocketSharp.Net/AuthenticationSchemes.html#F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous">AuthenticationSchemes.Anonymous</a>.
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes:Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
@ -555,14 +582,15 @@
|
||||
<h3 id="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemeSelectorDelegate">AuthenticationSchemeSelectorDelegate Property</h3>
|
||||
<blockquote id="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemeSelectorDelegate:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Gets or sets the delegate called to determine the scheme used to authenticate clients.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="../WebSocketSharp.Net/AuthenticationSchemeSelector.html">AuthenticationSchemeSelector</a> <b>AuthenticationSchemeSelectorDelegate</b> { get; set; }</div>
|
||||
<h4 class="Subsection">Value</h4>
|
||||
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemeSelectorDelegate:Value">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</blockquote>
|
||||
A <a href="../WebSocketSharp.Net/AuthenticationSchemeSelector.html">WebSocketSharp.Net.AuthenticationSchemeSelector</a> delegate that invokes the method(s) used to select
|
||||
an authentication scheme. The default value is <tt>null</tt>.
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemeSelectorDelegate:Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
@ -575,8 +603,8 @@
|
||||
<h3 id="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">BeginGetContext Method</h3>
|
||||
<blockquote id="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object):member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Begins getting an incoming request information asynchronously.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IAsyncResult">IAsyncResult</a> <b>BeginGetContext</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.AsyncCallback">AsyncCallback</a> callback, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Object">object</a> state)</div>
|
||||
<h4 class="Subsection">Parameters</h4>
|
||||
@ -586,24 +614,43 @@
|
||||
<i>callback</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.AsyncCallback">AsyncCallback</a> delegate that references the method(s)
|
||||
called when the asynchronous operation completes.
|
||||
</dd>
|
||||
<dt>
|
||||
<i>state</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.Object">object</a> that contains a user defined object to pass to the <i>callback</i> delegate.
|
||||
</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<h4 class="Subsection">Returns</h4>
|
||||
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object):Returns">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IAsyncResult">IAsyncResult</a> that contains the status of the asynchronous operation.
|
||||
</blockquote>
|
||||
<h4 class="Subsection">Exceptions</h4>
|
||||
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object):Exceptions">
|
||||
<table class="TypeDocumentation">
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Reason</th>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.InvalidOperationException">InvalidOperationException</a>
|
||||
</td>
|
||||
<td>
|
||||
The <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> has not been started or is stopped currently.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object):Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</div>
|
||||
This asynchronous operation must be completed by calling the <a href="../WebSocketSharp.Net/HttpListener.html#M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)">HttpListener.EndGetContext(IAsyncResult)</a> method.
|
||||
Typically, the method is invoked by the <i>callback</i> delegate.
|
||||
</div>
|
||||
<h2 class="Section">Requirements</h2>
|
||||
<div class="SectionBox" id="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object):Version Information">
|
||||
<b>Namespace: </b>WebSocketSharp.Net<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
||||
@ -612,8 +659,8 @@
|
||||
<h3 id="M:WebSocketSharp.Net.HttpListener.Close">Close Method</h3>
|
||||
<blockquote id="M:WebSocketSharp.Net.HttpListener.Close:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Shuts down the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Close</b> ()</div>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
@ -628,8 +675,8 @@
|
||||
<h3 id="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)">EndGetContext Method</h3>
|
||||
<blockquote id="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult):member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Ends an asynchronous operation to get an incoming request information.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="../WebSocketSharp.Net/HttpListenerContext.html">HttpListenerContext</a> <b>EndGetContext</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IAsyncResult">IAsyncResult</a> asyncResult)</div>
|
||||
<h4 class="Subsection">Parameters</h4>
|
||||
@ -639,18 +686,51 @@
|
||||
<i>asyncResult</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.IAsyncResult">IAsyncResult</a> obtained by calling the <a href="../WebSocketSharp.Net/HttpListener.html#M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">HttpListener.BeginGetContext(AsyncCallback, object)</a> method.
|
||||
</dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
<h4 class="Subsection">Returns</h4>
|
||||
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult):Returns">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
A <a href="../WebSocketSharp.Net/HttpListenerContext.html">WebSocketSharp.Net.HttpListenerContext</a> that contains a client's request information.
|
||||
</blockquote>
|
||||
<h4 class="Subsection">Exceptions</h4>
|
||||
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult):Exceptions">
|
||||
<table class="TypeDocumentation">
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Reason</th>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.ArgumentNullException">ArgumentNullException</a>
|
||||
</td>
|
||||
<td>
|
||||
<i>asyncResult</i> is <tt>null</tt>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.ArgumentException">ArgumentException</a>
|
||||
</td>
|
||||
<td>
|
||||
<i>asyncResult</i> was not obtained by calling the <a href="../WebSocketSharp.Net/HttpListener.html#M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">HttpListener.BeginGetContext(AsyncCallback, object)</a> method.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.InvalidOperationException">InvalidOperationException</a>
|
||||
</td>
|
||||
<td>
|
||||
The EndGetContext method was already called for the specified <i>asyncResult</i>.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult):Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</div>
|
||||
This method completes an asynchronous operation started by calling the <a href="../WebSocketSharp.Net/HttpListener.html#M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">HttpListener.BeginGetContext(AsyncCallback, object)</a> method.
|
||||
</div>
|
||||
<h2 class="Section">Requirements</h2>
|
||||
<div class="SectionBox" id="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult):Version Information">
|
||||
<b>Namespace: </b>WebSocketSharp.Net<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
||||
@ -659,18 +739,36 @@
|
||||
<h3 id="M:WebSocketSharp.Net.HttpListener.GetContext">GetContext Method</h3>
|
||||
<blockquote id="M:WebSocketSharp.Net.HttpListener.GetContext:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Gets an incoming request information.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="../WebSocketSharp.Net/HttpListenerContext.html">HttpListenerContext</a> <b>GetContext</b> ()</div>
|
||||
<h4 class="Subsection">Returns</h4>
|
||||
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Net.HttpListener.GetContext:Returns">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
A <a href="../WebSocketSharp.Net/HttpListenerContext.html">WebSocketSharp.Net.HttpListenerContext</a> that contains a client's request information.
|
||||
</blockquote>
|
||||
<h4 class="Subsection">Exceptions</h4>
|
||||
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Net.HttpListener.GetContext:Exceptions">
|
||||
<table class="TypeDocumentation">
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Reason</th>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.InvalidOperationException">InvalidOperationException</a>
|
||||
</td>
|
||||
<td>
|
||||
The <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> does not have any URI prefixes to listen on.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="M:WebSocketSharp.Net.HttpListener.GetContext:Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</div>
|
||||
This method waits for an incoming request and returns the request information
|
||||
when received the request.
|
||||
</div>
|
||||
<h2 class="Section">Requirements</h2>
|
||||
<div class="SectionBox" id="M:WebSocketSharp.Net.HttpListener.GetContext:Version Information">
|
||||
<b>Namespace: </b>WebSocketSharp.Net<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
||||
@ -699,14 +797,14 @@
|
||||
<h3 id="P:WebSocketSharp.Net.HttpListener.IsListening">IsListening Property</h3>
|
||||
<blockquote id="P:WebSocketSharp.Net.HttpListener.IsListening:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Gets a value indicating whether the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> has been started.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> <b>IsListening</b> { get; }</div>
|
||||
<h4 class="Subsection">Value</h4>
|
||||
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListener.IsListening:Value">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</blockquote>
|
||||
<tt>true</tt> if the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> has been started; otherwise, <tt>false</tt>.
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListener.IsListening:Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
@ -719,14 +817,14 @@
|
||||
<h3 id="P:WebSocketSharp.Net.HttpListener.IsSupported">IsSupported Property</h3>
|
||||
<blockquote id="P:WebSocketSharp.Net.HttpListener.IsSupported:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Gets a value indicating whether the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> can be used with the current operating system.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public static <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> <b>IsSupported</b> { get; }</div>
|
||||
<h4 class="Subsection">Value</h4>
|
||||
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListener.IsSupported:Value">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</blockquote>
|
||||
<tt>true</tt>.
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListener.IsSupported:Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
@ -739,14 +837,14 @@
|
||||
<h3 id="P:WebSocketSharp.Net.HttpListener.Prefixes">Prefixes Property</h3>
|
||||
<blockquote id="P:WebSocketSharp.Net.HttpListener.Prefixes:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Gets the URI prefixes handled by the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="../WebSocketSharp.Net/HttpListenerPrefixCollection.html">HttpListenerPrefixCollection</a> <b>Prefixes</b> { get; }</div>
|
||||
<h4 class="Subsection">Value</h4>
|
||||
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListener.Prefixes:Value">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</blockquote>
|
||||
A <a href="../WebSocketSharp.Net/HttpListenerPrefixCollection.html">WebSocketSharp.Net.HttpListenerPrefixCollection</a> that contains the URI prefixes.
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListener.Prefixes:Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
@ -759,14 +857,14 @@
|
||||
<h3 id="P:WebSocketSharp.Net.HttpListener.Realm">Realm Property</h3>
|
||||
<blockquote id="P:WebSocketSharp.Net.HttpListener.Realm:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Gets or sets the name of the realm associated with the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> <b>Realm</b> { get; set; }</div>
|
||||
<h4 class="Subsection">Value</h4>
|
||||
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Net.HttpListener.Realm: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.String">string</a> that contains the name of the realm.
|
||||
</blockquote>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
<div class="SectionBox" id="P:WebSocketSharp.Net.HttpListener.Realm:Remarks">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
@ -779,8 +877,8 @@
|
||||
<h3 id="M:WebSocketSharp.Net.HttpListener.Start">Start Method</h3>
|
||||
<blockquote id="M:WebSocketSharp.Net.HttpListener.Start:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Starts to receive incoming requests.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Start</b> ()</div>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
@ -795,8 +893,8 @@
|
||||
<h3 id="M:WebSocketSharp.Net.HttpListener.Stop">Stop Method</h3>
|
||||
<blockquote id="M:WebSocketSharp.Net.HttpListener.Stop:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Stops receiving incoming requests.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Stop</b> ()</div>
|
||||
<h2 class="Section">Remarks</h2>
|
||||
@ -811,8 +909,8 @@
|
||||
<h3 id="M:WebSocketSharp.Net.HttpListener.System#IDisposable#Dispose">System.IDisposable.Dispose Method</h3>
|
||||
<blockquote id="M:WebSocketSharp.Net.HttpListener.System#IDisposable#Dispose:member">
|
||||
<p class="Summary">
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</p>
|
||||
Releases all resource used by the <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
|
||||
</p>
|
||||
<h2>Syntax</h2>
|
||||
<div class="Signature">
|
||||
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>System.IDisposable.Dispose</b> ()</div>
|
||||
|
@ -207,16 +207,16 @@
|
||||
<a href="./AuthenticationSchemes.html">AuthenticationSchemes</a>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</td>
|
||||
Contains the values of the schemes for authentication.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
<a href="./AuthenticationSchemeSelector.html">AuthenticationSchemeSelector</a>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</td>
|
||||
Selects the authentication scheme for a <a href="../WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> instance.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -247,8 +247,8 @@
|
||||
<a href="./HttpListener.html">HttpListener</a>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</td>
|
||||
Provides a simple, programmatically controlled HTTP listener.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
|
@ -299,16 +299,16 @@
|
||||
<a href="WebSocketSharp.Net/AuthenticationSchemes.html">AuthenticationSchemes</a>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</td>
|
||||
Contains the values of the schemes for authentication.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
<a href="WebSocketSharp.Net/AuthenticationSchemeSelector.html">AuthenticationSchemeSelector</a>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</td>
|
||||
Selects the authentication scheme for a <a href="./WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> instance.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
@ -339,8 +339,8 @@
|
||||
<a href="WebSocketSharp.Net/HttpListener.html">HttpListener</a>
|
||||
</td>
|
||||
<td>
|
||||
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
||||
</td>
|
||||
Provides a simple, programmatically controlled HTTP listener.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>
|
||||
|
@ -14,9 +14,15 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemes</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<param name="httpRequest">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<param name="httpRequest">
|
||||
A <see cref="T:WebSocketSharp.Net.HttpListenerRequest" /> that contains a client request information.
|
||||
</param>
|
||||
<summary>
|
||||
Selects the authentication scheme for a <see cref="T:WebSocketSharp.Net.HttpListener" /> instance.
|
||||
</summary>
|
||||
<returns>
|
||||
One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes" /> values that indicates the scheme used to authenticate the specified client request.
|
||||
</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Type>
|
||||
|
@ -13,7 +13,9 @@
|
||||
</Attribute>
|
||||
</Attributes>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Contains the values of the schemes for authentication.
|
||||
</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
@ -25,7 +27,9 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemes</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Indicates anonymous authentication.
|
||||
</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Basic">
|
||||
@ -36,7 +40,9 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemes</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Indicates basic authentication.
|
||||
</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Digest">
|
||||
@ -47,7 +53,9 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemes</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Indicates digest authentication.
|
||||
</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="IntegratedWindowsAuthentication">
|
||||
@ -58,7 +66,9 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemes</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Indicates Windows authentication.
|
||||
</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Negotiate">
|
||||
@ -69,7 +79,9 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemes</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Indicates negotiating with the client to determine the authentication scheme.
|
||||
</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="None">
|
||||
@ -80,7 +92,9 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemes</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Indicates that no authentication is allowed.
|
||||
</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Ntlm">
|
||||
@ -91,7 +105,9 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemes</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Indicates NTLM authentication.
|
||||
</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
@ -13,7 +13,9 @@
|
||||
</Interface>
|
||||
</Interfaces>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Provides a simple, programmatically controlled HTTP listener.
|
||||
</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
@ -23,7 +25,9 @@
|
||||
<MemberType>Constructor</MemberType>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListener" /> class.
|
||||
</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -36,7 +40,9 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Shuts down the <see cref="T:WebSocketSharp.Net.HttpListener" /> immediately.
|
||||
</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -48,8 +54,13 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemes</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<summary>
|
||||
Gets or sets the scheme used to authenticate the clients.
|
||||
</summary>
|
||||
<value>
|
||||
One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes" /> values that indicates the scheme used to
|
||||
authenticate the clients. The default value is <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous" />.
|
||||
</value>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -61,8 +72,13 @@
|
||||
<ReturnType>WebSocketSharp.Net.AuthenticationSchemeSelector</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<summary>
|
||||
Gets or sets the delegate called to determine the scheme used to authenticate clients.
|
||||
</summary>
|
||||
<value>
|
||||
A <see cref="T:WebSocketSharp.Net.AuthenticationSchemeSelector" /> delegate that invokes the method(s) used to select
|
||||
an authentication scheme. The default value is <see langword="null" />.
|
||||
</value>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -78,11 +94,26 @@
|
||||
<Parameter Name="state" Type="System.Object" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="callback">To be added.</param>
|
||||
<param name="state">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="callback">
|
||||
An <see cref="T:System.AsyncCallback" /> delegate that references the method(s)
|
||||
called when the asynchronous operation completes.
|
||||
</param>
|
||||
<param name="state">
|
||||
An <see cref="T:System.Object" /> that contains a user defined object to pass to the <paramref name="callback" /> delegate.
|
||||
</param>
|
||||
<summary>
|
||||
Begins getting an incoming request information asynchronously.
|
||||
</summary>
|
||||
<returns>
|
||||
An <see cref="T:System.IAsyncResult" /> that contains the status of the asynchronous operation.
|
||||
</returns>
|
||||
<remarks>
|
||||
This asynchronous operation must be completed by calling the <see cref="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)" /> method.
|
||||
Typically, the method is invoked by the <paramref name="callback" /> delegate.
|
||||
</remarks>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
The <see cref="T:WebSocketSharp.Net.HttpListener" /> has not been started or is stopped currently.
|
||||
</exception>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Close">
|
||||
@ -94,7 +125,9 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Shuts down the <see cref="T:WebSocketSharp.Net.HttpListener" />.
|
||||
</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -109,10 +142,27 @@
|
||||
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="asyncResult">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="asyncResult">
|
||||
An <see cref="T:System.IAsyncResult" /> obtained by calling the <see cref="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)" /> method.
|
||||
</param>
|
||||
<summary>
|
||||
Ends an asynchronous operation to get an incoming request information.
|
||||
</summary>
|
||||
<returns>
|
||||
A <see cref="T:WebSocketSharp.Net.HttpListenerContext" /> that contains a client's request information.
|
||||
</returns>
|
||||
<remarks>
|
||||
This method completes an asynchronous operation started by calling the <see cref="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)" /> method.
|
||||
</remarks>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="asyncResult" /> is <see langword="null" />.
|
||||
</exception>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
<paramref name="asyncResult" /> was not obtained by calling the <see cref="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)" /> method.
|
||||
</exception>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
The EndGetContext method was already called for the specified <paramref name="asyncResult" />.
|
||||
</exception>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetContext">
|
||||
@ -124,9 +174,19 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>
|
||||
Gets an incoming request information.
|
||||
</summary>
|
||||
<returns>
|
||||
A <see cref="T:WebSocketSharp.Net.HttpListenerContext" /> that contains a client's request information.
|
||||
</returns>
|
||||
<remarks>
|
||||
This method waits for an incoming request and returns the request information
|
||||
when received the request.
|
||||
</remarks>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
The <see cref="T:WebSocketSharp.Net.HttpListener" /> does not have any URI prefixes to listen on.
|
||||
</exception>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="IgnoreWriteExceptions">
|
||||
@ -150,8 +210,12 @@
|
||||
<ReturnType>System.Boolean</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<summary>
|
||||
Gets a value indicating whether the <see cref="T:WebSocketSharp.Net.HttpListener" /> has been started.
|
||||
</summary>
|
||||
<value>
|
||||
<c>true</c> if the <see cref="T:WebSocketSharp.Net.HttpListener" /> has been started; otherwise, <c>false</c>.
|
||||
</value>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -163,8 +227,12 @@
|
||||
<ReturnType>System.Boolean</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<summary>
|
||||
Gets a value indicating whether the <see cref="T:WebSocketSharp.Net.HttpListener" /> can be used with the current operating system.
|
||||
</summary>
|
||||
<value>
|
||||
<c>true</c>.
|
||||
</value>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -176,8 +244,12 @@
|
||||
<ReturnType>WebSocketSharp.Net.HttpListenerPrefixCollection</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<summary>
|
||||
Gets the URI prefixes handled by the <see cref="T:WebSocketSharp.Net.HttpListener" />.
|
||||
</summary>
|
||||
<value>
|
||||
A <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection" /> that contains the URI prefixes.
|
||||
</value>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -189,8 +261,12 @@
|
||||
<ReturnType>System.String</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<summary>
|
||||
Gets or sets the name of the realm associated with the <see cref="T:WebSocketSharp.Net.HttpListener" />.
|
||||
</summary>
|
||||
<value>
|
||||
A <see cref="T:System.String" /> that contains the name of the realm.
|
||||
</value>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -203,7 +279,9 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Starts to receive incoming requests.
|
||||
</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -216,7 +294,9 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Stops receiving incoming requests.
|
||||
</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -229,7 +309,9 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
Releases all resource used by the <see cref="T:WebSocketSharp.Net.HttpListener" />.
|
||||
</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
@ -1,6 +1,6 @@
|
||||
<Overview>
|
||||
<Assemblies>
|
||||
<Assembly Name="websocket-sharp" Version="1.0.2.41019">
|
||||
<Assembly Name="websocket-sharp" Version="1.0.2.32056">
|
||||
<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>
|
||||
|
Binary file not shown.
Loading…
Reference in New Issue
Block a user