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

Added some functions (e.g. SendTo method) to WebSocketServiceHost<T> and WebSocketServer classes

Browse Source
This commit is contained in:
sta
2013-08-20 14:53:09 +09:00
parent acde107832
commit 1b270603f4
7 changed files with 1492 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -31,11 +31,12 @@
using System;
using System.Collections.Generic;
using System.Net.Sockets;
using System.Text;
using WebSocketSharp.Net;
using WebSocketSharp.Net.WebSockets;
namespace WebSocketSharp.Server {
namespace WebSocketSharp.Server
{
/// <summary>
/// Provides the functions of the server that receives the WebSocket connection requests.
/// </summary>
@@ -46,7 +47,7 @@ namespace WebSocketSharp.Server {
{
#region Private Fields
private ServiceHostManager _svcHosts;
private ServiceHostManager _serviceHosts;
#endregion
@@ -55,95 +56,107 @@ namespace WebSocketSharp.Server {
/// <summary>
/// Initializes a new instance of the <see cref="WebSocketServer"/> class.
/// </summary>
public WebSocketServer()
: this(80)
public WebSocketServer ()
: this (80)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="WebSocketServer"/> class that listens for incoming connection attempts
/// on the specified <paramref name="port"/>.
/// 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">
/// An <see cref="int"/> that contains a port number.
/// </param>
public WebSocketServer(int port)
: this(System.Net.IPAddress.Any, port)
public WebSocketServer (int port)
: this (System.Net.IPAddress.Any, port)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="WebSocketServer"/> class that listens for incoming connection attempts
/// on the specified WebSocket URL.
/// 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">
/// A <see cref="string"/> that contains a WebSocket URL.
/// </param>
public WebSocketServer(string url)
: base(url)
public WebSocketServer (string url)
: base (url)
{
if (BaseUri.AbsolutePath != "/")
{
var msg = "Must not contain the path component: " + url;
throw new ArgumentException(msg, "url");
}
throw new ArgumentException ("Must not contain the path component: " + url, "url");
_svcHosts = new ServiceHostManager();
_serviceHosts = new ServiceHostManager (Log);
}
/// <summary>
/// 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"/>.
/// 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">
/// An <see cref="int"/> that contains a port number.
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
/// A <see cref="bool"/> that indicates providing a secure connection or not.
/// (<c>true</c> indicates providing a secure connection.)
/// </param>
public WebSocketServer(int port, bool secure)
: this(System.Net.IPAddress.Any, port, secure)
public WebSocketServer (int port, bool secure)
: this (System.Net.IPAddress.Any, port, secure)
{
}
/// <summary>
/// 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"/>.
/// 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">
/// A <see cref="System.Net.IPAddress"/> that contains a local IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// An <see cref="int"/> that contains a port number.
/// </param>
public WebSocketServer(System.Net.IPAddress address, int port)
: this(address, port, port == 443 ? true : false)
public WebSocketServer (System.Net.IPAddress address, int port)
: this (address, port, port == 443 ? true : false)
{
}
/// <summary>
/// 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"/>.
/// 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">
/// A <see cref="System.Net.IPAddress"/> that contains a local IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
/// A <see cref="bool"/> that indicates providing a secure connection or not.
/// (<c>true</c> indicates providing a secure connection.)
/// </param>
public WebSocketServer(System.Net.IPAddress address, int port, bool secure)
: base(address, port, "/", secure)
public WebSocketServer (System.Net.IPAddress address, int port, bool secure)
: base (address, port, "/", secure)
{
_svcHosts = new ServiceHostManager();
_serviceHosts = new ServiceHostManager (Log);
}
#endregion
#region Public Properties
/// <summary>
/// Gets the connection count to the <see cref="WebSocketServer"/>.
/// </summary>
/// <value>
/// An <see cref="int"/> that contains the connection count.
/// </value>
public int ConnectionCount {
get {
return _serviceHosts.ConnectionCount;
}
}
/// <summary>
/// Gets or sets a value indicating whether the server cleans up the inactive WebSocket service
/// instances periodically.
@@ -154,11 +167,11 @@ namespace WebSocketSharp.Server {
/// </value>
public bool KeepClean {
get {
return _svcHosts.KeepClean;
return _serviceHosts.KeepClean;
}
set {
_svcHosts.KeepClean = value;
_serviceHosts.KeepClean = value;
}
}
@@ -171,16 +184,36 @@ namespace WebSocketSharp.Server {
public IEnumerable<string> ServicePaths {
get {
var url = BaseUri.IsAbsoluteUri
? BaseUri.ToString().TrimEnd('/')
? BaseUri.ToString ().TrimEnd ('/')
: String.Empty;
foreach (var path in _svcHosts.Paths)
foreach (var path in _serviceHosts.Paths)
yield return url + path;
}
}
#endregion
#region Private Methods
private void stop (ushort code, string reason)
{
var data = code.Append (reason);
if (data.Length > 125)
{
var msg = "The payload length of a Close frame must be 125 bytes or less.";
Log.Error (String.Format ("{0}\ncode: {1}\nreason: {2}", msg, code, reason));
Error (msg);
return;
}
base.Stop ();
_serviceHosts.Stop (code, reason);
}
#endregion
#region Protected Methods
/// <summary>
@@ -189,23 +222,23 @@ namespace WebSocketSharp.Server {
/// <param name="context">
/// A <see cref="TcpListenerWebSocketContext"/> that contains the WebSocket connection request objects.
/// </param>
protected override void AcceptWebSocket(TcpListenerWebSocketContext context)
protected override void AcceptWebSocket (TcpListenerWebSocketContext context)
{
var ws = context.WebSocket;
var path = context.Path.UrlDecode();
var path = context.Path.UrlDecode ();
ws.Log = Log;
IServiceHost svcHost;
if (!_svcHosts.TryGetServiceHost(path, out svcHost))
IServiceHost host;
if (!_serviceHosts.TryGetServiceHost (path, out host))
{
ws.Close(HttpStatusCode.NotImplemented);
ws.Close (HttpStatusCode.NotImplemented);
return;
}
if (BaseUri.IsAbsoluteUri)
ws.Url = new Uri(BaseUri, path);
ws.Url = new Uri (BaseUri, path);
svcHost.BindWebSocket(context);
host.BindWebSocket (context);
}
#endregion
@@ -213,35 +246,55 @@ namespace WebSocketSharp.Server {
#region Public Methods
/// <summary>
/// Adds the specified type WebSocket service.
/// Adds the specified typed WebSocket service.
/// </summary>
/// <param name="absPath">
/// A <see cref="string"/> that contains an absolute path associated with the WebSocket service.
/// <param name="servicePath">
/// A <see cref="string"/> that contains an absolute path to the WebSocket service.
/// </param>
/// <typeparam name="T">
/// The type of the WebSocket service. The T must inherit the <see cref="WebSocketService"/> class.
/// </typeparam>
public void AddWebSocketService<T>(string absPath)
where T : WebSocketService, new()
public void AddWebSocketService<T> (string servicePath)
where T : WebSocketService, new ()
{
string msg;
if (!absPath.IsValidAbsolutePath(out msg))
if (!servicePath.IsValidAbsolutePath (out msg))
{
Log.Error(msg);
Error(msg);
Log.Error (msg);
Error (msg);
return;
}
var svcHost = new WebSocketServiceHost<T>(Log);
svcHost.Uri = BaseUri.IsAbsoluteUri
? new Uri(BaseUri, absPath)
: absPath.ToUri();
var host = new WebSocketServiceHost<T> (Log);
host.Uri = BaseUri.IsAbsoluteUri
? new Uri (BaseUri, servicePath)
: servicePath.ToUri ();
if (!KeepClean)
svcHost.KeepClean = false;
host.KeepClean = false;
_svcHosts.Add(absPath, svcHost);
_serviceHosts.Add (servicePath, host);
}
/// <summary>
/// Broadcasts the specified array of <see cref="byte"/> to all clients.
/// </summary>
/// <param name="data">
/// An array of <see cref="byte"/> to broadcast.
/// </param>
public void Broadcast (byte [] data)
{
if (data == null)
{
var msg = "'data' must not be null.";
Log.Error (msg);
Error (msg);
return;
}
_serviceHosts.Broadcast (data);
}
/// <summary>
@@ -250,18 +303,358 @@ namespace WebSocketSharp.Server {
/// <param name="data">
/// A <see cref="string"/> to broadcast.
/// </param>
public void Broadcast(string data)
public void Broadcast (string data)
{
_svcHosts.Broadcast(data);
if (data == null)
{
var msg = "'data' must not be null.";
Log.Error (msg);
Error (msg);
return;
}
_serviceHosts.Broadcast (data);
}
/// <summary>
/// Broadcasts the specified array of <see cref="byte"/> to all clients of the WebSocket service
/// with the specified <paramref name="servicePath"/>.
/// </summary>
/// <returns>
/// <c>true</c> if the WebSocket service is found; otherwise, <c>false</c>.
/// </returns>
/// <param name="servicePath">
/// A <see cref="string"/> that contains an absolute path to the WebSocket service to find.
/// </param>
/// <param name="data">
/// An array of <see cref="byte"/> to broadcast.
/// </param>
public bool BroadcastTo (string servicePath, byte [] data)
{
var msg = servicePath.IsNullOrEmpty ()
? "'servicePath' must not be null or empty."
: data == null
? "'data' must not be null."
: String.Empty;
if (msg.Length > 0)
{
Log.Error (msg);
Error (msg);
return false;
}
return _serviceHosts.BroadcastTo (servicePath, data);
}
/// <summary>
/// Broadcasts the specified <see cref="string"/> to all clients of the WebSocket service
/// with the specified <paramref name="servicePath"/>.
/// </summary>
/// <returns>
/// <c>true</c> if the WebSocket service is found; otherwise, <c>false</c>.
/// </returns>
/// <param name="servicePath">
/// A <see cref="string"/> that contains an absolute path to the WebSocket service to find.
/// </param>
/// <param name="data">
/// A <see cref="string"/> to broadcast.
/// </param>
public bool BroadcastTo (string servicePath, string data)
{
var msg = servicePath.IsNullOrEmpty ()
? "'servicePath' must not be null or empty."
: data == null
? "'data' must not be null."
: String.Empty;
if (msg.Length > 0)
{
Log.Error (msg);
Error (msg);
return false;
}
return _serviceHosts.BroadcastTo (servicePath, data);
}
/// <summary>
/// Sends Pings with the specified <see cref="string"/> to all clients.
/// </summary>
/// <returns>
/// A Dictionary&lt;string, Dictionary&lt;string, bool&gt;&gt; that contains the collection of
/// service paths and pairs of ID and value indicating whether the <see cref="WebSocketServer"/>
/// received the Pongs from each clients in a time.
/// </returns>
/// <param name="message">
/// A <see cref="string"/> that contains a message to send.
/// </param>
public Dictionary<string, Dictionary<string, bool>> Broadping (string message)
{
if (message.IsNullOrEmpty ())
return _serviceHosts.Broadping (String.Empty);
var len = Encoding.UTF8.GetBytes (message).Length;
if (len > 125)
{
var msg = "The payload length of a Ping frame must be 125 bytes or less.";
Log.Error (msg);
Error (msg);
return null;
}
return _serviceHosts.Broadping (message);
}
/// <summary>
/// Sends Pings with the specified <see cref="string"/> to all clients of the WebSocket service
/// with the specified <paramref name="servicePath"/>.
/// </summary>
/// <returns>
/// A Dictionary&lt;string, bool&gt; that contains the collection of session IDs and values
/// indicating whether the <see cref="WebSocketServer"/> received the Pongs from each clients
/// in a time. If the WebSocket service is not found, returns <see langword="null"/>.
/// </returns>
/// <param name="servicePath">
/// A <see cref="string"/> that contains an absolute path to the WebSocket service to find.
/// </param>
/// <param name="message">
/// A <see cref="string"/> that contains a message to send.
/// </param>
public Dictionary<string, bool> BroadpingTo (string servicePath, string message)
{
if (message == null)
message = String.Empty;
var msg = servicePath.IsNullOrEmpty ()
? "'servicePath' must not be null or empty."
: Encoding.UTF8.GetBytes (message).Length > 125
? "The payload length of a Ping frame must be 125 bytes or less."
: String.Empty;
if (msg.Length > 0)
{
Log.Error (msg);
Error (msg);
return null;
}
return _serviceHosts.BroadpingTo (servicePath, message);
}
/// <summary>
/// Gets the connection count to the WebSocket service with the specified <paramref name="servicePath"/>.
/// </summary>
/// <returns>
/// An <see cref="int"/> that contains the connection count if the WebSocket service is successfully found;
/// otherwise, <c>-1</c>.
/// </returns>
/// <param name="servicePath">
/// A <see cref="string"/> that contains an absolute path to the WebSocket service to find.
/// </param>
public int GetConnectionCount (string servicePath)
{
if (servicePath.IsNullOrEmpty ())
{
var msg = "'servicePath' must not be null or empty.";
Log.Error (msg);
Error (msg);
return -1;
}
return _serviceHosts.GetConnectionCount (servicePath);
}
/// <summary>
/// Sends a Ping with the specified <see cref="string"/> to the client associated with
/// the specified <paramref name="servicePath"/> and <paramref name="id"/>.
/// </summary>
/// <returns>
/// <c>true</c> if the <see cref="WebSocketServer"/> receives a Pong from the client in a time;
/// otherwise, <c>false</c>.
/// </returns>
/// <param name="servicePath">
/// A <see cref="string"/> that contains an absolute path to the WebSocket service to find.
/// </param>
/// <param name="id">
/// A <see cref="string"/> that contains an ID that represents the destination for the Ping.
/// </param>
/// <param name="message">
/// A <see cref="string"/> that contains a message to send.
/// </param>
public bool PingTo (string servicePath, string id, string message)
{
if (message == null)
message = String.Empty;
var msg = servicePath.IsNullOrEmpty ()
? "'servicePath' must not be null or empty."
: id.IsNullOrEmpty ()
? "'id' must not be null or empty."
: Encoding.UTF8.GetBytes (message).Length > 125
? "The payload length of a Ping frame must be 125 bytes or less."
: String.Empty;
if (msg.Length > 0)
{
Log.Error (msg);
Error (msg);
return false;
}
return _serviceHosts.PingTo (servicePath, id, message);
}
/// <summary>
/// Removes the WebSocket service with the specified <paramref name="servicePath"/>.
/// </summary>
/// <returns>
/// <c>true</c> if the WebSocket service is successfully found and removed; otherwise, <c>false</c>.
/// </returns>
/// <param name="servicePath">
/// A <see cref="string"/> that contains an absolute path to the WebSocket service to find.
/// </param>
public bool RemoveWebSocketService (string servicePath)
{
if (servicePath.IsNullOrEmpty ())
{
var msg = "'servicePath' must not be null or empty.";
Log.Error (msg);
Error (msg);
return false;
}
return _serviceHosts.Remove (servicePath);
}
/// <summary>
/// Sends a binary data to the client associated with the specified <paramref name="servicePath"/> and
/// <paramref name="id"/>.
/// </summary>
/// <returns>
/// <c>true</c> if the client is successfully found; otherwise, <c>false</c>.
/// </returns>
/// <param name="servicePath">
/// A <see cref="string"/> that contains an absolute path to the WebSocket service to find.
/// </param>
/// <param name="id">
/// A <see cref="string"/> that contains an 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 bool SendTo (string servicePath, string id, byte [] data)
{
var msg = servicePath.IsNullOrEmpty ()
? "'servicePath' must not be null or empty."
: id.IsNullOrEmpty ()
? "'id' must not be null or empty."
: data == null
? "'data' must not be null."
: String.Empty;
if (msg.Length > 0)
{
Log.Error (msg);
Error (msg);
return false;
}
return _serviceHosts.SendTo (servicePath, id, data);
}
/// <summary>
/// Sends a text data to the client associated with the specified <paramref name="servicePath"/> and
/// <paramref name="id"/>.
/// </summary>
/// <returns>
/// <c>true</c> if the client is successfully found; otherwise, <c>false</c>.
/// </returns>
/// <param name="servicePath">
/// A <see cref="string"/> that contains an absolute path to the WebSocket service to find.
/// </param>
/// <param name="id">
/// A <see cref="string"/> that contains an 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 bool SendTo (string servicePath, string id, string data)
{
var msg = servicePath.IsNullOrEmpty ()
? "'servicePath' must not be null or empty."
: id.IsNullOrEmpty ()
? "'id' must not be null or empty."
: data == null
? "'data' must not be null."
: String.Empty;
if (msg.Length > 0)
{
Log.Error (msg);
Error (msg);
return false;
}
return _serviceHosts.SendTo (servicePath, id, data);
}
/// <summary>
/// Stops receiving the WebSocket connection requests.
/// </summary>
public override void Stop()
public override void Stop ()
{
base.Stop();
_svcHosts.Stop();
base.Stop ();
_serviceHosts.Stop ();
}
/// <summary>
/// Stops receiving the WebSocket connection requests 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 the reason for stop.
/// </param>
public void Stop (ushort code, string reason)
{
if (!code.IsCloseStatusCode ())
{
var msg = "Invalid status code for stop.";
Log.Error (String.Format ("{0}\ncode: {1}", msg, code));
Error (msg);
return;
}
stop (code, reason);
}
/// <summary>
/// Stops receiving the WebSocket connection requests with the specified <see cref="CloseStatusCode"/>
/// and <see cref="string"/>.
/// </summary>
/// <param name="code">
/// A <see cref="CloseStatusCode"/> that contains a status code indicating the reason for stop.
/// </param>
/// <param name="reason">
/// A <see cref="string"/> that contains the reason for stop.
/// </param>
public void Stop (CloseStatusCode code, string reason)
{
stop ((ushort) code, reason);
}
#endregion