#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, IWebSocketServiceHost where T : WebSocketService, new () { #region Private Fields private string _servicePath; private WebSocketSessionManager _sessions; #endregion #region Internal Constructors internal WebSocketServiceHost (Logger logger) : base (logger) { _sessions = new WebSocketSessionManager (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 WebSocketSessionManager (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 servicePath) : this (System.Net.IPAddress.Any, port, servicePath) { } /// /// 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 servicePath, bool secure) : this (System.Net.IPAddress.Any, port, servicePath, 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 servicePath) : this (address, port, servicePath, 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 servicePath, bool secure) : base (address, port, servicePath, secure) { _sessions = new WebSocketSessionManager (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 sessions periodically. /// /// /// true if the WebSocket service host cleans up the inactive sessions /// every 60 seconds; otherwise, false. The default value is true. /// public bool KeepClean { get { return _sessions.KeepClean; } set { _sessions.KeepClean = value; } } /// /// Gets the path to the WebSocket service that the WebSocket service host provides. /// /// /// A that contains an absolute path to the WebSocket service. /// public string ServicePath { get { if (_servicePath == null) _servicePath = HttpUtility.UrlDecode (BaseUri.GetAbsolutePath ()).TrimEndSlash (); return _servicePath; } } /// /// Gets the manager of the sessions to the WebSocket service host. /// /// /// A that manages the sessions. /// public WebSocketSessionManager Sessions { get { return _sessions; } } /// /// 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); var msg = data.CheckIfValidCloseData (); if (msg != null) { Log.Error (String.Format ("{0}\ncode: {1}\nreason: {2}", msg, code, reason)); return; } base.Stop (); _sessions.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 = HttpUtility.UrlDecode (context.Path).TrimEndSlash (); if (path != ServicePath) { websocket.Close (HttpStatusCode.NotImplemented); return; } if (BaseUri.IsAbsoluteUri) websocket.Url = BaseUri; ((IWebSocketServiceHost) 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) { var msg = data.CheckIfValidSendData (); if (msg != null) { Log.Error (msg); return; } _sessions.Broadcast (data); } /// /// Broadcasts the specified to all clients. /// /// /// A to broadcast. /// public void Broadcast (string data) { var msg = data.CheckIfValidSendData (); if (msg != null) { Log.Error (msg); return; } _sessions.Broadcast (data); } /// /// Sends Pings to all clients. /// /// /// A Dictionary<string, bool> that contains the collection of pairs of session ID and value /// indicating whether the WebSocket service host received a Pong from each client in a time. /// public Dictionary Broadping () { return _sessions.Broadping (new byte [] {}); } /// /// Sends Pings with the specified to all clients. /// /// /// A Dictionary<string, bool> that contains the collection of pairs of session ID and value /// indicating whether the WebSocket service host received a Pong from each client in a time. /// /// /// A that contains a message to send. /// public Dictionary Broadping (string message) { if (message == null || message.Length == 0) return _sessions.Broadping (new byte [] {}); var data = Encoding.UTF8.GetBytes (message); var msg = data.CheckIfValidPingData (); if (msg != null) { Log.Error (msg); return null; } return _sessions.Broadping (data); } /// /// Close the session with the specified . /// /// /// A that contains a session ID to find. /// public void CloseSession (string id) { var msg = id.CheckIfValidSessionID (); if (msg != null) { Log.Error (msg); return; } _sessions.StopServiceInstance (id); } /// /// Close the session with the specified , /// and . /// /// /// A that contains a status code indicating the reason for closure. /// /// /// A that contains the reason for closure. /// /// /// A that contains a session ID to find. /// public void CloseSession (ushort code, string reason, string id) { var msg = id.CheckIfValidSessionID (); if (msg != null) { Log.Error (msg); return; } _sessions.StopServiceInstance (code, reason, id); } /// /// Close the session with the specified , /// and . /// /// /// A that contains a status code indicating the reason for closure. /// /// /// A that contains the reason for closure. /// /// /// A that contains a session ID to find. /// public void CloseSession (CloseStatusCode code, string reason, string id) { var msg = id.CheckIfValidSessionID (); if (msg != null) { Log.Error (msg); return; } _sessions.StopServiceInstance (code, reason, id); } /// /// Sends a Ping to the client associated with the specified . /// /// /// true if the WebSocket service host receives a Pong from the client in a time; /// otherwise, false. /// /// /// A that contains a session ID that represents the destination for the Ping. /// public bool PingTo (string id) { var msg = id.CheckIfValidSessionID (); if (msg != null) { Log.Error (msg); return false; } return _sessions.PingTo (id); } /// /// Sends a Ping with the specified to the client associated with /// the specified . /// /// /// true if the WebSocket service host receives a Pong from the client in a time; /// otherwise, false. /// /// /// A that contains a message to send. /// /// /// A that contains a session ID that represents the destination for the Ping. /// public bool PingTo (string message, string id) { var msg = id.CheckIfValidSessionID (); if (msg != null) { Log.Error (msg); return false; } return _sessions.PingTo (message, id); } /// /// Sends a binary to the client associated with the specified /// . /// /// /// true if is successfully sent; otherwise, false. /// /// /// An array of that contains a binary data to send. /// /// /// A that contains a session ID that represents the destination for the data. /// public bool SendTo (byte [] data, string id) { var msg = id.CheckIfValidSessionID (); if (msg != null) { Log.Error (msg); return false; } return _sessions.SendTo (data, id); } /// /// Sends a text to the client associated with the specified /// . /// /// /// true if is successfully sent; otherwise, false. /// /// /// A that contains a text data to send. /// /// /// A that contains a session ID that represents the destination for the data. /// public bool SendTo (string data, string id) { var msg = id.CheckIfValidSessionID (); if (msg != null) { Log.Error (msg); return false; } return _sessions.SendTo (data, id); } /// /// 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) { 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 #region Explicit Interface Implementation /// /// Binds the specified to a instance. /// /// /// A that contains the WebSocket connection request objects to bind. /// void IWebSocketServiceHost.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 IWebSocketServiceHost.Broadcast (byte [] data) { _sessions.Broadcast (data); } /// /// Broadcasts the specified to all clients. /// /// /// A to broadcast. /// void IWebSocketServiceHost.Broadcast (string data) { _sessions.Broadcast (data); } /// /// Sends Pings with the specified to all clients. /// /// /// A Dictionary<string, bool> that contains the collection of pairs of session ID and value /// indicating whether the WebSocket service host received a Pong from each client in a time. /// /// /// An array of that contains a message data to send. /// Dictionary IWebSocketServiceHost.Broadping (byte [] data) { return _sessions.Broadping (data); } /// /// Stops receiving the WebSocket connection requests with the specified array of . /// /// /// An array of that contains the reason for stop. /// void IWebSocketServiceHost.Stop (byte [] data) { base.Stop (); _sessions.Stop (data); } #endregion } }