#region License
/*
* WebSocketServiceHost.cs
*
* A C# implementation of the WebSocket protocol server.
*
* The MIT License
*
* Copyright (c) 2012-2013 sta.blockhead
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#endregion
using System;
using System.Collections.Generic;
using System.Net.Sockets;
using System.Text;
using WebSocketSharp.Net;
using WebSocketSharp.Net.WebSockets;
namespace WebSocketSharp.Server
{
///
/// Provides the functions of the server that receives the WebSocket connection requests.
///
///
/// The WebSocketServiceHost<T> class provides the single WebSocket service.
///
///
/// The type of the WebSocket service that the server provides.
/// The T must inherit the class.
///
public class WebSocketServiceHost : WebSocketServerBase, IServiceHost
where T : WebSocketService, new ()
{
#region Private Fields
private WebSocketServiceManager _sessions;
#endregion
#region Internal Constructors
internal WebSocketServiceHost (Logger logger)
: base (logger)
{
_sessions = new WebSocketServiceManager (logger);
}
#endregion
#region Public Constructors
///
/// Initializes a new instance of the WebSocketServiceHost<T> class that listens for
/// incoming connection attempts on the specified .
///
///
/// An that contains a port number.
///
public WebSocketServiceHost (int port)
: this (port, "/")
{
}
///
/// Initializes a new instance of the WebSocketServiceHost<T> class that listens for
/// incoming connection attempts on the specified WebSocket URL.
///
///
/// A that contains a WebSocket URL.
///
public WebSocketServiceHost (string url)
: base (url)
{
_sessions = new WebSocketServiceManager (Log);
}
///
/// Initializes a new instance of the WebSocketServiceHost<T> class that listens for
/// incoming connection attempts on the specified and .
///
///
/// An that contains a port number.
///
///
/// A that indicates providing a secure connection or not.
/// (true indicates providing a secure connection.)
///
public WebSocketServiceHost (int port, bool secure)
: this (port, "/", secure)
{
}
///
/// Initializes a new instance of the WebSocketServiceHost<T> class that listens for
/// incoming connection attempts on the specified and .
///
///
/// An that contains a port number.
///
///
/// A that contains an absolute path.
///
public WebSocketServiceHost (int port, string absPath)
: this (System.Net.IPAddress.Any, port, absPath)
{
}
///
/// Initializes a new instance of the WebSocketServiceHost<T> class that listens for
/// incoming connection attempts on the specified ,
/// and .
///
///
/// An that contains a port number.
///
///
/// A that contains an absolute path.
///
///
/// A that indicates providing a secure connection or not.
/// (true indicates providing a secure connection.)
///
public WebSocketServiceHost (int port, string absPath, bool secure)
: this (System.Net.IPAddress.Any, port, absPath, secure)
{
}
///
/// Initializes a new instance of the WebSocketServiceHost<T> class that listens for
/// incoming connection attempts on the specified ,
/// and .
///
///
/// A that contains a local IP address.
///
///
/// An that contains a port number.
///
///
/// A that contains an absolute path.
///
public WebSocketServiceHost (System.Net.IPAddress address, int port, string absPath)
: this (address, port, absPath, port == 443 ? true : false)
{
}
///
/// Initializes a new instance of the WebSocketServiceHost<T> class that listens for
/// incoming connection attempts on the specified , ,
/// and .
///
///
/// A that contains a local IP address.
///
///
/// An that contains a port number.
///
///
/// A that contains an absolute path.
///
///
/// A that indicates providing a secure connection or not.
/// (true indicates providing a secure connection.)
///
public WebSocketServiceHost (System.Net.IPAddress address, int port, string absPath, bool secure)
: base (address, port, absPath, secure)
{
_sessions = new WebSocketServiceManager (Log);
}
#endregion
#region Public Properties
///
/// Gets the connection count to the WebSocket service host.
///
///
/// An that contains the connection count.
///
public int ConnectionCount {
get {
return _sessions.Count;
}
}
///
/// Gets or sets a value indicating whether the WebSocket service host cleans up
/// the inactive instances periodically.
///
///
/// true if the WebSocket service host cleans up the inactive WebSocket service instances every 60 seconds;
/// otherwise, false. The default value is true.
///
public bool KeepClean {
get {
return _sessions.KeepClean;
}
set {
_sessions.KeepClean = value;
}
}
///
/// Gets the WebSocket URL on which to listen for incoming connection attempts.
///
///
/// A that contains a WebSocket URL.
///
public Uri Uri {
get {
return BaseUri;
}
internal set {
BaseUri = value;
}
}
#endregion
#region Private Methods
private void stop (ushort code, string reason)
{
var data = code.Append (reason);
if (data.Length > 125)
{
Log.Error (String.Format (
"The payload length of a Close frame must be 125 bytes or less.\ncode: {0}\nreason: {1}", code, reason));
return;
}
base.Stop ();
_sessions.Stop (code, reason);
}
#endregion
#region Protected Methods
///
/// Accepts a WebSocket connection request.
///
///
/// A that contains the WebSocket connection request objects.
///
protected override void AcceptWebSocket (TcpListenerWebSocketContext context)
{
var ws = context.WebSocket;
var path = context.Path.UrlDecode ();
ws.Log = Log;
if (path != Uri.GetAbsolutePath ().UrlDecode ())
{
ws.Close (HttpStatusCode.NotImplemented);
return;
}
if (Uri.IsAbsoluteUri)
ws.Url = Uri;
((IServiceHost) this).BindWebSocket (context);
}
#endregion
#region Public Methods
///
/// Broadcasts the specified array of to all clients.
///
///
/// An array of to broadcast.
///
public void Broadcast (byte [] data)
{
if (data == null)
{
Log.Error ("'data' must not be null.");
return;
}
_sessions.Broadcast (data);
}
///
/// Broadcasts the specified to all clients.
///
///
/// A to broadcast.
///
public void Broadcast (string data)
{
if (data == null)
{
Log.Error ("'data' must not be null.");
return;
}
_sessions.Broadcast (data);
}
///
/// Sends Pings with the specified to all clients.
///
///
/// A Dictionary<string, bool> that contains the collection of session IDs and values
/// indicating whether the service host received the Pongs from each clients in a time.
///
///
/// A that contains a message to send.
///
public Dictionary Broadping (string message)
{
if (message.IsNullOrEmpty ())
return _sessions.Broadping (String.Empty);
var len = Encoding.UTF8.GetBytes (message).Length;
if (len > 125)
{
Log.Error ("The payload length of a Ping frame must be 125 bytes or less.");
return null;
}
return _sessions.Broadping (message);
}
///
/// Sends a Ping with the specified to the client associated with
/// the specified ID.
///
///
/// true if the service host receives a Pong from the client in a time; otherwise, false.
///
///
/// A that contains an ID that represents the destination for the Ping.
///
///
/// A that contains a message to send.
///
public bool PingTo (string id, string message)
{
if (message == null)
message = String.Empty;
var msg = 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."
: null;
if (msg != null)
{
Log.Error (msg);
return false;
}
return _sessions.PingTo (id, message);
}
///
/// Sends a binary data to the client associated with the specified ID.
///
///
/// true if the client associated with is successfully found;
/// otherwise, false.
///
///
/// A that contains an ID that represents the destination for the data.
///
///
/// An array of that contains a binary data to send.
///
public bool SendTo (string id, byte [] data)
{
var msg = id.IsNullOrEmpty ()
? "'id' must not be null or empty."
: data == null
? "'data' must not be null."
: null;
if (msg != null)
{
Log.Error (msg);
return false;
}
return _sessions.SendTo (id, data);
}
///
/// Sends a text data to the client associated with the specified ID.
///
///
/// true if the client associated with is successfully found;
/// otherwise, false.
///
///
/// A that contains an ID that represents the destination for the data.
///
///
/// A that contains a text data to send.
///
public bool SendTo (string id, string data)
{
var msg = id.IsNullOrEmpty ()
? "'id' must not be null or empty."
: data == null
? "'data' must not be null."
: null;
if (msg != null)
{
Log.Error (msg);
return false;
}
return _sessions.SendTo (id, data);
}
///
/// Stops receiving the WebSocket connection requests.
///
public override void Stop ()
{
base.Stop ();
_sessions.Stop ();
}
///
/// Stops receiving the WebSocket connection requests with the specified and
/// .
///
///
/// A that contains a status code indicating the reason for stop.
///
///
/// A that contains the reason for stop.
///
public void Stop (ushort code, string reason)
{
if (!code.IsCloseStatusCode ())
{
Log.Error ("Invalid status code for stop.\ncode: " + code);
return;
}
stop (code, reason);
}
///
/// Stops receiving the WebSocket connection requests with the specified
/// and .
///
///
/// A that contains a status code indicating the reason for stop.
///
///
/// A that contains the reason for stop.
///
public void Stop (CloseStatusCode code, string reason)
{
stop ((ushort) code, reason);
}
#endregion
#region Explicit Interface Implementation
///
/// Binds the specified to a instance.
///
///
/// A that contains the WebSocket connection request objects to bind.
///
void IServiceHost.BindWebSocket (WebSocketContext context)
{
T service = new T ();
service.Bind (context, _sessions);
service.Start ();
}
///
/// Broadcasts the specified array of to all clients.
///
///
/// An array of to broadcast.
///
void IServiceHost.Broadcast (byte [] data)
{
_sessions.Broadcast (data);
}
///
/// Broadcasts the specified to all clients.
///
///
/// A to broadcast.
///
void IServiceHost.Broadcast (string data)
{
_sessions.Broadcast (data);
}
///
/// Sends Pings with the specified to all clients.
///
///
/// A Dictionary<string, bool> that contains the collection of session IDs and values
/// indicating whether the service host received the Pongs from each clients in a time.
///
///
/// A that contains a message to send.
///
Dictionary IServiceHost.Broadping (string message)
{
return _sessions.Broadping (message);
}
///
/// Sends a Ping with the specified to the client associated with
/// the specified ID.
///
///
/// true if the service host receives a Pong from the client in a time; otherwise, false.
///
///
/// A that contains an ID that represents the destination for the Ping.
///
///
/// A that contains a message to send.
///
bool IServiceHost.PingTo (string id, string message)
{
return _sessions.PingTo (id, message);
}
///
/// Sends a binary data to the client associated with the specified ID.
///
///
/// true if the client associated with is successfully found;
/// otherwise, false.
///
///
/// A that contains an ID that represents the destination for the data.
///
///
/// An array of that contains a binary data to send.
///
bool IServiceHost.SendTo (string id, byte [] data)
{
return _sessions.SendTo (id, data);
}
///
/// Sends a text data to the client associated with the specified ID.
///
///
/// true if the client associated with is successfully found;
/// otherwise, false.
///
///
/// A that contains an ID that represents the destination for the data.
///
///
/// A that contains a text data to send.
///
bool IServiceHost.SendTo (string id, string data)
{
return _sessions.SendTo (id, data);
}
///
/// Stops receiving the WebSocket connection requests with the specified and
/// .
///
///
/// A that contains a status code indicating the reason for stop.
///
///
/// A that contains the reason for stop.
///
void IServiceHost.Stop (ushort code, string reason)
{
base.Stop ();
_sessions.Stop (code, reason);
}
#endregion
}
}