#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 ServiceHostManager _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 ServiceHostManager (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 ServiceHostManager (Log); } #endregion #region Public Properties /// /// Gets the connection count to the . /// /// /// An that contains the connection count. /// public int ConnectionCount { get { return _serviceHosts.ConnectionCount; } } /// /// 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 associated with the every 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.Paths) yield return url + path; } } #endregion #region Private Methods private void stop (ushort code, string reason) { var data = code.Append (reason); if (data.Length > 125) { var msg = "The payload length of a Close frame must be 125 bytes or less."; Log.Error (String.Format ("{0}\ncode: {1}\nreason: {2}", msg, code, reason)); Error (msg); return; } base.Stop (); _serviceHosts.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; IServiceHost host; if (!_serviceHosts.TryGetServiceHost (path, out host)) { ws.Close (HttpStatusCode.NotImplemented); return; } if (BaseUri.IsAbsoluteUri) ws.Url = new Uri (BaseUri, path); host.BindWebSocket (context); } #endregion #region Public Methods /// /// Adds the specified typed WebSocket service with the specified . /// /// /// 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 () { string msg; if (!servicePath.IsValidAbsolutePath (out msg)) { Log.Error (msg); Error (msg); 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); } /// /// Broadcasts the specified array of to all clients. /// /// /// An array of to broadcast. /// public void Broadcast (byte [] data) { if (data == null) { var msg = "'data' must not be null."; Log.Error (msg); Error (msg); return; } _serviceHosts.Broadcast (data); } /// /// Broadcasts the specified to all clients. /// /// /// A to broadcast. /// public void Broadcast (string data) { if (data == null) { var msg = "'data' must not be null."; Log.Error (msg); Error (msg); return; } _serviceHosts.Broadcast (data); } /// /// Broadcasts the specified array of to all clients of the WebSocket service /// with the specified . /// /// /// true if the WebSocket service is found; otherwise, false. /// /// /// A that contains an absolute path to the WebSocket service to find. /// /// /// An array of to broadcast. /// public bool BroadcastTo (string servicePath, byte [] data) { var msg = servicePath.IsNullOrEmpty () ? "'servicePath' must not be null or empty." : data == null ? "'data' must not be null." : String.Empty; if (msg.Length > 0) { Log.Error (msg); Error (msg); return false; } return _serviceHosts.BroadcastTo (servicePath, data); } /// /// Broadcasts the specified to all clients of the WebSocket service /// with the specified . /// /// /// true if the WebSocket service is found; otherwise, false. /// /// /// A that contains an absolute path to the WebSocket service to find. /// /// /// A to broadcast. /// public bool BroadcastTo (string servicePath, string data) { var msg = servicePath.IsNullOrEmpty () ? "'servicePath' must not be null or empty." : data == null ? "'data' must not be null." : String.Empty; if (msg.Length > 0) { Log.Error (msg); Error (msg); return false; } return _serviceHosts.BroadcastTo (servicePath, data); } /// /// Sends Pings with the specified to all clients. /// /// /// A Dictionary<string, Dictionary<string, bool>> that contains the collection of /// service paths and pairs of ID and value indicating whether the /// 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 _serviceHosts.Broadping (String.Empty); var len = Encoding.UTF8.GetBytes (message).Length; if (len > 125) { var msg = "The payload length of a Ping frame must be 125 bytes or less."; Log.Error (msg); Error (msg); return null; } return _serviceHosts.Broadping (message); } /// /// Sends Pings with the specified to all clients of the WebSocket service /// with the specified . /// /// /// A Dictionary<string, bool> that contains the collection of session IDs and values /// indicating whether the received the Pongs from each clients /// in a time. If the WebSocket service is not found, returns . /// /// /// A that contains an absolute path to the WebSocket service to find. /// /// /// A that contains a message to send. /// public Dictionary BroadpingTo (string servicePath, string message) { if (message == null) message = String.Empty; var msg = servicePath.IsNullOrEmpty () ? "'servicePath' 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." : String.Empty; if (msg.Length > 0) { Log.Error (msg); Error (msg); return null; } return _serviceHosts.BroadpingTo (servicePath, message); } /// /// Gets the connection count to the WebSocket service with the specified . /// /// /// An that contains the connection count if the WebSocket service is successfully found; /// otherwise, -1. /// /// /// A that contains an absolute path to the WebSocket service to find. /// public int GetConnectionCount (string servicePath) { if (servicePath.IsNullOrEmpty ()) { var msg = "'servicePath' must not be null or empty."; Log.Error (msg); Error (msg); return -1; } return _serviceHosts.GetConnectionCount (servicePath); } /// /// Sends a Ping with the specified to the client associated with /// the specified and . /// /// /// true if the receives a Pong from the client in a time; /// otherwise, false. /// /// /// A that contains an absolute path to the WebSocket service to find. /// /// /// A that contains an ID that represents the destination for the Ping. /// /// /// A that contains a message to send. /// public bool PingTo (string servicePath, string id, string message) { if (message == null) message = String.Empty; var msg = servicePath.IsNullOrEmpty () ? "'servicePath' must not be null or empty." : 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." : String.Empty; if (msg.Length > 0) { Log.Error (msg); Error (msg); return false; } return _serviceHosts.PingTo (servicePath, id, message); } /// /// Removes the WebSocket service with the specified . /// /// /// 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) { if (servicePath.IsNullOrEmpty ()) { var msg = "'servicePath' must not be null or empty."; Log.Error (msg); Error (msg); return false; } return _serviceHosts.Remove (servicePath); } /// /// Sends a binary data to the client associated with the specified and /// . /// /// /// true if the client is successfully found; otherwise, false. /// /// /// A that contains an absolute path to the WebSocket service to find. /// /// /// 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 servicePath, string id, byte [] data) { var msg = servicePath.IsNullOrEmpty () ? "'servicePath' must not be null or empty." : id.IsNullOrEmpty () ? "'id' must not be null or empty." : data == null ? "'data' must not be null." : String.Empty; if (msg.Length > 0) { Log.Error (msg); Error (msg); return false; } return _serviceHosts.SendTo (servicePath, id, data); } /// /// Sends a text data to the client associated with the specified and /// . /// /// /// true if the client is successfully found; otherwise, false. /// /// /// A that contains an absolute path to the WebSocket service to find. /// /// /// A that contains an ID that represents the destination for the data. /// /// /// A that contains a text data to send. /// public bool SendTo (string servicePath, string id, string data) { var msg = servicePath.IsNullOrEmpty () ? "'servicePath' must not be null or empty." : id.IsNullOrEmpty () ? "'id' must not be null or empty." : data == null ? "'data' must not be null." : String.Empty; if (msg.Length > 0) { Log.Error (msg); Error (msg); return false; } return _serviceHosts.SendTo (servicePath, id, data); } /// /// 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) { if (!code.IsCloseStatusCode ()) { var msg = "Invalid status code for stop."; Log.Error (String.Format ("{0}\ncode: {1}", msg, code)); Error (msg); 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 } }