#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 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()
{
init();
}
#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)
{
init();
}
///
/// 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)
{
init();
}
#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 Sweeping {
get {
return _sessions.Sweeping;
}
set {
_sessions.Sweeping = 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 init()
{
_sessions = new WebSocketServiceManager();
}
#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;
var path = context.Path.UrlDecode();
if (path != Uri.GetAbsolutePath().UrlDecode())
{
websocket.Close(HttpStatusCode.NotImplemented);
return;
}
if (Uri.IsAbsoluteUri)
websocket.Url = Uri;
((IServiceHost)this).BindWebSocket(context);
}
#endregion
#region Public Methods
///
/// Broadcasts the specified to all clients.
///
///
/// A to broadcast.
///
public void Broadcast(string data)
{
_sessions.Broadcast(data);
}
///
/// Pings with the specified to all clients.
///
///
/// A Dictionary<string, bool> that contains the collection of session IDs and values
/// indicating whether the server received the Pongs from each clients in a time.
///
///
/// A that contains a message.
///
public Dictionary Broadping(string message)
{
return _sessions.Broadping(message);
}
///
/// Stops receiving the WebSocket connection requests.
///
public override void Stop()
{
base.Stop();
_sessions.Stop();
}
#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();
}
#endregion
}
}