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

Fix due to the modified Ext.cs, WebSocketServerBase.cs and WebSocketService.cs

Browse Source
This commit is contained in:
sta
2013-01-28 16:22:24 +09:00
parent de3f41dd3a
commit 95382924e0
87 changed files with 1711 additions and 952 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
websocket-sharp/Ext.cs
View File

@@ -74,28 +74,59 @@ namespace WebSocketSharp {
#region Public Methods
/// <summary>
/// Accept a WebSocket connection by the <see cref="TcpListener"/>.
/// Accepts a WebSocket connection by the <see cref="TcpListener"/>.
/// </summary>
/// <returns>
/// A <see cref="WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"/> that contains a WebSocket connection.
/// A <see cref="TcpListenerWebSocketContext"/> that contains a WebSocket connection.
/// </returns>
/// <param name="client">
/// A <see cref="TcpClient"/> that contains a TCP connection to accept a WebSocket connection from.
/// <param name="listener">
/// A <see cref="TcpListener"/> that provides a TCP connection to accept a WebSocket connection.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates a secure connection or not. (<c>true</c> indicates a secure connection.)
/// </param>
/// <exception cref="ArgumentNullException">
/// Is thrown when the <paramref name="client"/> parameter passed to a method is invalid because it is <see langword="null"/>.
/// <paramref name="listener"/> is <see langword="null"/>.
/// </exception>
public static TcpListenerWebSocketContext AcceptWebSocket(this TcpClient client, bool secure)
public static TcpListenerWebSocketContext AcceptWebSocket(this TcpListener listener, bool secure)
{
if (client.IsNull())
throw new ArgumentNullException("client");
if (listener.IsNull())
throw new ArgumentNullException("listener");
var client = listener.AcceptTcpClient();
return new TcpListenerWebSocketContext(client, secure);
}
/// <summary>
/// Accepts a WebSocket connection asynchronously by the <see cref="TcpListener"/>.
/// </summary>
/// <param name="listener">
/// A <see cref="TcpListener"/> that provides a TCP connection to accept a WebSocket connection.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates a secure connection or not. (<c>true</c> indicates a secure connection.)
/// </param>
/// <param name="completed">
/// An Action&lt;TcpListenerWebSocketContext&gt; delegate that contains the method(s) that is called when an asynchronous operation completes.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="listener"/> is <see langword="null"/>.
/// </exception>
public static void AcceptWebSocketAsync(this TcpListener listener, bool secure, Action<TcpListenerWebSocketContext> completed)
{
if (listener.IsNull())
throw new ArgumentNullException("listener");
AsyncCallback callback = (ar) =>
{
var client = listener.EndAcceptTcpClient(ar);
var context = new TcpListenerWebSocketContext(client, secure);
completed(context);
};
listener.BeginAcceptTcpClient(callback, null);
}
/// <summary>
/// Emit the specified <see cref="EventHandler"/> delegate if is not <see langword="null"/>.
/// </summary>

45
websocket-sharp/Server/WebSocketServer.cs
View File

@@ -40,7 +40,7 @@ namespace WebSocketSharp.Server {
/// Provides the functions of the server that receives the WebSocket connection requests.
/// </summary>
/// <remarks>
/// The WebSocketServer class provides multi WebSocket service.
/// The WebSocketServer class provides the multi WebSocket service.
/// </remarks>
public class WebSocketServer : WebSocketServerBase
{
@@ -53,7 +53,7 @@ namespace WebSocketSharp.Server {
#region Public Constructors
/// <summary>
/// Initializes a new instance of the WebSocketServer class.
/// Initializes a new instance of the <see cref="WebSocketServer"/> class.
/// </summary>
public WebSocketServer()
: this(80)
@@ -61,7 +61,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// Initializes a new instance of the <see cref="WebSocketServer"/> class that listens for incoming connection attempts
/// on the specified <paramref name="port"/>.
/// </summary>
/// <param name="port">
@@ -73,7 +73,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// Initializes a new instance of the <see cref="WebSocketServer"/> class that listens for incoming connection attempts
/// on the specified WebSocket URL.
/// </summary>
/// <param name="url">
@@ -92,7 +92,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// Initializes a new instance of the <see cref="WebSocketServer"/> class that listens for incoming connection attempts
/// on the specified <paramref name="port"/> and <paramref name="secure"/>.
/// </summary>
/// <param name="port">
@@ -107,11 +107,11 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// Initializes a new instance of the <see cref="WebSocketServer"/> class that listens for incoming connection attempts
/// on the specified <paramref name="address"/> and <paramref name="port"/>.
/// </summary>
/// <param name="address">
/// An <see cref="System.Net.IPAddress"/> that contains an IP address.
/// A <see cref="System.Net.IPAddress"/> that contains an IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
@@ -122,11 +122,11 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// Initializes a new instance of the <see cref="WebSocketServer"/> class that listens for incoming connection attempts
/// on the specified <paramref name="address"/>, <paramref name="port"/> and <paramref name="secure"/>.
/// </summary>
/// <param name="address">
/// An <see cref="System.Net.IPAddress"/> that contains an IP address.
/// A <see cref="System.Net.IPAddress"/> that contains an IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
@@ -145,12 +145,12 @@ namespace WebSocketSharp.Server {
#region Properties
/// <summary>
/// Gets the service paths.
/// Gets the paths associated with the each WebSocket services.
/// </summary>
/// <value>
/// An IEnumerable&lt;string&gt; that contains the service paths.
/// An IEnumerable&lt;string&gt; that contains the paths.
/// </value>
public IEnumerable<string> ServicePath {
public IEnumerable<string> ServicePaths {
get {
var url = BaseUri.IsAbsoluteUri
? BaseUri.ToString().TrimEnd('/')
@@ -190,16 +190,15 @@ namespace WebSocketSharp.Server {
#region Protected Method
/// <summary>
/// Accepts the WebSocket connection.
/// Accepts a WebSocket connection.
/// </summary>
/// <param name="client">
/// A <see cref="TcpClient"/> that contains the TCP connection.
/// <param name="context">
/// A <see cref="TcpListenerWebSocketContext"/> that contains a WebSocket connection.
/// </param>
protected override void AcceptWebSocket(TcpClient client)
protected override void AcceptWebSocket(TcpListenerWebSocketContext context)
{
var context = client.AcceptWebSocket(IsSecure);
var socket = context.WebSocket;
var path = context.Path.UrlDecode();
var socket = context.WebSocket;
var path = context.Path.UrlDecode();
IServiceHost svcHost;
if (!_services.TryGetServiceHost(path, out svcHost))
@@ -219,13 +218,13 @@ namespace WebSocketSharp.Server {
#region Public Methods
/// <summary>
/// Adds the WebSocket service.
/// Adds a WebSocket service.
/// </summary>
/// <param name="absPath">
/// A <see cref="string"/> that contains an absolute path associated with the WebSocket service.
/// A <see cref="string"/> that contains an absolute path associated with a WebSocket service.
/// </param>
/// <typeparam name="T">
/// The type of the WebSocket service. The T must inherit the <see cref="WebSocketService"/> class.
/// The type of a WebSocket service. The T must inherit the <see cref="WebSocketService"/> class.
/// </typeparam>
public void AddService<T>(string absPath)
where T : WebSocketService, new()
@@ -248,7 +247,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Broadcasts the specified <see cref="string"/>.
/// Broadcasts the specified <see cref="string"/> to all clients.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> to broadcast.

95
websocket-sharp/Server/WebSocketServerBase.cs
View File

@@ -31,6 +31,7 @@ using System.Diagnostics;
using System.Net;
using System.Net.Sockets;
using System.Threading;
using WebSocketSharp.Net.WebSockets;
namespace WebSocketSharp.Server {
@@ -44,7 +45,7 @@ namespace WebSocketSharp.Server {
#region Fields
private Thread _acceptClientThread;
private Thread _receiveRequestThread;
private IPAddress _address;
private bool _isSecure;
private bool _isSelfHost;
@@ -57,7 +58,7 @@ namespace WebSocketSharp.Server {
#region Constructors
/// <summary>
/// Initializes a new instance of the <see cref="WebSocketSharp.Server.WebSocketServerBase"/> class.
/// Initializes a new instance of the <see cref="WebSocketServerBase"/> class.
/// </summary>
protected WebSocketServerBase()
{
@@ -65,7 +66,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Initializes a new instance of the <see cref="WebSocketSharp.Server.WebSocketServerBase"/> class that listens for incoming connection attempts
/// Initializes a new instance of the <see cref="WebSocketServerBase"/> class that listens for incoming connection attempts
/// on the specified WebSocket URL.
/// </summary>
/// <param name="url">
@@ -91,17 +92,17 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Initializes a new instance of the <see cref="WebSocketSharp.Server.WebSocketServerBase"/> class that listens for incoming connection attempts
/// Initializes a new instance of the <see cref="WebSocketServerBase"/> class that listens for incoming connection attempts
/// on the specified <paramref name="address"/>, <paramref name="port"/>, <paramref name="absPath"/> and <paramref name="secure"/>.
/// </summary>
/// <param name="address">
/// An <see cref="IPAddress"/> that contains a local IP address.
/// A <see cref="IPAddress"/> that contains an IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="absPath">
/// A <see cref="string"/> that contains a absolute path.
/// A <see cref="string"/> that contains an absolute path.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
@@ -176,10 +177,10 @@ namespace WebSocketSharp.Server {
#region Public Properties
/// <summary>
/// Gets the local IP address on which to listen for incoming connection attempts.
/// Gets the IP address on which to listen for incoming connection attempts.
/// </summary>
/// <value>
/// A <see cref="IPAddress"/> that contains a local IP address.
/// A <see cref="IPAddress"/> that contains an IP address.
/// </value>
public IPAddress Address {
get {
@@ -188,10 +189,10 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Gets a value indicating whether this server is secure.
/// Gets a value indicating whether this server provides secure connection.
/// </summary>
/// <value>
/// <c>true</c> if this server is secure; otherwise, <c>false</c>.
/// <c>true</c> if this server provides secure connection; otherwise, <c>false</c>.
/// </value>
public bool IsSecure {
get {
@@ -236,35 +237,13 @@ namespace WebSocketSharp.Server {
#region Private Methods
private void acceptClient()
private void acceptWebSocketAsync(TcpListenerWebSocketContext context)
{
while (true)
WaitCallback callback = (state) =>
{
try
{
var client = _tcpListener.AcceptTcpClient();
acceptSocketAsync(client);
}
catch (SocketException)
{
// TcpListener has been stopped.
break;
}
catch (Exception ex)
{
onError(ex.Message);
break;
}
}
}
private void acceptSocketAsync(TcpClient client)
{
WaitCallback acceptSocketCb = (state) =>
{
try
{
AcceptWebSocket(client);
AcceptWebSocket(context);
}
catch (Exception ex)
{
@@ -272,7 +251,7 @@ namespace WebSocketSharp.Server {
}
};
ThreadPool.QueueUserWorkItem(acceptSocketCb);
ThreadPool.QueueUserWorkItem(callback);
}
private void init()
@@ -308,11 +287,33 @@ namespace WebSocketSharp.Server {
OnError.Emit(this, new ErrorEventArgs(message));
}
private void startAcceptClientThread()
private void receiveRequest()
{
_acceptClientThread = new Thread(new ThreadStart(acceptClient));
_acceptClientThread.IsBackground = true;
_acceptClientThread.Start();
while (true)
{
try
{
var context = _tcpListener.AcceptWebSocket(_isSecure);
acceptWebSocketAsync(context);
}
catch (SocketException)
{
// TcpListener has been stopped.
break;
}
catch (Exception ex)
{
onError(ex.Message);
break;
}
}
}
private void startReceiveRequestThread()
{
_receiveRequestThread = new Thread(new ThreadStart(receiveRequest));
_receiveRequestThread.IsBackground = true;
_receiveRequestThread.Start();
}
private bool tryCreateUri(string uriString, out Uri result, out string message)
@@ -335,15 +336,15 @@ namespace WebSocketSharp.Server {
#region Protected Methods
/// <summary>
/// Accepts the WebSocket connection.
/// Accepts a WebSocket connection.
/// </summary>
/// <param name="client">
/// A <see cref="TcpClient"/> that contains the WebSocket connection.
/// <param name="context">
/// A <see cref="TcpListenerWebSocketContext"/> that contains a WebSocket connection.
/// </param>
protected abstract void AcceptWebSocket(TcpClient client);
protected abstract void AcceptWebSocket(TcpListenerWebSocketContext context);
/// <summary>
/// Occurs the <see cref="WebSocketServerBase.OnError"/> event with the specified <paramref name="message"/>.
/// Occurs the <see cref="WebSocketServerBase.OnError"/> event with the specified <see cref="string"/>.
/// </summary>
/// <param name="message">
/// A <see cref="string"/> that contains an error message.
@@ -366,7 +367,7 @@ namespace WebSocketSharp.Server {
return;
_tcpListener.Start();
startAcceptClientThread();
startReceiveRequestThread();
}
/// <summary>
@@ -378,7 +379,7 @@ namespace WebSocketSharp.Server {
return;
_tcpListener.Stop();
_acceptClientThread.Join(5 * 1000);
_receiveRequestThread.Join(5 * 1000);
}
#endregion

302
websocket-sharp/Server/WebSocketService.cs
View File

@@ -33,6 +33,12 @@ using System.Threading;
namespace WebSocketSharp.Server {
/// <summary>
/// Provides the basic functions of the WebSocket service.
/// </summary>
/// <remarks>
/// The WebSocketService class is an abstract class.
/// </remarks>
public abstract class WebSocketService {
#region Private Fields
@@ -44,6 +50,9 @@ namespace WebSocketSharp.Server {
#region Public Constructor
/// <summary>
/// Initializes a new instance of the <see cref="WebSocketService"/> class.
/// </summary>
public WebSocketService()
{
ID = String.Empty;
@@ -54,12 +63,24 @@ namespace WebSocketSharp.Server {
#region Protected Properties
/// <summary>
/// Gets the HTTP query string variables used in the WebSocket opening handshake.
/// </summary>
/// <value>
/// A <see cref="NameValueCollection"/> that contains the query string variables.
/// </value>
protected NameValueCollection QueryString {
get {
return IsBound ? _socket.QueryString : null;
}
}
/// <summary>
/// Gets the sessions to the WebSocket service.
/// </summary>
/// <value>
/// A <see cref="SessionManager"/> that contains the sessions to the WebSocket service.
/// </value>
protected SessionManager Sessions {
get {
return IsBound ? _sessions : null;
@@ -70,44 +91,46 @@ namespace WebSocketSharp.Server {
#region Public Properties
public string ID { get; private set; }
public bool IsBound { get; private set; }
/// <summary>
/// Gets the ID of a <see cref="WebSocketService"/> instance.
/// </summary>
/// <value>
/// A <see cref="string"/> that contains a ID.
/// </value>
public string ID { get; private set; }
/// <summary>
/// Gets a value indicating whether a <see cref="WebSocketService"/> instance is bound to a <see cref="WebSocket"/>.
/// </summary>
/// <value>
/// <c>true</c> if the WebSocketService is bound to a WebSocket; otherwise, <c>false</c>.
/// </value>
public bool IsBound { get; private set; }
#endregion
#region Private Method
#region Private Methods
private void defaultBind()
private void onClose(object sender, CloseEventArgs e)
{
_socket.OnOpen += (sender, e) =>
{
ID = _sessions.Add(this);
};
_socket.OnClose += (sender, e) =>
{
_sessions.Remove(ID);
};
_sessions.Remove(ID);
OnClose(e);
}
#endregion
#region Protected Methods
protected virtual void OnClose(object sender, CloseEventArgs e)
private void onError(object sender, ErrorEventArgs e)
{
OnError(e);
}
protected virtual void OnError(object sender, ErrorEventArgs e)
private void onMessage(object sender, MessageEventArgs e)
{
OnMessage(e);
}
protected virtual void OnMessage(object sender, MessageEventArgs e)
{
}
protected virtual void OnOpen(object sender, EventArgs e)
private void onOpen(object sender, EventArgs e)
{
ID = _sessions.Add(this);
OnOpen();
}
#endregion
@@ -126,27 +149,148 @@ namespace WebSocketSharp.Server {
#endregion
#region Protected Methods
/// <summary>
/// Occurs when a inner <see cref="WebSocket"/> receives a Close frame or the Stop method is called.
/// </summary>
/// <param name="e">
/// A <see cref="CloseEventArgs"/> that contains the event data associated with a <see cref="WebSocket.OnClose"/> event.
/// </param>
protected virtual void OnClose(CloseEventArgs e)
{
}
/// <summary>
/// Occurs when a inner <see cref="WebSocket"/> gets an error.
/// </summary>
/// <param name="e">
/// An <see cref="ErrorEventArgs"/> that contains the event data associated with a <see cref="WebSocket.OnError"/> event.
/// </param>
protected virtual void OnError(ErrorEventArgs e)
{
}
/// <summary>
/// Occurs when a inner <see cref="WebSocket"/> receives a data frame.
/// </summary>
/// <param name="e">
/// A <see cref="MessageEventArgs"/> that contains the event data associated with a <see cref="WebSocket.OnMessage"/> event.
/// </param>
protected virtual void OnMessage(MessageEventArgs e)
{
}
/// <summary>
/// Occurs when the WebSocket connection has been established.
/// </summary>
protected virtual void OnOpen()
{
}
#endregion
#region Public Methods
/// <summary>
/// Binds the specified <see cref="WebSocket"/> and <see cref="SessionManager"/>
/// to a <see cref="WebSocketService"/> instance.
/// </summary>
/// <param name="socket">
/// A <see cref="WebSocket"/> to bind to the WebSocketService.
/// </param>
/// <param name="sessions">
/// A <see cref="SessionManager"/> to bind to the WebSocketService.
/// </param>
public void Bind(WebSocket socket, SessionManager sessions)
{
if (IsBound)
return;
_socket = socket;
_sessions = sessions;
defaultBind();
_socket.OnOpen += OnOpen;
_socket.OnMessage += OnMessage;
_socket.OnError += OnError;
_socket.OnClose += OnClose;
_socket.OnOpen += onOpen;
_socket.OnMessage += onMessage;
_socket.OnError += onError;
_socket.OnClose += onClose;
IsBound = true;
}
/// <summary>
/// Broadcasts the specified array of <see cref="byte"/> to all clients of the WebSocket service.
/// </summary>
/// <param name="data">
/// An array of <see cref="byte"/> to broadcast.
/// </param>
public void Broadcast(byte[] data)
{
if (IsBound)
_sessions.Broadcast(data);
}
/// <summary>
/// Broadcasts the specified <see cref="string"/> to all clients of the WebSocket service.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> to broadcast.
/// </param>
public void Broadcast(string data)
{
if (IsBound)
_sessions.Broadcast(data);
}
/// <summary>
/// Pings to all clients of the WebSocket service.
/// </summary>
/// <returns>
/// A Dictionary&lt;string, bool&gt; that contains the collection of the ID and value
/// indicating whether the WebSocket service received a Pong in a time.
/// </returns>
public Dictionary<string, bool> Broadping()
{
return Broadping(String.Empty);
}
/// <summary>
/// Pings with the specified <see cref="string"/> to all clients of the WebSocket service.
/// </summary>
/// <returns>
/// A Dictionary&lt;string, bool&gt; that contains the collection of the ID and value
/// indicating whether the WebSocket service received a Pong in a time.
/// </returns>
/// <param name="message">
/// A <see cref="string"/> that contains a message.
/// </param>
public Dictionary<string, bool> Broadping(string message)
{
return IsBound
? _sessions.Broadping(message)
: null;
}
/// <summary>
/// Pings to the client of a <see cref="WebSocketService"/> instance.
/// </summary>
/// <returns>
/// <c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
/// </returns>
public bool Ping()
{
return Ping(String.Empty);
}
/// <summary>
/// Pings with the specified <see cref="string"/> to the client of a <see cref="WebSocketService"/> instance.
/// </summary>
/// <returns>
/// <c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
/// </returns>
/// <param name="message">
/// A <see cref="string"/> that contains a message.
/// </param>
public bool Ping(string message)
{
return IsBound
@@ -154,23 +298,33 @@ namespace WebSocketSharp.Server {
: false;
}
public Dictionary<string, bool> PingAround()
{
return PingAround(String.Empty);
}
public Dictionary<string, bool> PingAround(string message)
{
return IsBound
? _sessions.Broadping(message)
: null;
}
/// <summary>
/// Pings to the client of a <see cref="WebSocketService"/> instance associated with the specified ID.
/// </summary>
/// <returns>
/// <c>true</c> if the WebSocket service receives a Pong in a time; otherwise, <c>false</c>.
/// </returns>
/// <param name="id">
/// A <see cref="string"/> that contains a ID that represents the destination for the Ping.
/// </param>
public bool PingTo(string id)
{
return PingTo(id, String.Empty);
}
/// <summary>
/// Pings with the specified <see cref="string"/> to the client of a <see cref="WebSocketService"/> instance
/// associated with the specified ID.
/// </summary>
/// <returns>
/// <c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
/// </returns>
/// <param name="id">
/// A <see cref="string"/> that contains a ID that represents the destination for the Ping.
/// </param>
/// <param name="message">
/// A <see cref="string"/> that contains a message.
/// </param>
public bool PingTo(string id, string message)
{
if (!IsBound)
@@ -182,30 +336,39 @@ namespace WebSocketSharp.Server {
: false;
}
public void Publish(byte[] data)
{
if (IsBound)
_sessions.Broadcast(data);
}
public void Publish(string data)
{
if (IsBound)
_sessions.Broadcast(data);
}
/// <summary>
/// Sends a binary data to the client of a <see cref="WebSocketService"/> instance.
/// </summary>
/// <param name="data">
/// An array of <see cref="byte"/> that contains a binary data to send.
/// </param>
public void Send(byte[] data)
{
if (IsBound)
_socket.Send(data);
}
/// <summary>
/// Sends a text data to the client of a <see cref="WebSocketService"/> instance.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> that contains a text data to send.
/// </param>
public void Send(string data)
{
if (IsBound)
_socket.Send(data);
}
/// <summary>
/// Sends a binary data to the client of a <see cref="WebSocketService"/> instance associated with the specified ID.
/// </summary>
/// <param name="id">
/// A <see cref="string"/> that contains a ID that represents the destination for the data.
/// </param>
/// <param name="data">
/// An array of <see cref="byte"/> that contains a binary data to send.
/// </param>
public void SendTo(string id, byte[] data)
{
if (!IsBound)
@@ -216,6 +379,15 @@ namespace WebSocketSharp.Server {
service.Send(data);
}
/// <summary>
/// Sends a text data to the client of a <see cref="WebSocketService"/> instance associated with the specified ID.
/// </summary>
/// <param name="id">
/// A <see cref="string"/> that contains a ID that represents the destination for the data.
/// </param>
/// <param name="data">
/// A <see cref="string"/> that contains a text data to send.
/// </param>
public void SendTo(string id, string data)
{
if (!IsBound)
@@ -226,12 +398,18 @@ namespace WebSocketSharp.Server {
service.Send(data);
}
/// <summary>
/// Starts a <see cref="WebSocketService"/> instance.
/// </summary>
public void Start()
{
if (IsBound)
_socket.Connect();
}
/// <summary>
/// Stops a <see cref="WebSocketService"/> instance.
/// </summary>
public void Stop()
{
if (!IsBound)
@@ -240,11 +418,29 @@ namespace WebSocketSharp.Server {
_socket.Close();
}
/// <summary>
/// Stops a <see cref="WebSocketService"/> instance with the specified <see cref="CloseStatusCode"/> and <see cref="string"/>.
/// </summary>
/// <param name="code">
/// One of the <see cref="CloseStatusCode"/> values that contains a status code indicating the reason for stop.
/// </param>
/// <param name="reason">
/// A <see cref="string"/> that contains a reason for stop.
/// </param>
public void Stop(CloseStatusCode code, string reason)
{
Stop((ushort)code, reason);
}
/// <summary>
/// Stops a <see cref="WebSocketService"/> instance with the specified <see cref="ushort"/> and <see cref="string"/>.
/// </summary>
/// <param name="code">
/// A <see cref="ushort"/> that contains a status code indicating the reason for stop.
/// </param>
/// <param name="reason">
/// A <see cref="string"/> that contains a reason for stop.
/// </param>
public void Stop(ushort code, string reason)
{
if (!IsBound)

26
websocket-sharp/Server/WebSocketServiceHost.cs
View File

@@ -32,6 +32,7 @@ using System;
using System.Collections.Generic;
using System.Net.Sockets;
using WebSocketSharp.Net;
using WebSocketSharp.Net.WebSockets;
namespace WebSocketSharp.Server {
@@ -39,7 +40,7 @@ namespace WebSocketSharp.Server {
/// Provides the functions of the server that receives the WebSocket connection requests.
/// </summary>
/// <remarks>
/// The WebSocketServiceHost&lt;T&gt; class provides single WebSocket service.
/// The WebSocketServiceHost&lt;T&gt; class provides the single WebSocket service.
/// </remarks>
/// <typeparam name="T">
/// The type of the WebSocket service that the server provides. The T must inherit the <see cref="WebSocketService"/> class.
@@ -142,7 +143,7 @@ namespace WebSocketSharp.Server {
/// on the specified <paramref name="address"/>, <paramref name="port"/> and <paramref name="absPath"/>.
/// </summary>
/// <param name="address">
/// An <see cref="System.Net.IPAddress"/> that contains an IP address.
/// A <see cref="System.Net.IPAddress"/> that contains an IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
@@ -160,7 +161,7 @@ namespace WebSocketSharp.Server {
/// on the specified <paramref name="address"/>, <paramref name="port"/>, <paramref name="absPath"/> and <paramref name="secure"/>.
/// </summary>
/// <param name="address">
/// An <see cref="System.Net.IPAddress"/> that contains an IP address.
/// A <see cref="System.Net.IPAddress"/> that contains an IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
@@ -244,16 +245,15 @@ namespace WebSocketSharp.Server {
#region Protected Method
/// <summary>
/// Accepts the WebSocket connection.
/// Accepts a WebSocket connection.
/// </summary>
/// <param name="client">
/// A <see cref="TcpClient"/> that contains the TCP connection.
/// <param name="context">
/// A <see cref="TcpListenerWebSocketContext"/> that contains a WebSocket connection.
/// </param>
protected override void AcceptWebSocket(TcpClient client)
protected override void AcceptWebSocket(TcpListenerWebSocketContext context)
{
var context = client.AcceptWebSocket(IsSecure);
var socket = context.WebSocket;
var path = context.Path.UrlDecode();
var socket = context.WebSocket;
var path = context.Path.UrlDecode();
if (path != Uri.GetAbsolutePath().UrlDecode())
{
socket.Close(HttpStatusCode.NotImplemented);
@@ -271,7 +271,7 @@ namespace WebSocketSharp.Server {
#region Public Methods
/// <summary>
/// Broadcasts the specified <see cref="string"/>.
/// Broadcasts the specified <see cref="string"/> to all clients.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> to broadcast.
@@ -284,6 +284,10 @@ namespace WebSocketSharp.Server {
/// <summary>
/// Pings with the specified <see cref="string"/> to all clients.
/// </summary>
/// <returns>
/// A Dictionary&lt;string, bool&gt; that contains the collection of the session ID and value
/// indicating whether the server received a Pong in a time.
/// </returns>
/// <param name="message">
/// A <see cref="string"/> that contains a message.
/// </param>

104
websocket-sharp/WebSocket.cs
View File

@@ -303,14 +303,9 @@ namespace WebSocketSharp {
#region Events
/// <summary>
/// Occurs when the WebSocket connection has been established.
/// Occurs when the WebSocket receives a Close frame or the Close method is called.
/// </summary>
public event EventHandler OnOpen;
/// <summary>
/// Occurs when the WebSocket receives a data frame.
/// </summary>
public event EventHandler<MessageEventArgs> OnMessage;
public event EventHandler<CloseEventArgs> OnClose;
/// <summary>
/// Occurs when the WebSocket gets an error.
@@ -318,9 +313,14 @@ namespace WebSocketSharp {
public event EventHandler<ErrorEventArgs> OnError;
/// <summary>
/// Occurs when the WebSocket receives a Close frame or the Close method is called.
/// Occurs when the WebSocket receives a data frame.
/// </summary>
public event EventHandler<CloseEventArgs> OnClose;
public event EventHandler<MessageEventArgs> OnMessage;
/// <summary>
/// Occurs when the WebSocket connection has been established.
/// </summary>
public event EventHandler OnOpen;
#endregion
@@ -1140,7 +1140,7 @@ namespace WebSocketSharp {
/// Closes the connection and releases all associated resources after sends a Close control frame.
/// </summary>
/// <param name="code">
/// A <see cref="WebSocketSharp.Frame.CloseStatusCode"/> that contains a status code indicating a reason for closure.
/// A <see cref="CloseStatusCode"/> that contains a status code indicating a reason for closure.
/// </param>
public void Close(CloseStatusCode code)
{
@@ -1162,7 +1162,7 @@ namespace WebSocketSharp {
/// Closes the connection and releases all associated resources after sends a Close control frame.
/// </summary>
/// <param name="code">
/// A <see cref="WebSocketSharp.Frame.CloseStatusCode"/> that contains a status code indicating a reason for closure.
/// A <see cref="CloseStatusCode"/> that contains a status code indicating a reason for closure.
/// </param>
/// <param name="reason">
/// A <see cref="string"/> that contains a reason for closure.
@@ -1268,11 +1268,28 @@ namespace WebSocketSharp {
: ping(message, 1 * 1000);
}
/// <summary>
/// Sends a binary data using the connection.
/// </summary>
/// <param name="data">
/// An array of <see cref="byte"/> that contains a binary data to send.
/// </param>
public void Send(byte[] data)
{
if (data.IsNull())
{
onError("'data' must not be null.");
return;
}
send(Opcode.BINARY, data);
}
/// <summary>
/// Sends a text data using the connection.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> that contains the text data to be sent.
/// A <see cref="string"/> that contains a text data to send.
/// </param>
public void Send(string data)
{
@@ -1286,28 +1303,11 @@ namespace WebSocketSharp {
send(Opcode.TEXT, buffer);
}
/// <summary>
/// Sends a binary data using the connection.
/// </summary>
/// <param name="data">
/// An array of <see cref="byte"/> that contains the binary data to be sent.
/// </param>
public void Send(byte[] data)
{
if (data.IsNull())
{
onError("'data' must not be null.");
return;
}
send(Opcode.BINARY, data);
}
/// <summary>
/// Sends a binary data using the connection.
/// </summary>
/// <param name="file">
/// A <see cref="FileInfo"/> that contains the binary data to be sent.
/// A <see cref="FileInfo"/> that contains a binary data to send.
/// </param>
public void Send(FileInfo file)
{
@@ -1323,11 +1323,31 @@ namespace WebSocketSharp {
}
}
/// <summary>
/// Sends a binary data asynchronously using the connection.
/// </summary>
/// <param name="data">
/// An array of <see cref="byte"/> that contains a binary data to send.
/// </param>
/// <param name="completed">
/// An <see cref="Action"/> delegate that contains the method(s) that is called when an asynchronous operation completes.
/// </param>
public void SendAsync(byte[] data, Action completed)
{
if (data.IsNull())
{
onError("'data' must not be null.");
return;
}
sendAsync(Opcode.BINARY, data, completed);
}
/// <summary>
/// Sends a text data asynchronously using the connection.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> that contains the text data to be sent.
/// A <see cref="string"/> that contains a text data to send.
/// </param>
/// <param name="completed">
/// An <see cref="Action"/> delegate that contains the method(s) that is called when an asynchronous operation completes.
@@ -1344,31 +1364,11 @@ namespace WebSocketSharp {
sendAsync(Opcode.TEXT, buffer, completed);
}
/// <summary>
/// Sends a binary data asynchronously using the connection.
/// </summary>
/// <param name="data">
/// An array of <see cref="byte"/> that contains the binary data to be sent.
/// </param>
/// <param name="completed">
/// An <see cref="Action"/> delegate that contains the method(s) that is called when an asynchronous operation completes.
/// </param>
public void SendAsync(byte[] data, Action completed)
{
if (data.IsNull())
{
onError("'data' must not be null.");
return;
}
sendAsync(Opcode.BINARY, data, completed);
}
/// <summary>
/// Sends a binary data asynchronously using the connection.
/// </summary>
/// <param name="file">
/// A <see cref="FileInfo"/> that contains the binary data to be sent.
/// A <see cref="FileInfo"/> that contains a binary data to send.
/// </param>
/// <param name="completed">
/// An <see cref="Action"/> delegate that contains the method(s) that is called when an asynchronous operation completes.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

@@ -9,21 +9,38 @@
Provides a set of static methods for the websocket-sharp.
</summary>
</member>
<member name="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean)">
<member name="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean)">
<summary>
Accept a WebSocket connection by the <see cref="T:System.Net.Sockets.TcpListener" />.
Accepts a WebSocket connection by the <see cref="T:System.Net.Sockets.TcpListener" />.
</summary>
<returns>
A <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" /> that contains a WebSocket connection.
</returns>
<param name="client">
A <see cref="T:System.Net.Sockets.TcpClient" /> that contains a TCP connection to accept a WebSocket connection from.
<param name="listener">
A <see cref="T:System.Net.Sockets.TcpListener" /> that provides a TCP connection to accept a WebSocket connection.
</param>
<param name="secure">
A <see cref="T:System.Boolean" /> that indicates a secure connection or not. (<c>true</c> indicates a secure connection.)
</param>
<exception cref="T:System.ArgumentNullException">
Is thrown when the <paramref name="client" /> parameter passed to a method is invalid because it is <see langword="null" />.
<paramref name="listener" /> is <see langword="null" />.
</exception>
</member>
<member name="M:WebSocketSharp.Ext.AcceptWebSocketAsync(System.Net.Sockets.TcpListener,System.Boolean,System.Action{WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext})">
<summary>
Accepts a WebSocket connection asynchronously by the <see cref="T:System.Net.Sockets.TcpListener" />.
</summary>
<param name="listener">
A <see cref="T:System.Net.Sockets.TcpListener" /> that provides a TCP connection to accept a WebSocket connection.
</param>
<param name="secure">
A <see cref="T:System.Boolean" /> that indicates a secure connection or not. (<c>true</c> indicates a secure connection.)
</param>
<param name="completed">
An Action&lt;TcpListenerWebSocketContext&gt; delegate that contains the method(s) that is called when an asynchronous operation completes.
</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="listener" /> is <see langword="null" />.
</exception>
</member>
<member name="M:WebSocketSharp.Ext.Emit(System.EventHandler,System.Object,System.EventArgs)">
@@ -792,14 +809,9 @@
<paramref name="url" /> is not valid WebSocket URL.
</exception>
</member>
<member name="E:WebSocketSharp.WebSocket.OnOpen">
<member name="E:WebSocketSharp.WebSocket.OnClose">
<summary>
Occurs when the WebSocket connection has been established.
</summary>
</member>
<member name="E:WebSocketSharp.WebSocket.OnMessage">
<summary>
Occurs when the WebSocket receives a data frame.
Occurs when the WebSocket receives a Close frame or the Close method is called.
</summary>
</member>
<member name="E:WebSocketSharp.WebSocket.OnError">
@@ -807,9 +819,14 @@
Occurs when the WebSocket gets an error.
</summary>
</member>
<member name="E:WebSocketSharp.WebSocket.OnClose">
<member name="E:WebSocketSharp.WebSocket.OnMessage">
<summary>
Occurs when the WebSocket receives a Close frame or the Close method is called.
Occurs when the WebSocket receives a data frame.
</summary>
</member>
<member name="E:WebSocketSharp.WebSocket.OnOpen">
<summary>
Occurs when the WebSocket connection has been established.
</summary>
</member>
<member name="P:WebSocketSharp.WebSocket.Extensions">
@@ -870,7 +887,7 @@
Closes the connection and releases all associated resources after sends a Close control frame.
</summary>
<param name="code">
A <see cref="!:WebSocketSharp.Frame.CloseStatusCode" /> that contains a status code indicating a reason for closure.
A <see cref="T:WebSocketSharp.CloseStatusCode" /> that contains a status code indicating a reason for closure.
</param>
</member>
<member name="M:WebSocketSharp.WebSocket.Close(System.UInt16)">
@@ -886,7 +903,7 @@
Closes the connection and releases all associated resources after sends a Close control frame.
</summary>
<param name="code">
A <see cref="!:WebSocketSharp.Frame.CloseStatusCode" /> that contains a status code indicating a reason for closure.
A <see cref="T:WebSocketSharp.CloseStatusCode" /> that contains a status code indicating a reason for closure.
</param>
<param name="reason">
A <see cref="T:System.String" /> that contains a reason for closure.
@@ -938,20 +955,20 @@
<c>true</c> if the WebSocket receives a Pong frame in a time; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:WebSocketSharp.WebSocket.Send(System.String)">
<summary>
Sends a text data using the connection.
</summary>
<param name="data">
A <see cref="T:System.String" /> that contains the text data to be sent.
</param>
</member>
<member name="M:WebSocketSharp.WebSocket.Send(System.Byte[])">
<summary>
Sends a binary data using the connection.
</summary>
<param name="data">
An array of <see cref="T:System.Byte" /> that contains the binary data to be sent.
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
</param>
</member>
<member name="M:WebSocketSharp.WebSocket.Send(System.String)">
<summary>
Sends a text data using the connection.
</summary>
<param name="data">
A <see cref="T:System.String" /> that contains a text data to send.
</param>
</member>
<member name="M:WebSocketSharp.WebSocket.Send(System.IO.FileInfo)">
@@ -959,18 +976,7 @@
Sends a binary data using the connection.
</summary>
<param name="file">
A <see cref="T:System.IO.FileInfo" /> that contains the binary data to be sent.
</param>
</member>
<member name="M:WebSocketSharp.WebSocket.SendAsync(System.String,System.Action)">
<summary>
Sends a text data asynchronously using the connection.
</summary>
<param name="data">
A <see cref="T:System.String" /> that contains the text data to be sent.
</param>
<param name="completed">
An <see cref="T:System.Action" /> delegate that contains the method(s) that is called when an asynchronous operation completes.
A <see cref="T:System.IO.FileInfo" /> that contains a binary data to send.
</param>
</member>
<member name="M:WebSocketSharp.WebSocket.SendAsync(System.Byte[],System.Action)">
@@ -978,7 +984,18 @@
Sends a binary data asynchronously using the connection.
</summary>
<param name="data">
An array of <see cref="T:System.Byte" /> that contains the binary data to be sent.
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
</param>
<param name="completed">
An <see cref="T:System.Action" /> delegate that contains the method(s) that is called when an asynchronous operation completes.
</param>
</member>
<member name="M:WebSocketSharp.WebSocket.SendAsync(System.String,System.Action)">
<summary>
Sends a text data asynchronously using the connection.
</summary>
<param name="data">
A <see cref="T:System.String" /> that contains a text data to send.
</param>
<param name="completed">
An <see cref="T:System.Action" /> delegate that contains the method(s) that is called when an asynchronous operation completes.
@@ -989,7 +1006,7 @@
Sends a binary data asynchronously using the connection.
</summary>
<param name="file">
A <see cref="T:System.IO.FileInfo" /> that contains the binary data to be sent.
A <see cref="T:System.IO.FileInfo" /> that contains a binary data to send.
</param>
<param name="completed">
An <see cref="T:System.Action" /> delegate that contains the method(s) that is called when an asynchronous operation completes.
@@ -1000,17 +1017,17 @@
Provides the functions of the server that receives the WebSocket connection requests.
</summary>
<remarks>
The WebSocketServer class provides multi WebSocket service.
The WebSocketServer class provides the multi WebSocket service.
</remarks>
</member>
<member name="M:WebSocketSharp.Server.WebSocketServer.#ctor">
<summary>
Initializes a new instance of the WebSocketServer class.
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class.
</summary>
</member>
<member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32)">
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified <paramref name="port" />.
</summary>
<param name="port">
@@ -1019,7 +1036,7 @@
</member>
<member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.String)">
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified WebSocket URL.
</summary>
<param name="url">
@@ -1028,7 +1045,7 @@
</member>
<member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32,System.Boolean)">
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified <paramref name="port" /> and <paramref name="secure" />.
</summary>
<param name="port">
@@ -1040,11 +1057,11 @@
</member>
<member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32)">
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified <paramref name="address" /> and <paramref name="port" />.
</summary>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains an IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
@@ -1052,11 +1069,11 @@
</member>
<member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)">
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified <paramref name="address" />, <paramref name="port" /> and <paramref name="secure" />.
</summary>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains an IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
@@ -1065,12 +1082,12 @@
A <see cref="T:System.Boolean" /> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
</param>
</member>
<member name="P:WebSocketSharp.Server.WebSocketServer.ServicePath">
<member name="P:WebSocketSharp.Server.WebSocketServer.ServicePaths">
<summary>
Gets the service paths.
Gets the paths associated with the each WebSocket services.
</summary>
<value>
An IEnumerable&lt;string&gt; that contains the service paths.
An IEnumerable&lt;string&gt; that contains the paths.
</value>
</member>
<member name="P:WebSocketSharp.Server.WebSocketServer.Sweeped">
@@ -1081,28 +1098,28 @@
<c>true</c> if the server cleans up the inactive client; otherwise, <c>false</c>.
</value>
</member>
<member name="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(System.Net.Sockets.TcpClient)">
<member name="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">
<summary>
Accepts the WebSocket connection.
Accepts a WebSocket connection.
</summary>
<param name="client">
A <see cref="T:System.Net.Sockets.TcpClient" /> that contains the TCP connection.
<param name="context">
A <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" /> that contains a WebSocket connection.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketServer.AddService``1(System.String)">
<summary>
Adds the WebSocket service.
Adds a WebSocket service.
</summary>
<param name="absPath">
A <see cref="T:System.String" /> that contains an absolute path associated with the WebSocket service.
A <see cref="T:System.String" /> that contains an absolute path associated with a WebSocket service.
</param>
<typeparam name="T">
The type of the WebSocket service. The T must inherit the <see cref="T:WebSocketSharp.Server.WebSocketService" /> class.
The type of a WebSocket service. The T must inherit the <see cref="T:WebSocketSharp.Server.WebSocketService" /> class.
</typeparam>
</member>
<member name="M:WebSocketSharp.Server.WebSocketServer.Broadcast(System.String)">
<summary>
Broadcasts the specified <see cref="T:System.String" />.
Broadcasts the specified <see cref="T:System.String" /> to all clients.
</summary>
<param name="data">
A <see cref="T:System.String" /> to broadcast.
@@ -1113,6 +1130,244 @@
Stops receiving the WebSocket connection requests.
</summary>
</member>
<member name="T:WebSocketSharp.Server.WebSocketService">
<summary>
Provides the basic functions of the WebSocket service.
</summary>
<remarks>
The WebSocketService class is an abstract class.
</remarks>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.#ctor">
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketService" /> class.
</summary>
</member>
<member name="P:WebSocketSharp.Server.WebSocketService.QueryString">
<summary>
Gets the HTTP query string variables used in the WebSocket opening handshake.
</summary>
<value>
A <see cref="T:System.Collections.Specialized.NameValueCollection" /> that contains the query string variables.
</value>
</member>
<member name="P:WebSocketSharp.Server.WebSocketService.Sessions">
<summary>
Gets the sessions to the WebSocket service.
</summary>
<value>
A <see cref="T:WebSocketSharp.Server.SessionManager" /> that contains the sessions to the WebSocket service.
</value>
</member>
<member name="P:WebSocketSharp.Server.WebSocketService.ID">
<summary>
Gets the ID of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<value>
A <see cref="T:System.String" /> that contains a ID.
</value>
</member>
<member name="P:WebSocketSharp.Server.WebSocketService.IsBound">
<summary>
Gets a value indicating whether a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance is bound to a <see cref="T:WebSocketSharp.WebSocket" />.
</summary>
<value>
<c>true</c> if the WebSocketService is bound to a WebSocket; otherwise, <c>false</c>.
</value>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.OnClose(WebSocketSharp.CloseEventArgs)">
<summary>
Occurs when a inner <see cref="T:WebSocketSharp.WebSocket" /> receives a Close frame or the Stop method is called.
</summary>
<param name="e">
A <see cref="T:WebSocketSharp.CloseEventArgs" /> that contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnClose" /> event.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.OnError(WebSocketSharp.ErrorEventArgs)">
<summary>
Occurs when a inner <see cref="T:WebSocketSharp.WebSocket" /> gets an error.
</summary>
<param name="e">
An <see cref="T:WebSocketSharp.ErrorEventArgs" /> that contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnError" /> event.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.OnMessage(WebSocketSharp.MessageEventArgs)">
<summary>
Occurs when a inner <see cref="T:WebSocketSharp.WebSocket" /> receives a data frame.
</summary>
<param name="e">
A <see cref="T:WebSocketSharp.MessageEventArgs" /> that contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnMessage" /> event.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.OnOpen">
<summary>
Occurs when the WebSocket connection has been established.
</summary>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Bind(WebSocketSharp.WebSocket,WebSocketSharp.Server.SessionManager)">
<summary>
Binds the specified <see cref="T:WebSocketSharp.WebSocket" /> and <see cref="T:WebSocketSharp.Server.SessionManager" />
to a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<param name="socket">
A <see cref="T:WebSocketSharp.WebSocket" /> to bind to the WebSocketService.
</param>
<param name="sessions">
A <see cref="T:WebSocketSharp.Server.SessionManager" /> to bind to the WebSocketService.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Broadcast(System.Byte[])">
<summary>
Broadcasts the specified array of <see cref="T:System.Byte" /> to all clients of the WebSocket service.
</summary>
<param name="data">
An array of <see cref="T:System.Byte" /> to broadcast.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Broadcast(System.String)">
<summary>
Broadcasts the specified <see cref="T:System.String" /> to all clients of the WebSocket service.
</summary>
<param name="data">
A <see cref="T:System.String" /> to broadcast.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Broadping">
<summary>
Pings to all clients of the WebSocket service.
</summary>
<returns>
A Dictionary&lt;string, bool&gt; that contains the collection of the ID and value
indicating whether the WebSocket service received a Pong in a time.
</returns>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Broadping(System.String)">
<summary>
Pings with the specified <see cref="T:System.String" /> to all clients of the WebSocket service.
</summary>
<returns>
A Dictionary&lt;string, bool&gt; that contains the collection of the ID and value
indicating whether the WebSocket service received a Pong in a time.
</returns>
<param name="message">
A <see cref="T:System.String" /> that contains a message.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Ping">
<summary>
Pings to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<returns>
<c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Ping(System.String)">
<summary>
Pings with the specified <see cref="T:System.String" /> to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<returns>
<c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
</returns>
<param name="message">
A <see cref="T:System.String" /> that contains a message.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.PingTo(System.String)">
<summary>
Pings to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance associated with the specified ID.
</summary>
<returns>
<c>true</c> if the WebSocket service receives a Pong in a time; otherwise, <c>false</c>.
</returns>
<param name="id">
A <see cref="T:System.String" /> that contains a ID that represents the destination for the Ping.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.PingTo(System.String,System.String)">
<summary>
Pings with the specified <see cref="T:System.String" /> to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance
associated with the specified ID.
</summary>
<returns>
<c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
</returns>
<param name="id">
A <see cref="T:System.String" /> that contains a ID that represents the destination for the Ping.
</param>
<param name="message">
A <see cref="T:System.String" /> that contains a message.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Send(System.Byte[])">
<summary>
Sends a binary data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<param name="data">
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Send(System.String)">
<summary>
Sends a text data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<param name="data">
A <see cref="T:System.String" /> that contains a text data to send.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.SendTo(System.String,System.Byte[])">
<summary>
Sends a binary data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance associated with the specified ID.
</summary>
<param name="id">
A <see cref="T:System.String" /> that contains a ID that represents the destination for the data.
</param>
<param name="data">
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.SendTo(System.String,System.String)">
<summary>
Sends a text data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance associated with the specified ID.
</summary>
<param name="id">
A <see cref="T:System.String" /> that contains a ID that represents the destination for the data.
</param>
<param name="data">
A <see cref="T:System.String" /> that contains a text data to send.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Start">
<summary>
Starts a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Stop">
<summary>
Stops a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Stop(WebSocketSharp.CloseStatusCode,System.String)">
<summary>
Stops a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance with the specified <see cref="T:WebSocketSharp.CloseStatusCode" /> and <see cref="T:System.String" />.
</summary>
<param name="code">
One of the <see cref="T:WebSocketSharp.CloseStatusCode" /> values that contains a status code indicating the reason for stop.
</param>
<param name="reason">
A <see cref="T:System.String" /> that contains a reason for stop.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketService.Stop(System.UInt16,System.String)">
<summary>
Stops a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance with the specified <see cref="T:System.UInt16" /> and <see cref="T:System.String" />.
</summary>
<param name="code">
A <see cref="T:System.UInt16" /> that contains a status code indicating the reason for stop.
</param>
<param name="reason">
A <see cref="T:System.String" /> that contains a reason for stop.
</param>
</member>
<member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String)">
<summary>
Decodes an HTML-encoded string and returns the decoded string.
@@ -1175,13 +1430,13 @@
on the specified <paramref name="address" />, <paramref name="port" />, <paramref name="absPath" /> and <paramref name="secure" />.
</summary>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains a local IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
</param>
<param name="absPath">
A <see cref="T:System.String" /> that contains a absolute path.
A <see cref="T:System.String" /> that contains an absolute path.
</param>
<param name="secure">
A <see cref="T:System.Boolean" /> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
@@ -1216,18 +1471,18 @@
</member>
<member name="P:WebSocketSharp.Server.WebSocketServerBase.Address">
<summary>
Gets the local IP address on which to listen for incoming connection attempts.
Gets the IP address on which to listen for incoming connection attempts.
</summary>
<value>
A <see cref="T:System.Net.IPAddress" /> that contains a local IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</value>
</member>
<member name="P:WebSocketSharp.Server.WebSocketServerBase.IsSecure">
<summary>
Gets a value indicating whether this server is secure.
Gets a value indicating whether this server provides secure connection.
</summary>
<value>
<c>true</c> if this server is secure; otherwise, <c>false</c>.
<c>true</c> if this server provides secure connection; otherwise, <c>false</c>.
</value>
</member>
<member name="P:WebSocketSharp.Server.WebSocketServerBase.IsSelfHost">
@@ -1246,17 +1501,17 @@
An <see cref="T:System.Int32" /> that contains a port number.
</value>
</member>
<member name="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(System.Net.Sockets.TcpClient)">
<member name="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">
<summary>
Accepts the WebSocket connection.
Accepts a WebSocket connection.
</summary>
<param name="client">
A <see cref="T:System.Net.Sockets.TcpClient" /> that contains the WebSocket connection.
<param name="context">
A <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" /> that contains a WebSocket connection.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketServerBase.Error(System.String)">
<summary>
Occurs the <see cref="E:WebSocketSharp.Server.WebSocketServerBase.OnError" /> event with the specified <paramref name="message" />.
Occurs the <see cref="E:WebSocketSharp.Server.WebSocketServerBase.OnError" /> event with the specified <see cref="T:System.String" />.
</summary>
<param name="message">
A <see cref="T:System.String" /> that contains an error message.
@@ -1318,7 +1573,7 @@
Provides the functions of the server that receives the WebSocket connection requests.
</summary>
<remarks>
The WebSocketServiceHost&lt;T&gt; class provides single WebSocket service.
The WebSocketServiceHost&lt;T&gt; class provides the single WebSocket service.
</remarks>
<typeparam name="T">
The type of the WebSocket service that the server provides. The T must inherit the <see cref="T:WebSocketSharp.Server.WebSocketService" /> class.
@@ -1387,7 +1642,7 @@
on the specified <paramref name="address" />, <paramref name="port" /> and <paramref name="absPath" />.
</summary>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains an IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
@@ -1402,7 +1657,7 @@
on the specified <paramref name="address" />, <paramref name="port" />, <paramref name="absPath" /> and <paramref name="secure" />.
</summary>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains an IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
@@ -1438,17 +1693,17 @@
A <see cref="T:WebSocketSharp.WebSocket" /> to bind.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(System.Net.Sockets.TcpClient)">
<member name="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">
<summary>
Accepts the WebSocket connection.
Accepts a WebSocket connection.
</summary>
<param name="client">
A <see cref="T:System.Net.Sockets.TcpClient" /> that contains the TCP connection.
<param name="context">
A <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" /> that contains a WebSocket connection.
</param>
</member>
<member name="M:WebSocketSharp.Server.WebSocketServiceHost`1.Broadcast(System.String)">
<summary>
Broadcasts the specified <see cref="T:System.String" />.
Broadcasts the specified <see cref="T:System.String" /> to all clients.
</summary>
<param name="data">
A <see cref="T:System.String" /> to broadcast.
@@ -1458,6 +1713,10 @@
<summary>
Pings with the specified <see cref="T:System.String" /> to all clients.
</summary>
<returns>
A Dictionary&lt;string, bool&gt; that contains the collection of the session ID and value
indicating whether the server received a Pong in a time.
</returns>
<param name="message">
A <see cref="T:System.String" /> that contains a message.
</param>

4
websocket-sharp/doc/doc.sh
View File

@@ -1,6 +1,6 @@
#!/bin/sh
#
# @(#) doc.sh ver.0.0.1 2013.01.11
# @(#) doc.sh ver.0.0.2 2013.01.24
#
# Usage:
# doc.sh
@@ -27,5 +27,5 @@ createDir() {
set -e
createDir ${MDOC_DIR}
createDir ${HTML_DIR}
mdoc update -fno-assembly-versions -i ${XML} -o ${MDOC_DIR}/ ${DLL}
mdoc update --delete -fno-assembly-versions -i ${XML} -o ${MDOC_DIR}/ ${DLL}
mdoc export-html -o ${HTML_DIR}/ ${MDOC_DIR}/

98
websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServer.html
View File

@@ -216,7 +216,7 @@
<div class="Remarks" id="T:WebSocketSharp.Server.WebSocketServer:Docs">
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="T:WebSocketSharp.Server.WebSocketServer:Docs:Remarks">
The WebSocketServer class provides multi WebSocket service.
The WebSocketServer class provides the multi WebSocket service.
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="T:WebSocketSharp.Server.WebSocketServer:Docs:Version Information">
@@ -243,7 +243,7 @@
</b>()</div>
</td>
<td>
Initializes a new instance of the WebSocketServer class.
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class.
</td>
</tr>
<tr valign="top">
@@ -258,7 +258,7 @@
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>)</div>
</td>
<td>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified <i>port</i>.
</td>
</tr>
@@ -274,7 +274,7 @@
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)</div>
</td>
<td>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified WebSocket URL.
</td>
</tr>
@@ -290,7 +290,7 @@
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>)</div>
</td>
<td>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified <i>port</i> and <i>secure</i>.
</td>
</tr>
@@ -306,7 +306,7 @@
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>)</div>
</td>
<td>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified <i>address</i> and <i>port</i>.
</td>
</tr>
@@ -322,7 +322,7 @@
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>)</div>
</td>
<td>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified <i>address</i>, <i>port</i> and <i>secure</i>.
</td>
</tr>
@@ -344,7 +344,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a>
</i>.
Gets the local IP address on which to listen for incoming connection attempts.
Gets the IP address on which to listen for incoming connection attempts.
(<i>Inherited from <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketServerBase</a>.</i>)</td>
</tr>
<tr valign="top">
@@ -358,7 +358,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
</i>.
Gets a value indicating whether this server is secure.
Gets a value indicating whether this server provides secure connection.
(<i>Inherited from <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketServerBase</a>.</i>)</td>
</tr>
<tr valign="top">
@@ -393,14 +393,14 @@
<td>[read-only]<div></div></td>
<td>
<b>
<a href="#P:WebSocketSharp.Server.WebSocketServer.ServicePath">ServicePath</a>
<a href="#P:WebSocketSharp.Server.WebSocketServer.ServicePaths">ServicePaths</a>
</b>
</td>
<td>
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Collections.Generic.IEnumerable`1">IEnumerable&lt;string&gt;</a>
</i>.
Gets the service paths.
Gets the paths associated with the each WebSocket services.
</td>
</tr>
<tr valign="top">
@@ -460,7 +460,7 @@
<b>
<a href="#M:WebSocketSharp.Server.WebSocketServer.AddService``1(System.String)">AddService&lt;T&gt;</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
Adds the WebSocket service.
Adds a WebSocket service.
</blockquote></td>
</tr>
<tr valign="top">
@@ -472,7 +472,7 @@
<b>
<a href="#M:WebSocketSharp.Server.WebSocketServer.Broadcast(System.String)">Broadcast</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
Broadcasts the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
Broadcasts the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> to all clients.
</blockquote></td>
</tr>
<tr valign="top">
@@ -523,9 +523,9 @@
</td>
<td colspan="2">
<b>
<a href="#M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(System.Net.Sockets.TcpClient)">AcceptWebSocket</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a>)<blockquote>
Accepts the WebSocket connection.
<a href="#M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket</a>
</b>(<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a>)<blockquote>
Accepts a WebSocket connection.
</blockquote></td>
</tr>
<tr valign="top">
@@ -534,9 +534,9 @@
</td>
<td colspan="2">
<b>
<a href="../WebSocketSharp.Server/WebSocketServerBase.html#M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(System.Net.Sockets.TcpClient)">AcceptWebSocket</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a>)<blockquote>
Accepts the WebSocket connection.
<a href="../WebSocketSharp.Server/WebSocketServerBase.html#M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket</a>
</b>(<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a>)<blockquote>
Accepts a WebSocket connection.
(<i>Inherited from <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketServerBase</a>.</i>)</blockquote></td>
</tr>
<tr valign="top">
@@ -548,7 +548,7 @@
<b>
<a href="../WebSocketSharp.Server/WebSocketServerBase.html#M:WebSocketSharp.Server.WebSocketServerBase.Error(System.String)">Error</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <i>message</i>.
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
(<i>Inherited from <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketServerBase</a>.</i>)</blockquote></td>
</tr>
</table>
@@ -613,7 +613,7 @@
<h3 id="C:WebSocketSharp.Server.WebSocketServer">WebSocketServer Constructor</h3>
<blockquote id="C:WebSocketSharp.Server.WebSocketServer:member">
<p class="Summary">
Initializes a new instance of the WebSocketServer class.
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class.
</p>
<h2>Syntax</h2>
<div class="Signature">public <b>WebSocketServer</b> ()</div>
@@ -629,7 +629,7 @@
<h3 id="C:WebSocketSharp.Server.WebSocketServer(System.Int32)">WebSocketServer Constructor</h3>
<blockquote id="C:WebSocketSharp.Server.WebSocketServer(System.Int32):member">
<p class="Summary">
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified <i>port</i>.
</p>
<h2>Syntax</h2>
@@ -657,7 +657,7 @@
<h3 id="C:WebSocketSharp.Server.WebSocketServer(System.String)">WebSocketServer Constructor</h3>
<blockquote id="C:WebSocketSharp.Server.WebSocketServer(System.String):member">
<p class="Summary">
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified WebSocket URL.
</p>
<h2>Syntax</h2>
@@ -685,7 +685,7 @@
<h3 id="C:WebSocketSharp.Server.WebSocketServer(System.Int32,System.Boolean)">WebSocketServer Constructor</h3>
<blockquote id="C:WebSocketSharp.Server.WebSocketServer(System.Int32,System.Boolean):member">
<p class="Summary">
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified <i>port</i> and <i>secure</i>.
</p>
<h2>Syntax</h2>
@@ -719,7 +719,7 @@
<h3 id="C:WebSocketSharp.Server.WebSocketServer(System.Net.IPAddress,System.Int32)">WebSocketServer Constructor</h3>
<blockquote id="C:WebSocketSharp.Server.WebSocketServer(System.Net.IPAddress,System.Int32):member">
<p class="Summary">
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified <i>address</i> and <i>port</i>.
</p>
<h2>Syntax</h2>
@@ -731,7 +731,7 @@
<i>address</i>
</dt>
<dd>
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
</dd>
<dt>
<i>port</i>
@@ -753,7 +753,7 @@
<h3 id="C:WebSocketSharp.Server.WebSocketServer(System.Net.IPAddress,System.Int32,System.Boolean)">WebSocketServer Constructor</h3>
<blockquote id="C:WebSocketSharp.Server.WebSocketServer(System.Net.IPAddress,System.Int32,System.Boolean):member">
<p class="Summary">
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServer.html">WebSocketSharp.Server.WebSocketServer</a> class that listens for incoming connection attempts
on the specified <i>address</i>, <i>port</i> and <i>secure</i>.
</p>
<h2>Syntax</h2>
@@ -765,7 +765,7 @@
<i>address</i>
</dt>
<dd>
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
</dd>
<dt>
<i>port</i>
@@ -790,37 +790,37 @@
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(System.Net.Sockets.TcpClient)">AcceptWebSocket Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(System.Net.Sockets.TcpClient):member">
<h3 id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):member">
<p class="Summary">
Accepts the WebSocket connection.
Accepts a WebSocket connection.
</p>
<h2>Syntax</h2>
<div class="Signature">protected override <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>AcceptWebSocket</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a> client)</div>
<div class="Signature">protected override <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>AcceptWebSocket</b> (<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> context)</div>
<h4 class="Subsection">Parameters</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(System.Net.Sockets.TcpClient):Parameters">
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Parameters">
<dl>
<dt>
<i>client</i>
<i>context</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a> that contains the TCP connection.
A <a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> that contains a WebSocket connection.
</dd>
</dl>
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(System.Net.Sockets.TcpClient):Remarks">
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(System.Net.Sockets.TcpClient):Version Information">
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServer.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Version Information">
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="M:WebSocketSharp.Server.WebSocketServer.AddService``1(System.String)">AddService&lt;T&gt; Generic Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServer.AddService``1(System.String):member">
<p class="Summary">
Adds the WebSocket service.
Adds a WebSocket service.
</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>AddService&lt;T&gt;</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> absPath)<br /> where T : <a href="../WebSocketSharp.Server/WebSocketService.html">WebSocketSharp.Server.WebSocketService</a>, new()</div>
@@ -831,7 +831,7 @@
<i>T</i>
</dt>
<dd>
The type of the WebSocket service. The T must inherit the <a href="../WebSocketSharp.Server/WebSocketService.html">WebSocketSharp.Server.WebSocketService</a> class.
The type of a WebSocket service. The T must inherit the <a href="../WebSocketSharp.Server/WebSocketService.html">WebSocketSharp.Server.WebSocketService</a> class.
</dd>
</dl>
</blockquote>
@@ -842,7 +842,7 @@
<i>absPath</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains an absolute path associated with the WebSocket service.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains an absolute path associated with a WebSocket service.
</dd>
</dl>
</blockquote>
@@ -858,7 +858,7 @@
<h3 id="M:WebSocketSharp.Server.WebSocketServer.Broadcast(System.String)">Broadcast Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServer.Broadcast(System.String):member">
<p class="Summary">
Broadcasts the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
Broadcasts the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> to all clients.
</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>Broadcast</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> data)</div>
@@ -882,23 +882,23 @@
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="P:WebSocketSharp.Server.WebSocketServer.ServicePath">ServicePath Property</h3>
<blockquote id="P:WebSocketSharp.Server.WebSocketServer.ServicePath:member">
<h3 id="P:WebSocketSharp.Server.WebSocketServer.ServicePaths">ServicePaths Property</h3>
<blockquote id="P:WebSocketSharp.Server.WebSocketServer.ServicePaths:member">
<p class="Summary">
Gets the service paths.
Gets the paths associated with the each WebSocket services.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Collections.Generic.IEnumerable`1">IEnumerable&lt;string&gt;</a> <b>ServicePath</b> { get; }</div>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Collections.Generic.IEnumerable`1">IEnumerable&lt;string&gt;</a> <b>ServicePaths</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.WebSocketServer.ServicePath:Value">
An IEnumerable&lt;string&gt; that contains the service paths.
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.WebSocketServer.ServicePaths:Value">
An IEnumerable&lt;string&gt; that contains the paths.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServer.ServicePath:Remarks">
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServer.ServicePaths:Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServer.ServicePath:Version Information">
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServer.ServicePaths:Version Information">
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>

44
websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServerBase.html
View File

@@ -296,7 +296,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a>
</i>.
Gets the local IP address on which to listen for incoming connection attempts.
Gets the IP address on which to listen for incoming connection attempts.
</td>
</tr>
<tr valign="top">
@@ -310,7 +310,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
</i>.
Gets a value indicating whether this server is secure.
Gets a value indicating whether this server provides secure connection.
</td>
</tr>
<tr valign="top">
@@ -409,9 +409,9 @@
</td>
<td colspan="2">
<b>
<a href="#M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(System.Net.Sockets.TcpClient)">AcceptWebSocket</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a>)<blockquote>
Accepts the WebSocket connection.
<a href="#M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket</a>
</b>(<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a>)<blockquote>
Accepts a WebSocket connection.
</blockquote></td>
</tr>
<tr valign="top">
@@ -423,7 +423,7 @@
<b>
<a href="#M:WebSocketSharp.Server.WebSocketServerBase.Error(System.String)">Error</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <i>message</i>.
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
</blockquote></td>
</tr>
</table>
@@ -569,7 +569,7 @@
<i>address</i>
</dt>
<dd>
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains a local IP address.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
</dd>
<dt>
<i>port</i>
@@ -581,7 +581,7 @@
<i>absPath</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains a absolute path.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains an absolute path.
</dd>
<dt>
<i>secure</i>
@@ -633,43 +633,43 @@
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(System.Net.Sockets.TcpClient)">AcceptWebSocket Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(System.Net.Sockets.TcpClient):member">
<h3 id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):member">
<p class="Summary">
Accepts the WebSocket connection.
Accepts a WebSocket connection.
</p>
<h2>Syntax</h2>
<div class="Signature">protected abstract <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>AcceptWebSocket</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a> client)</div>
<div class="Signature">protected abstract <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>AcceptWebSocket</b> (<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> context)</div>
<h4 class="Subsection">Parameters</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(System.Net.Sockets.TcpClient):Parameters">
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Parameters">
<dl>
<dt>
<i>client</i>
<i>context</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a> that contains the WebSocket connection.
A <a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> that contains a WebSocket connection.
</dd>
</dl>
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(System.Net.Sockets.TcpClient):Remarks">
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(System.Net.Sockets.TcpClient):Version Information">
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Version Information">
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="P:WebSocketSharp.Server.WebSocketServerBase.Address">Address Property</h3>
<blockquote id="P:WebSocketSharp.Server.WebSocketServerBase.Address:member">
<p class="Summary">
Gets the local IP address on which to listen for incoming connection attempts.
Gets the IP address on which to listen for incoming connection attempts.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> <b>Address</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.Address:Value">
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains a local IP address.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.Address:Remarks">
@@ -703,7 +703,7 @@
<h3 id="M:WebSocketSharp.Server.WebSocketServerBase.Error(System.String)">Error Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServerBase.Error(System.String):member">
<p class="Summary">
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <i>message</i>.
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
</p>
<h2>Syntax</h2>
<div class="Signature">protected virtual <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Error</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> message)</div>
@@ -730,13 +730,13 @@
<h3 id="P:WebSocketSharp.Server.WebSocketServerBase.IsSecure">IsSecure Property</h3>
<blockquote id="P:WebSocketSharp.Server.WebSocketServerBase.IsSecure:member">
<p class="Summary">
Gets a value indicating whether this server is secure.
Gets a value indicating whether this server provides secure connection.
</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>IsSecure</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.IsSecure:Value">
<tt>true</tt> if this server is secure; otherwise, <tt>false</tt>.
<tt>true</tt> if this server provides secure connection; otherwise, <tt>false</tt>.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.IsSecure:Remarks">

685
websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketService.html
View File

File diff suppressed because it is too large Load Diff

51
websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServiceHost`1.html
View File

@@ -227,7 +227,7 @@
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="T:WebSocketSharp.Server.WebSocketServiceHost`1:Docs:Remarks">
The WebSocketServiceHost&lt;T&gt; class provides single WebSocket service.
The WebSocketServiceHost&lt;T&gt; class provides the single WebSocket service.
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="T:WebSocketSharp.Server.WebSocketServiceHost`1:Docs:Version Information">
@@ -372,7 +372,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a>
</i>.
Gets the local IP address on which to listen for incoming connection attempts.
Gets the IP address on which to listen for incoming connection attempts.
(<i>Inherited from <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketServerBase</a>.</i>)</td>
</tr>
<tr valign="top">
@@ -386,7 +386,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
</i>.
Gets a value indicating whether this server is secure.
Gets a value indicating whether this server provides secure connection.
(<i>Inherited from <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketServerBase</a>.</i>)</td>
</tr>
<tr valign="top">
@@ -488,7 +488,7 @@
<b>
<a href="#M:WebSocketSharp.Server.WebSocketServiceHost`1.Broadcast(System.String)">Broadcast</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
Broadcasts the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
Broadcasts the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> to all clients.
</blockquote></td>
</tr>
<tr valign="top">
@@ -551,9 +551,9 @@
</td>
<td colspan="2">
<b>
<a href="#M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(System.Net.Sockets.TcpClient)">AcceptWebSocket</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a>)<blockquote>
Accepts the WebSocket connection.
<a href="#M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket</a>
</b>(<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a>)<blockquote>
Accepts a WebSocket connection.
</blockquote></td>
</tr>
<tr valign="top">
@@ -562,9 +562,9 @@
</td>
<td colspan="2">
<b>
<a href="../WebSocketSharp.Server/WebSocketServerBase.html#M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(System.Net.Sockets.TcpClient)">AcceptWebSocket</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a>)<blockquote>
Accepts the WebSocket connection.
<a href="../WebSocketSharp.Server/WebSocketServerBase.html#M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket</a>
</b>(<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a>)<blockquote>
Accepts a WebSocket connection.
(<i>Inherited from <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketServerBase</a>.</i>)</blockquote></td>
</tr>
<tr valign="top">
@@ -576,7 +576,7 @@
<b>
<a href="../WebSocketSharp.Server/WebSocketServerBase.html#M:WebSocketSharp.Server.WebSocketServerBase.Error(System.String)">Error</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <i>message</i>.
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
(<i>Inherited from <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketServerBase</a>.</i>)</blockquote></td>
</tr>
</table>
@@ -838,7 +838,7 @@
<i>address</i>
</dt>
<dd>
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
</dd>
<dt>
<i>port</i>
@@ -878,7 +878,7 @@
<i>address</i>
</dt>
<dd>
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains an IP address.
</dd>
<dt>
<i>port</i>
@@ -909,37 +909,37 @@
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(System.Net.Sockets.TcpClient)">AcceptWebSocket Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(System.Net.Sockets.TcpClient):member">
<h3 id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):member">
<p class="Summary">
Accepts the WebSocket connection.
Accepts a WebSocket connection.
</p>
<h2>Syntax</h2>
<div class="Signature">protected override <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>AcceptWebSocket</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a> client)</div>
<div class="Signature">protected override <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>AcceptWebSocket</b> (<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> context)</div>
<h4 class="Subsection">Parameters</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(System.Net.Sockets.TcpClient):Parameters">
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Parameters">
<dl>
<dt>
<i>client</i>
<i>context</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a> that contains the TCP connection.
A <a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> that contains a WebSocket connection.
</dd>
</dl>
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(System.Net.Sockets.TcpClient):Remarks">
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(System.Net.Sockets.TcpClient):Version Information">
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServiceHost`1.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Version Information">
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="M:WebSocketSharp.Server.WebSocketServiceHost`1.Broadcast(System.String)">Broadcast Method</h3>
<blockquote id="M:WebSocketSharp.Server.WebSocketServiceHost`1.Broadcast(System.String):member">
<p class="Summary">
Broadcasts the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
Broadcasts the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> to all clients.
</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>Broadcast</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> data)</div>
@@ -983,8 +983,9 @@
</blockquote>
<h4 class="Subsection">Returns</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.WebSocketServiceHost`1.Broadping(System.String):Returns">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</blockquote>
A Dictionary&lt;string, bool&gt; that contains the collection of the session ID and value
indicating whether the server received a Pong in a time.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServiceHost`1.Broadping(System.String):Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>

4
websocket-sharp/doc/html/WebSocketSharp.Server/index.html
View File

@@ -263,8 +263,8 @@
<a href="./WebSocketService.html">WebSocketService</a>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
Provides the basic functions of the WebSocket service.
</td>
</tr>
<tr valign="top">
<td>

97
websocket-sharp/doc/html/WebSocketSharp/Ext.html
View File

@@ -237,9 +237,20 @@
</td>
<td colspan="2">
<b>
<a href="#M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean)">AcceptWebSocket</a>
</b>(<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>)<nobr> : <a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a></nobr><blockquote>
Accept a WebSocket connection by the <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a>.
<a href="#M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean)">AcceptWebSocket</a>
</b>(<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>)<nobr> : <a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a></nobr><blockquote>
Accepts a WebSocket connection by the <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a>.
</blockquote></td>
</tr>
<tr valign="top">
<td>
<div>static </div>
</td>
<td colspan="2">
<b>
<a href="#M:WebSocketSharp.Ext.AcceptWebSocketAsync(System.Net.Sockets.TcpListener,System.Boolean,System.Action{WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext})">AcceptWebSocketAsync</a>
</b>(<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Action`1">Action&lt;WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext&gt;</a>)<blockquote>
Accepts a WebSocket connection asynchronously by the <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a>.
</blockquote></td>
</tr>
<tr valign="top">
@@ -704,21 +715,21 @@
<div class="Members" id="T:WebSocketSharp.Ext:Members">
<h2 class="Section" id="MemberDetails">Member Details</h2>
<div class="SectionBox" id="_MemberDetails">
<h3 id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean)">AcceptWebSocket Method</h3>
<blockquote id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean):member">
<h3 id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean)">AcceptWebSocket Method</h3>
<blockquote id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean):member">
<p class="Summary">
Accept a WebSocket connection by the <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a>.
Accepts a WebSocket connection by the <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a>.
</p>
<h2>Syntax</h2>
<div class="Signature">public static <a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> <b>AcceptWebSocket</b> (<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a> client, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> secure)</div>
<div class="Signature">public static <a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> <b>AcceptWebSocket</b> (<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a> listener, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> secure)</div>
<h4 class="Subsection">Parameters</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean):Parameters">
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean):Parameters">
<dl>
<dt>
<i>client</i>
<i>listener</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpClient">System.Net.Sockets.TcpClient</a> that contains a TCP connection to accept a WebSocket connection from.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a> that provides a TCP connection to accept a WebSocket connection.
</dd>
<dt>
<i>secure</i>
@@ -729,11 +740,11 @@
</dl>
</blockquote>
<h4 class="Subsection">Returns</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean):Returns">
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean):Returns">
A <a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> that contains a WebSocket connection.
</blockquote>
<h4 class="Subsection">Exceptions</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean):Exceptions">
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean):Exceptions">
<table class="TypeDocumentation">
<tr>
<th>Type</th>
@@ -744,17 +755,73 @@
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.ArgumentNullException">ArgumentNullException</a>
</td>
<td>
Is thrown when the <i>client</i> parameter passed to a method is invalid because it is <tt>null</tt>.
<i>listener</i> is <tt>null</tt>.
</td>
</tr>
</table>
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean):Remarks">
<div class="SectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean):Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean):Version Information">
<div class="SectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean):Version Information">
<b>Namespace: </b>WebSocketSharp<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="M:WebSocketSharp.Ext.AcceptWebSocketAsync(System.Net.Sockets.TcpListener,System.Boolean,System.Action{WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext})">AcceptWebSocketAsync Method</h3>
<blockquote id="M:WebSocketSharp.Ext.AcceptWebSocketAsync(System.Net.Sockets.TcpListener,System.Boolean,System.Action{WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext}):member">
<p class="Summary">
Accepts a WebSocket connection asynchronously by the <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a>.
</p>
<h2>Syntax</h2>
<div class="Signature">public static <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>AcceptWebSocketAsync</b> (<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a> listener, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> secure, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Action`1">Action&lt;WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext&gt;</a> completed)</div>
<h4 class="Subsection">Parameters</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocketAsync(System.Net.Sockets.TcpListener,System.Boolean,System.Action{WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext}):Parameters">
<dl>
<dt>
<i>listener</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a> that provides a TCP connection to accept a WebSocket connection.
</dd>
<dt>
<i>secure</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> that indicates a secure connection or not. (<tt>true</tt> indicates a secure connection.)
</dd>
<dt>
<i>completed</i>
</dt>
<dd>
An Action&lt;TcpListenerWebSocketContext&gt; delegate that contains the method(s) that is called when an asynchronous operation completes.
</dd>
</dl>
</blockquote>
<h4 class="Subsection">Exceptions</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocketAsync(System.Net.Sockets.TcpListener,System.Boolean,System.Action{WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext}):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>listener</i> is <tt>null</tt>.
</td>
</tr>
</table>
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocketAsync(System.Net.Sockets.TcpListener,System.Boolean,System.Action{WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext}):Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="M:WebSocketSharp.Ext.AcceptWebSocketAsync(System.Net.Sockets.TcpListener,System.Boolean,System.Action{WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext}):Version Information">
<b>Namespace: </b>WebSocketSharp<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>

16
websocket-sharp/doc/html/WebSocketSharp/WebSocket.html
View File

@@ -837,7 +837,7 @@
<i>code</i>
</dt>
<dd>
A <a href="javascript:alert(&quot;Documentation not found.&quot;)">Frame.CloseStatusCode</a> that contains a status code indicating a reason for closure.
A <a href="../WebSocketSharp/CloseStatusCode.html">WebSocketSharp.CloseStatusCode</a> that contains a status code indicating a reason for closure.
</dd>
</dl>
</blockquote>
@@ -897,7 +897,7 @@
<i>code</i>
</dt>
<dd>
A <a href="javascript:alert(&quot;Documentation not found.&quot;)">Frame.CloseStatusCode</a> that contains a status code indicating a reason for closure.
A <a href="../WebSocketSharp/CloseStatusCode.html">WebSocketSharp.CloseStatusCode</a> that contains a status code indicating a reason for closure.
</dd>
<dt>
<i>reason</i>
@@ -1180,7 +1180,7 @@
<i>data</i>
</dt>
<dd>
An array of <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Byte">byte</a> that contains the binary data to be sent.
An array of <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Byte">byte</a> that contains a binary data to send.
</dd>
</dl>
</blockquote>
@@ -1207,7 +1207,7 @@
<i>file</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IO.FileInfo">System.IO.FileInfo</a> that contains the binary data to be sent.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IO.FileInfo">System.IO.FileInfo</a> that contains a binary data to send.
</dd>
</dl>
</blockquote>
@@ -1234,7 +1234,7 @@
<i>data</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains the text data to be sent.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains a text data to send.
</dd>
</dl>
</blockquote>
@@ -1261,7 +1261,7 @@
<i>data</i>
</dt>
<dd>
An array of <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Byte">byte</a> that contains the binary data to be sent.
An array of <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Byte">byte</a> that contains a binary data to send.
</dd>
<dt>
<i>completed</i>
@@ -1294,7 +1294,7 @@
<i>file</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IO.FileInfo">System.IO.FileInfo</a> that contains the binary data to be sent.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IO.FileInfo">System.IO.FileInfo</a> that contains a binary data to send.
</dd>
<dt>
<i>completed</i>
@@ -1327,7 +1327,7 @@
<i>data</i>
</dt>
<dd>
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains the text data to be sent.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains a text data to send.
</dd>
<dt>
<i>completed</i>

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

@@ -511,8 +511,8 @@
<a href="WebSocketSharp.Server/WebSocketService.html">WebSocketService</a>
</td>
<td>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</td>
Provides the basic functions of the WebSocket service.
</td>
</tr>
<tr valign="top">
<td>

48
websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServer.xml
View File

@@ -13,7 +13,7 @@
Provides the functions of the server that receives the WebSocket connection requests.
</summary>
<remarks>
The WebSocketServer class provides multi WebSocket service.
The WebSocketServer class provides the multi WebSocket service.
</remarks>
</Docs>
<Members>
@@ -24,7 +24,7 @@
<Parameters />
<Docs>
<summary>
Initializes a new instance of the WebSocketServer class.
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
@@ -41,7 +41,7 @@
An <see cref="T:System.Int32" /> that contains a port number.
</param>
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified <paramref name="port" />.
</summary>
<remarks>To be added.</remarks>
@@ -59,7 +59,7 @@
A <see cref="T:System.String" /> that contains a WebSocket URL.
</param>
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified WebSocket URL.
</summary>
<remarks>To be added.</remarks>
@@ -81,7 +81,7 @@
A <see cref="T:System.Boolean" /> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
</param>
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified <paramref name="port" /> and <paramref name="secure" />.
</summary>
<remarks>To be added.</remarks>
@@ -97,13 +97,13 @@
</Parameters>
<Docs>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains an IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
</param>
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified <paramref name="address" /> and <paramref name="port" />.
</summary>
<remarks>To be added.</remarks>
@@ -120,7 +120,7 @@
</Parameters>
<Docs>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains an IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
@@ -129,28 +129,28 @@
A <see cref="T:System.Boolean" /> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
</param>
<summary>
Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer" /> class that listens for incoming connection attempts
on the specified <paramref name="address" />, <paramref name="port" /> and <paramref name="secure" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AcceptWebSocket">
<MemberSignature Language="C#" Value="protected override void AcceptWebSocket (System.Net.Sockets.TcpClient client);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void AcceptWebSocket(class System.Net.Sockets.TcpClient client) cil managed" />
<MemberSignature Language="C#" Value="protected override void AcceptWebSocket (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void AcceptWebSocket(class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="System.Net.Sockets.TcpClient" />
<Parameter Name="context" Type="WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" />
</Parameters>
<Docs>
<param name="client">
A <see cref="T:System.Net.Sockets.TcpClient" /> that contains the TCP connection.
<param name="context">
A <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" /> that contains a WebSocket connection.
</param>
<summary>
Accepts the WebSocket connection.
Accepts a WebSocket connection.
</summary>
<remarks>To be added.</remarks>
</Docs>
@@ -175,13 +175,13 @@
</Parameters>
<Docs>
<typeparam name="T">
The type of the WebSocket service. The T must inherit the <see cref="T:WebSocketSharp.Server.WebSocketService" /> class.
The type of a WebSocket service. The T must inherit the <see cref="T:WebSocketSharp.Server.WebSocketService" /> class.
</typeparam>
<param name="absPath">
A <see cref="T:System.String" /> that contains an absolute path associated with the WebSocket service.
A <see cref="T:System.String" /> that contains an absolute path associated with a WebSocket service.
</param>
<summary>
Adds the WebSocket service.
Adds a WebSocket service.
</summary>
<remarks>To be added.</remarks>
</Docs>
@@ -201,24 +201,24 @@
A <see cref="T:System.String" /> to broadcast.
</param>
<summary>
Broadcasts the specified <see cref="T:System.String" />.
Broadcasts the specified <see cref="T:System.String" /> to all clients.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServicePath">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;string&gt; ServicePath { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;string&gt; ServicePath" />
<Member MemberName="ServicePaths">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;string&gt; ServicePaths { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;string&gt; ServicePaths" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.String&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the service paths.
Gets the paths associated with the each WebSocket services.
</summary>
<value>
An IEnumerable&lt;string&gt; that contains the service paths.
An IEnumerable&lt;string&gt; that contains the paths.
</value>
<remarks>To be added.</remarks>
</Docs>

26
websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServerBase.xml
View File

@@ -65,13 +65,13 @@
</Parameters>
<Docs>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains a local IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
</param>
<param name="absPath">
A <see cref="T:System.String" /> that contains a absolute path.
A <see cref="T:System.String" /> that contains an absolute path.
</param>
<param name="secure">
A <see cref="T:System.Boolean" /> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
@@ -98,21 +98,21 @@
</Docs>
</Member>
<Member MemberName="AcceptWebSocket">
<MemberSignature Language="C#" Value="protected abstract void AcceptWebSocket (System.Net.Sockets.TcpClient client);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void AcceptWebSocket(class System.Net.Sockets.TcpClient client) cil managed" />
<MemberSignature Language="C#" Value="protected abstract void AcceptWebSocket (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void AcceptWebSocket(class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="System.Net.Sockets.TcpClient" />
<Parameter Name="context" Type="WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" />
</Parameters>
<Docs>
<param name="client">
A <see cref="T:System.Net.Sockets.TcpClient" /> that contains the WebSocket connection.
<param name="context">
A <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" /> that contains a WebSocket connection.
</param>
<summary>
Accepts the WebSocket connection.
Accepts a WebSocket connection.
</summary>
<remarks>To be added.</remarks>
</Docs>
@@ -126,10 +126,10 @@
</ReturnValue>
<Docs>
<summary>
Gets the local IP address on which to listen for incoming connection attempts.
Gets the IP address on which to listen for incoming connection attempts.
</summary>
<value>
A <see cref="T:System.Net.IPAddress" /> that contains a local IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</value>
<remarks>To be added.</remarks>
</Docs>
@@ -166,7 +166,7 @@
A <see cref="T:System.String" /> that contains an error message.
</param>
<summary>
Occurs the <see cref="E:WebSocketSharp.Server.WebSocketServerBase.OnError" /> event with the specified <paramref name="message" />.
Occurs the <see cref="E:WebSocketSharp.Server.WebSocketServerBase.OnError" /> event with the specified <see cref="T:System.String" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
@@ -180,10 +180,10 @@
</ReturnValue>
<Docs>
<summary>
Gets a value indicating whether this server is secure.
Gets a value indicating whether this server provides secure connection.
</summary>
<value>
<c>true</c> if this server is secure; otherwise, <c>false</c>.
<c>true</c> if this server provides secure connection; otherwise, <c>false</c>.
</value>
<remarks>To be added.</remarks>
</Docs>

381
websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketService.xml
View File

@@ -9,8 +9,12 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>
Provides the basic functions of the WebSocket service.
</summary>
<remarks>
The WebSocketService class is an abstract class.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
@@ -19,7 +23,9 @@
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketService" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -35,9 +41,99 @@
<Parameter Name="sessions" Type="WebSocketSharp.Server.SessionManager" />
</Parameters>
<Docs>
<param name="socket">To be added.</param>
<param name="sessions">To be added.</param>
<summary>To be added.</summary>
<param name="socket">
A <see cref="T:WebSocketSharp.WebSocket" /> to bind to the WebSocketService.
</param>
<param name="sessions">
A <see cref="T:WebSocketSharp.Server.SessionManager" /> to bind to the WebSocketService.
</param>
<summary>
Binds the specified <see cref="T:WebSocketSharp.WebSocket" /> and <see cref="T:WebSocketSharp.Server.SessionManager" />
to a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Broadcast">
<MemberSignature Language="C#" Value="public void Broadcast (byte[] data);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Broadcast(unsigned int8[] data) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="data">
An array of <see cref="T:System.Byte" /> to broadcast.
</param>
<summary>
Broadcasts the specified array of <see cref="T:System.Byte" /> to all clients of the WebSocket service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Broadcast">
<MemberSignature Language="C#" Value="public void Broadcast (string data);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Broadcast(string data) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<param name="data">
A <see cref="T:System.String" /> to broadcast.
</param>
<summary>
Broadcasts the specified <see cref="T:System.String" /> to all clients of the WebSocket service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Broadping">
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary&lt;string,bool&gt; Broadping ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.Dictionary`2&lt;string, bool&gt; Broadping() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.Generic.Dictionary&lt;System.String,System.Boolean&gt;</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Pings to all clients of the WebSocket service.
</summary>
<returns>
A Dictionary&lt;string, bool&gt; that contains the collection of the ID and value
indicating whether the WebSocket service received a Pong in a time.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Broadping">
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary&lt;string,bool&gt; Broadping (string message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.Dictionary`2&lt;string, bool&gt; Broadping(string message) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.Generic.Dictionary&lt;System.String,System.Boolean&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">
A <see cref="T:System.String" /> that contains a message.
</param>
<summary>
Pings with the specified <see cref="T:System.String" /> to all clients of the WebSocket service.
</summary>
<returns>
A Dictionary&lt;string, bool&gt; that contains the collection of the ID and value
indicating whether the WebSocket service received a Pong in a time.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -49,8 +145,12 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>
Gets the ID of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<value>
A <see cref="T:System.String" /> that contains a ID.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -62,80 +162,87 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>
Gets a value indicating whether a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance is bound to a <see cref="T:WebSocketSharp.WebSocket" />.
</summary>
<value>
<c>true</c> if the WebSocketService is bound to a WebSocket; otherwise, <c>false</c>.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnClose">
<MemberSignature Language="C#" Value="protected virtual void OnClose (object sender, WebSocketSharp.CloseEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnClose(object sender, class WebSocketSharp.CloseEventArgs e) cil managed" />
<MemberSignature Language="C#" Value="protected virtual void OnClose (WebSocketSharp.CloseEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnClose(class WebSocketSharp.CloseEventArgs e) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="WebSocketSharp.CloseEventArgs" />
</Parameters>
<Docs>
<param name="sender">To be added.</param>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<param name="e">
A <see cref="T:WebSocketSharp.CloseEventArgs" /> that contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnClose" /> event.
</param>
<summary>
Occurs when a inner <see cref="T:WebSocketSharp.WebSocket" /> receives a Close frame or the Stop method is called.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnError">
<MemberSignature Language="C#" Value="protected virtual void OnError (object sender, WebSocketSharp.ErrorEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnError(object sender, class WebSocketSharp.ErrorEventArgs e) cil managed" />
<MemberSignature Language="C#" Value="protected virtual void OnError (WebSocketSharp.ErrorEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnError(class WebSocketSharp.ErrorEventArgs e) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="WebSocketSharp.ErrorEventArgs" />
</Parameters>
<Docs>
<param name="sender">To be added.</param>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<param name="e">
An <see cref="T:WebSocketSharp.ErrorEventArgs" /> that contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnError" /> event.
</param>
<summary>
Occurs when a inner <see cref="T:WebSocketSharp.WebSocket" /> gets an error.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnMessage">
<MemberSignature Language="C#" Value="protected virtual void OnMessage (object sender, WebSocketSharp.MessageEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnMessage(object sender, class WebSocketSharp.MessageEventArgs e) cil managed" />
<MemberSignature Language="C#" Value="protected virtual void OnMessage (WebSocketSharp.MessageEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnMessage(class WebSocketSharp.MessageEventArgs e) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="WebSocketSharp.MessageEventArgs" />
</Parameters>
<Docs>
<param name="sender">To be added.</param>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<param name="e">
A <see cref="T:WebSocketSharp.MessageEventArgs" /> that contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnMessage" /> event.
</param>
<summary>
Occurs when a inner <see cref="T:WebSocketSharp.WebSocket" /> receives a data frame.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnOpen">
<MemberSignature Language="C#" Value="protected virtual void OnOpen (object sender, EventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnOpen(object sender, class System.EventArgs e) cil managed" />
<MemberSignature Language="C#" Value="protected virtual void OnOpen ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnOpen() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="System.EventArgs" />
</Parameters>
<Parameters />
<Docs>
<param name="sender">To be added.</param>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<summary>
Occurs when the WebSocket connection has been established.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -148,8 +255,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>
Pings to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<returns>
<c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -164,40 +275,15 @@
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PingAround">
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary&lt;string,bool&gt; PingAround ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.Dictionary`2&lt;string, bool&gt; PingAround() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.Generic.Dictionary&lt;System.String,System.Boolean&gt;</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PingAround">
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary&lt;string,bool&gt; PingAround (string message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.Dictionary`2&lt;string, bool&gt; PingAround(string message) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.Generic.Dictionary&lt;System.String,System.Boolean&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="message">
A <see cref="T:System.String" /> that contains a message.
</param>
<summary>
Pings with the specified <see cref="T:System.String" /> to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<returns>
<c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -212,9 +298,15 @@
<Parameter Name="id" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="id">
A <see cref="T:System.String" /> that contains a ID that represents the destination for the Ping.
</param>
<summary>
Pings to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance associated with the specified ID.
</summary>
<returns>
<c>true</c> if the WebSocket service receives a Pong in a time; otherwise, <c>false</c>.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -230,42 +322,19 @@
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Publish">
<MemberSignature Language="C#" Value="public void Publish (byte[] data);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Publish(unsigned int8[] data) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Publish">
<MemberSignature Language="C#" Value="public void Publish (string data);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Publish(string data) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<param name="id">
A <see cref="T:System.String" /> that contains a ID that represents the destination for the Ping.
</param>
<param name="message">
A <see cref="T:System.String" /> that contains a message.
</param>
<summary>
Pings with the specified <see cref="T:System.String" /> to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance
associated with the specified ID.
</summary>
<returns>
<c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -277,8 +346,12 @@
<ReturnType>System.Collections.Specialized.NameValueCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>
Gets the HTTP query string variables used in the WebSocket opening handshake.
</summary>
<value>
A <see cref="T:System.Collections.Specialized.NameValueCollection" /> that contains the query string variables.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -293,8 +366,12 @@
<Parameter Name="data" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<param name="data">
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
</param>
<summary>
Sends a binary data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -309,8 +386,12 @@
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<param name="data">
A <see cref="T:System.String" /> that contains a text data to send.
</param>
<summary>
Sends a text data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -326,9 +407,15 @@
<Parameter Name="data" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<param name="id">
A <see cref="T:System.String" /> that contains a ID that represents the destination for the data.
</param>
<param name="data">
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
</param>
<summary>
Sends a binary data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance associated with the specified ID.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -344,9 +431,15 @@
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<param name="id">
A <see cref="T:System.String" /> that contains a ID that represents the destination for the data.
</param>
<param name="data">
A <see cref="T:System.String" /> that contains a text data to send.
</param>
<summary>
Sends a text data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance associated with the specified ID.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -358,8 +451,12 @@
<ReturnType>WebSocketSharp.Server.SessionManager</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>
Gets the sessions to the WebSocket service.
</summary>
<value>
A <see cref="T:WebSocketSharp.Server.SessionManager" /> that contains the sessions to the WebSocket service.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -372,7 +469,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>
Starts a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -385,7 +484,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>
Stops a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -401,9 +502,15 @@
<Parameter Name="reason" Type="System.String" />
</Parameters>
<Docs>
<param name="code">To be added.</param>
<param name="reason">To be added.</param>
<summary>To be added.</summary>
<param name="code">
A <see cref="T:System.UInt16" /> that contains a status code indicating the reason for stop.
</param>
<param name="reason">
A <see cref="T:System.String" /> that contains a reason for stop.
</param>
<summary>
Stops a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance with the specified <see cref="T:System.UInt16" /> and <see cref="T:System.String" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -419,9 +526,15 @@
<Parameter Name="reason" Type="System.String" />
</Parameters>
<Docs>
<param name="code">To be added.</param>
<param name="reason">To be added.</param>
<summary>To be added.</summary>
<param name="code">
One of the <see cref="T:WebSocketSharp.CloseStatusCode" /> values that contains a status code indicating the reason for stop.
</param>
<param name="reason">
A <see cref="T:System.String" /> that contains a reason for stop.
</param>
<summary>
Stops a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance with the specified <see cref="T:WebSocketSharp.CloseStatusCode" /> and <see cref="T:System.String" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>

25
websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServiceHost`1.xml
View File

@@ -28,7 +28,7 @@
Provides the functions of the server that receives the WebSocket connection requests.
</summary>
<remarks>
The WebSocketServiceHost&lt;T&gt; class provides single WebSocket service.
The WebSocketServiceHost&lt;T&gt; class provides the single WebSocket service.
</remarks>
</Docs>
<Members>
@@ -149,7 +149,7 @@
</Parameters>
<Docs>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains an IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
@@ -176,7 +176,7 @@
</Parameters>
<Docs>
<param name="address">
An <see cref="T:System.Net.IPAddress" /> that contains an IP address.
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
</param>
<param name="port">
An <see cref="T:System.Int32" /> that contains a port number.
@@ -195,21 +195,21 @@
</Docs>
</Member>
<Member MemberName="AcceptWebSocket">
<MemberSignature Language="C#" Value="protected override void AcceptWebSocket (System.Net.Sockets.TcpClient client);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void AcceptWebSocket(class System.Net.Sockets.TcpClient client) cil managed" />
<MemberSignature Language="C#" Value="protected override void AcceptWebSocket (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void AcceptWebSocket(class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="System.Net.Sockets.TcpClient" />
<Parameter Name="context" Type="WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" />
</Parameters>
<Docs>
<param name="client">
A <see cref="T:System.Net.Sockets.TcpClient" /> that contains the TCP connection.
<param name="context">
A <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" /> that contains a WebSocket connection.
</param>
<summary>
Accepts the WebSocket connection.
Accepts a WebSocket connection.
</summary>
<remarks>To be added.</remarks>
</Docs>
@@ -229,7 +229,7 @@
A <see cref="T:System.String" /> to broadcast.
</param>
<summary>
Broadcasts the specified <see cref="T:System.String" />.
Broadcasts the specified <see cref="T:System.String" /> to all clients.
</summary>
<remarks>To be added.</remarks>
</Docs>
@@ -251,7 +251,10 @@
<summary>
Pings with the specified <see cref="T:System.String" /> to all clients.
</summary>
<returns>To be added.</returns>
<returns>
A Dictionary&lt;string, bool&gt; that contains the collection of the session ID and value
indicating whether the server received a Pong in a time.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>

45
websocket-sharp/doc/mdoc/WebSocketSharp/Ext.xml
View File

@@ -16,32 +16,63 @@
</Docs>
<Members>
<Member MemberName="AcceptWebSocket">
<MemberSignature Language="C#" Value="public static WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext AcceptWebSocket (this System.Net.Sockets.TcpClient client, bool secure);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext AcceptWebSocket(class System.Net.Sockets.TcpClient client, bool secure) cil managed" />
<MemberSignature Language="C#" Value="public static WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext AcceptWebSocket (this System.Net.Sockets.TcpListener listener, bool secure);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext AcceptWebSocket(class System.Net.Sockets.TcpListener listener, bool secure) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="System.Net.Sockets.TcpClient" RefType="this" />
<Parameter Name="listener" Type="System.Net.Sockets.TcpListener" RefType="this" />
<Parameter Name="secure" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="client">
A <see cref="T:System.Net.Sockets.TcpClient" /> that contains a TCP connection to accept a WebSocket connection from.
<param name="listener">
A <see cref="T:System.Net.Sockets.TcpListener" /> that provides a TCP connection to accept a WebSocket connection.
</param>
<param name="secure">
A <see cref="T:System.Boolean" /> that indicates a secure connection or not. (<c>true</c> indicates a secure connection.)
</param>
<summary>
Accept a WebSocket connection by the <see cref="T:System.Net.Sockets.TcpListener" />.
Accepts a WebSocket connection by the <see cref="T:System.Net.Sockets.TcpListener" />.
</summary>
<returns>
A <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" /> that contains a WebSocket connection.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Is thrown when the <paramref name="client" /> parameter passed to a method is invalid because it is <see langword="null" />.
<paramref name="listener" /> is <see langword="null" />.
</exception>
</Docs>
</Member>
<Member MemberName="AcceptWebSocketAsync">
<MemberSignature Language="C#" Value="public static void AcceptWebSocketAsync (this System.Net.Sockets.TcpListener listener, bool secure, Action&lt;WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext&gt; completed);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void AcceptWebSocketAsync(class System.Net.Sockets.TcpListener listener, bool secure, class System.Action`1&lt;class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext&gt; completed) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="listener" Type="System.Net.Sockets.TcpListener" RefType="this" />
<Parameter Name="secure" Type="System.Boolean" />
<Parameter Name="completed" Type="System.Action&lt;WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext&gt;" />
</Parameters>
<Docs>
<param name="listener">
A <see cref="T:System.Net.Sockets.TcpListener" /> that provides a TCP connection to accept a WebSocket connection.
</param>
<param name="secure">
A <see cref="T:System.Boolean" /> that indicates a secure connection or not. (<c>true</c> indicates a secure connection.)
</param>
<param name="completed">
An Action&lt;TcpListenerWebSocketContext&gt; delegate that contains the method(s) that is called when an asynchronous operation completes.
</param>
<summary>
Accepts a WebSocket connection asynchronously by the <see cref="T:System.Net.Sockets.TcpListener" />.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="listener" /> is <see langword="null" />.
</exception>
</Docs>
</Member>

16
websocket-sharp/doc/mdoc/WebSocketSharp/WebSocket.xml
View File

@@ -150,7 +150,7 @@
</Parameters>
<Docs>
<param name="code">
A <see cref="!:WebSocketSharp.Frame.CloseStatusCode" /> that contains a status code indicating a reason for closure.
A <see cref="T:WebSocketSharp.CloseStatusCode" /> that contains a status code indicating a reason for closure.
</param>
<summary>
Closes the connection and releases all associated resources after sends a Close control frame.
@@ -195,7 +195,7 @@
</Parameters>
<Docs>
<param name="code">
A <see cref="!:WebSocketSharp.Frame.CloseStatusCode" /> that contains a status code indicating a reason for closure.
A <see cref="T:WebSocketSharp.CloseStatusCode" /> that contains a status code indicating a reason for closure.
</param>
<param name="reason">
A <see cref="T:System.String" /> that contains a reason for closure.
@@ -435,7 +435,7 @@
</Parameters>
<Docs>
<param name="data">
An array of <see cref="T:System.Byte" /> that contains the binary data to be sent.
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
</param>
<summary>
Sends a binary data using the connection.
@@ -455,7 +455,7 @@
</Parameters>
<Docs>
<param name="file">
A <see cref="T:System.IO.FileInfo" /> that contains the binary data to be sent.
A <see cref="T:System.IO.FileInfo" /> that contains a binary data to send.
</param>
<summary>
Sends a binary data using the connection.
@@ -475,7 +475,7 @@
</Parameters>
<Docs>
<param name="data">
A <see cref="T:System.String" /> that contains the text data to be sent.
A <see cref="T:System.String" /> that contains a text data to send.
</param>
<summary>
Sends a text data using the connection.
@@ -496,7 +496,7 @@
</Parameters>
<Docs>
<param name="data">
An array of <see cref="T:System.Byte" /> that contains the binary data to be sent.
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
</param>
<param name="completed">
An <see cref="T:System.Action" /> delegate that contains the method(s) that is called when an asynchronous operation completes.
@@ -520,7 +520,7 @@
</Parameters>
<Docs>
<param name="file">
A <see cref="T:System.IO.FileInfo" /> that contains the binary data to be sent.
A <see cref="T:System.IO.FileInfo" /> that contains a binary data to send.
</param>
<param name="completed">
An <see cref="T:System.Action" /> delegate that contains the method(s) that is called when an asynchronous operation completes.
@@ -544,7 +544,7 @@
</Parameters>
<Docs>
<param name="data">
A <see cref="T:System.String" /> that contains the text data to be sent.
A <see cref="T:System.String" /> that contains a text data to send.
</param>
<param name="completed">
An <see cref="T:System.Action" /> delegate that contains the method(s) that is called when an asynchronous operation completes.

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

@@ -1,6 +1,6 @@
<Overview>
<Assemblies>
<Assembly Name="websocket-sharp" Version="1.0.2.30559">
<Assembly Name="websocket-sharp" Version="1.0.2.28541">
<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>
@@ -82,31 +82,64 @@
<ExtensionMethods>
<ExtensionMethod>
<Targets>
<Target Type="T:System.Net.Sockets.TcpClient" />
<Target Type="T:System.Net.Sockets.TcpListener" />
</Targets>
<Member MemberName="AcceptWebSocket">
<MemberSignature Language="C#" Value="public static WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext AcceptWebSocket (this System.Net.Sockets.TcpClient client, bool secure);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext AcceptWebSocket(class System.Net.Sockets.TcpClient client, bool secure) cil managed" />
<MemberSignature Language="C#" Value="public static WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext AcceptWebSocket (this System.Net.Sockets.TcpListener listener, bool secure);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext AcceptWebSocket(class System.Net.Sockets.TcpListener listener, bool secure) cil managed" />
<MemberType>ExtensionMethod</MemberType>
<ReturnValue>
<ReturnType>WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="System.Net.Sockets.TcpClient" RefType="this" />
<Parameter Name="listener" Type="System.Net.Sockets.TcpListener" RefType="this" />
<Parameter Name="secure" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="client">
A <see cref="T:System.Net.Sockets.TcpClient" /> that contains a TCP connection to accept a WebSocket connection from.
<param name="listener">
A <see cref="T:System.Net.Sockets.TcpListener" /> that provides a TCP connection to accept a WebSocket connection.
</param>
<param name="secure">
A <see cref="T:System.Boolean" /> that indicates a secure connection or not. (<c>true</c> indicates a secure connection.)
</param>
<summary>
Accept a WebSocket connection by the <see cref="T:System.Net.Sockets.TcpListener" />.
Accepts a WebSocket connection by the <see cref="T:System.Net.Sockets.TcpListener" />.
</summary>
</Docs>
<Link Type="WebSocketSharp.Ext" Member="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpClient,System.Boolean)" />
<Link Type="WebSocketSharp.Ext" Member="M:WebSocketSharp.Ext.AcceptWebSocket(System.Net.Sockets.TcpListener,System.Boolean)" />
</Member>
</ExtensionMethod>
<ExtensionMethod>
<Targets>
<Target Type="T:System.Net.Sockets.TcpListener" />
</Targets>
<Member MemberName="AcceptWebSocketAsync">
<MemberSignature Language="C#" Value="public static void AcceptWebSocketAsync (this System.Net.Sockets.TcpListener listener, bool secure, Action&lt;WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext&gt; completed);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void AcceptWebSocketAsync(class System.Net.Sockets.TcpListener listener, bool secure, class System.Action`1&lt;class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext&gt; completed) cil managed" />
<MemberType>ExtensionMethod</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="listener" Type="System.Net.Sockets.TcpListener" RefType="this" />
<Parameter Name="secure" Type="System.Boolean" />
<Parameter Name="completed" Type="System.Action&lt;WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext&gt;" />
</Parameters>
<Docs>
<param name="listener">
A <see cref="T:System.Net.Sockets.TcpListener" /> that provides a TCP connection to accept a WebSocket connection.
</param>
<param name="secure">
A <see cref="T:System.Boolean" /> that indicates a secure connection or not. (<c>true</c> indicates a secure connection.)
</param>
<param name="completed">
An Action&lt;TcpListenerWebSocketContext&gt; delegate that contains the method(s) that is called when an asynchronous operation completes.
</param>
<summary>
Accepts a WebSocket connection asynchronously by the <see cref="T:System.Net.Sockets.TcpListener" />.
</summary>
</Docs>
<Link Type="WebSocketSharp.Ext" Member="M:WebSocketSharp.Ext.AcceptWebSocketAsync(System.Net.Sockets.TcpListener,System.Boolean,System.Action{WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext})" />
</Member>
</ExtensionMethod>
<ExtensionMethod>

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

Binary file not shown.