#region License
/*
* WebSocketServer.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 WebSocketServer class provides the multi WebSocket service.
///
public class WebSocketServer : WebSocketServerBase
{
#region Private Fields
private WebSocketServiceHostManager _serviceHosts;
#endregion
#region Public Constructors
///
/// Initializes a new instance of the class.
///
public WebSocketServer ()
: this (80)
{
}
///
/// Initializes a new instance of the class that listens for
/// incoming connection attempts on the specified .
///
///
/// An that contains a port number.
///
public WebSocketServer (int port)
: this (System.Net.IPAddress.Any, port)
{
}
///
/// Initializes a new instance of the class that listens for
/// incoming connection attempts on the specified WebSocket URL.
///
///
/// A that contains a WebSocket URL.
///
public WebSocketServer (string url)
: base (url)
{
if (BaseUri.AbsolutePath != "/")
throw new ArgumentException ("Must not contain the path component: " + url, "url");
_serviceHosts = new WebSocketServiceHostManager (Log);
}
///
/// Initializes a new instance of the 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 WebSocketServer (int port, bool secure)
: this (System.Net.IPAddress.Any, port, secure)
{
}
///
/// Initializes a new instance of the class that listens for
/// incoming connection attempts on the specified and .
///
///
/// A that contains a local IP address.
///
///
/// An that contains a port number.
///
public WebSocketServer (System.Net.IPAddress address, int port)
: this (address, port, port == 443 ? true : false)
{
}
///
/// Initializes a new instance of the 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 indicates providing a secure connection or not.
/// (true indicates providing a secure connection.)
///
public WebSocketServer (System.Net.IPAddress address, int port, bool secure)
: base (address, port, "/", secure)
{
_serviceHosts = new WebSocketServiceHostManager (Log);
}
#endregion
#region Public Properties
///
/// Gets or sets a value indicating whether the server cleans up the inactive WebSocket service
/// instances periodically.
///
///
/// true if the server cleans up the inactive WebSocket service instances every 60 seconds;
/// otherwise, false. The default value is true.
///
public bool KeepClean {
get {
return _serviceHosts.KeepClean;
}
set {
_serviceHosts.KeepClean = value;
}
}
///
/// Gets the collection of paths to the WebSocket services that the server provides.
///
///
/// An IEnumerable<string> that contains the collection of paths.
///
public IEnumerable ServicePaths {
get {
var url = BaseUri.IsAbsoluteUri
? BaseUri.ToString ().TrimEnd ('/')
: String.Empty;
foreach (var path in _serviceHosts.ServicePaths)
yield return url + path;
}
}
///
/// Gets the functions for the WebSocket services that the server provides.
///
///
/// A that manages the WebSocket services.
///
public WebSocketServiceHostManager WebSocketServices {
get {
return _serviceHosts;
}
}
#endregion
#region Private Methods
private void stop (ushort code, string reason)
{
var data = code.Append (reason);
var msg = data.CheckIfValidCloseData ();
if (msg != null)
{
Log.Error (String.Format ("{0}\ncode: {1}\nreason: {2}", msg, code, reason));
return;
}
base.Stop ();
_serviceHosts.Stop (data);
}
#endregion
#region Protected Methods
///
/// Accepts a WebSocket connection request.
///
///
/// A that contains the WebSocket connection request objects.
///
protected override void AcceptWebSocket (TcpListenerWebSocketContext context)
{
var websocket = context.WebSocket;
websocket.Log = Log;
var path = context.Path;
IWebSocketServiceHost host;
if (!_serviceHosts.TryGetServiceHost (path, out host))
{
websocket.Close (HttpStatusCode.NotImplemented);
return;
}
if (BaseUri.IsAbsoluteUri)
websocket.Url = new Uri (BaseUri, path);
host.BindWebSocket (context);
}
#endregion
#region Public Methods
///
/// Adds the specified typed WebSocket service with the specified .
///
///
/// This method converts to URL-decoded string and
/// removes '/' from tail end of .
///
///
/// A that contains an absolute path to the WebSocket service.
///
///
/// The type of the WebSocket service. The T must inherit the class.
///
public void AddWebSocketService (string servicePath)
where T : WebSocketService, new ()
{
var msg = servicePath.CheckIfValidServicePath ();
if (msg != null)
{
Log.Error (String.Format ("{0}\nservice path: {1}", msg, servicePath ?? ""));
return;
}
var host = new WebSocketServiceHost (Log);
host.Uri = BaseUri.IsAbsoluteUri
? new Uri (BaseUri, servicePath)
: servicePath.ToUri ();
if (!KeepClean)
host.KeepClean = false;
_serviceHosts.Add (servicePath, host);
}
///
/// Removes the WebSocket service with the specified .
///
///
/// This method converts to URL-decoded string and
/// removes '/' from tail end of .
///
///
/// true if the WebSocket service is successfully found and removed; otherwise, false.
///
///
/// A that contains an absolute path to the WebSocket service to find.
///
public bool RemoveWebSocketService (string servicePath)
{
var msg = servicePath.CheckIfValidServicePath ();
if (msg != null)
{
Log.Error (String.Format ("{0}\nservice path: {1}", msg, servicePath ?? ""));
return false;
}
return _serviceHosts.Remove (servicePath);
}
///
/// Stops receiving the WebSocket connection requests.
///
public override void Stop ()
{
base.Stop ();
_serviceHosts.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)
{
var msg = code.CheckIfValidCloseStatusCode ();
if (msg != null)
{
Log.Error (String.Format ("{0}\ncode: {1}", msg, 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
}
}