270 lines
8.2 KiB
C#
270 lines
8.2 KiB
C#
#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 WebSocketSharp.Net;
|
|
using WebSocketSharp.Net.WebSockets;
|
|
|
|
namespace WebSocketSharp.Server {
|
|
|
|
/// <summary>
|
|
/// Provides the functions of the server that receives the WebSocket connection requests.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The WebSocketServer class provides the multi WebSocket service.
|
|
/// </remarks>
|
|
public class WebSocketServer : WebSocketServerBase
|
|
{
|
|
#region Private Fields
|
|
|
|
private ServiceHostManager _svcHosts;
|
|
|
|
#endregion
|
|
|
|
#region Public Constructors
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="WebSocketServer"/> class.
|
|
/// </summary>
|
|
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"/>.
|
|
/// </summary>
|
|
/// <param name="port">
|
|
/// An <see cref="int"/> that contains a port number.
|
|
/// </param>
|
|
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.
|
|
/// </summary>
|
|
/// <param name="url">
|
|
/// A <see cref="string"/> that contains a WebSocket URL.
|
|
/// </param>
|
|
public WebSocketServer(string url)
|
|
: base(url)
|
|
{
|
|
if (BaseUri.AbsolutePath != "/")
|
|
{
|
|
var msg = "Must not contain the path component: " + url;
|
|
throw new ArgumentException(msg, "url");
|
|
}
|
|
|
|
_svcHosts = new ServiceHostManager();
|
|
}
|
|
|
|
/// <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"/>.
|
|
/// </summary>
|
|
/// <param name="port">
|
|
/// 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.)
|
|
/// </param>
|
|
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"/>.
|
|
/// </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.
|
|
/// </param>
|
|
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"/>.
|
|
/// </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.
|
|
/// </param>
|
|
/// <param name="secure">
|
|
/// 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)
|
|
{
|
|
_svcHosts = new ServiceHostManager();
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Public Properties
|
|
|
|
/// <summary>
|
|
/// Gets the collection of paths associated with the every WebSocket services that the server provides.
|
|
/// </summary>
|
|
/// <value>
|
|
/// An IEnumerable<string> that contains the collection of paths.
|
|
/// </value>
|
|
public IEnumerable<string> ServicePaths {
|
|
get {
|
|
var url = BaseUri.IsAbsoluteUri
|
|
? BaseUri.ToString().TrimEnd('/')
|
|
: String.Empty;
|
|
|
|
foreach (var path in _svcHosts.Paths)
|
|
yield return url + path;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets a value indicating whether the server cleans up the inactive WebSocket service
|
|
/// instances periodically.
|
|
/// </summary>
|
|
/// <value>
|
|
/// <c>true</c> if the server cleans up the inactive WebSocket service instances every 60 seconds;
|
|
/// otherwise, <c>false</c>. The default value is <c>true</c>.
|
|
/// </value>
|
|
public bool Sweeping {
|
|
get {
|
|
return _svcHosts.Sweeping;
|
|
}
|
|
|
|
set {
|
|
_svcHosts.Sweeping = value;
|
|
}
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Protected Methods
|
|
|
|
/// <summary>
|
|
/// Accepts a WebSocket connection request.
|
|
/// </summary>
|
|
/// <param name="context">
|
|
/// A <see cref="TcpListenerWebSocketContext"/> that contains the WebSocket connection request objects.
|
|
/// </param>
|
|
protected override void AcceptWebSocket(TcpListenerWebSocketContext context)
|
|
{
|
|
var ws = context.WebSocket;
|
|
var path = context.Path.UrlDecode();
|
|
|
|
ws.Log = Log;
|
|
IServiceHost svcHost;
|
|
if (!_svcHosts.TryGetServiceHost(path, out svcHost))
|
|
{
|
|
ws.Close(HttpStatusCode.NotImplemented);
|
|
return;
|
|
}
|
|
|
|
if (BaseUri.IsAbsoluteUri)
|
|
ws.Url = new Uri(BaseUri, path);
|
|
|
|
svcHost.BindWebSocket(context);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Public Methods
|
|
|
|
/// <summary>
|
|
/// Adds the specified type WebSocket service.
|
|
/// </summary>
|
|
/// <param name="absPath">
|
|
/// A <see cref="string"/> that contains an absolute path associated with 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()
|
|
{
|
|
string msg;
|
|
if (!absPath.IsValidAbsolutePath(out msg))
|
|
{
|
|
Log.Error(msg);
|
|
Error(msg);
|
|
|
|
return;
|
|
}
|
|
|
|
var svcHost = new WebSocketServiceHost<T>(Log);
|
|
svcHost.Uri = BaseUri.IsAbsoluteUri
|
|
? new Uri(BaseUri, absPath)
|
|
: absPath.ToUri();
|
|
|
|
if (!Sweeping)
|
|
svcHost.Sweeping = false;
|
|
|
|
_svcHosts.Add(absPath, svcHost);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Broadcasts the specified <see cref="string"/> to all clients.
|
|
/// </summary>
|
|
/// <param name="data">
|
|
/// A <see cref="string"/> to broadcast.
|
|
/// </param>
|
|
public void Broadcast(string data)
|
|
{
|
|
_svcHosts.Broadcast(data);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Stops receiving the WebSocket connection requests.
|
|
/// </summary>
|
|
public override void Stop()
|
|
{
|
|
base.Stop();
|
|
_svcHosts.Stop();
|
|
}
|
|
|
|
#endregion
|
|
}
|
|
}
|