diff --git a/Example2/Chat.cs b/Example2/Chat.cs index 91f450ad..99a39602 100644 --- a/Example2/Chat.cs +++ b/Example2/Chat.cs @@ -10,10 +10,21 @@ namespace Example2 private static int _num = 0; private string _name; + private string _prefix; + + public Chat () + : this ("anon#") + { + } + + public Chat (string prefix) + { + _prefix = prefix; + } private string getName () { - return Context.QueryString ["name"] ?? ("anon#" + getNum ()); + return Context.QueryString ["name"] ?? (_prefix + getNum ()); } private int getNum () diff --git a/Example2/Program.cs b/Example2/Program.cs index 16b8930b..36512e62 100644 --- a/Example2/Program.cs +++ b/Example2/Program.cs @@ -10,19 +10,19 @@ namespace Example2 { public static void Main (string [] args) { - /* Single service server - var wssv = new WebSocketServiceHost ("ws://localhost:4649"); - //var wssv = new WebSocketServiceHost ("ws://localhost:4649/Echo"); - //var wssv = new WebSocketServiceHost ("ws://localhost:4649/エコー"); - //var wssv = new WebSocketServiceHost (4649); - //var wssv = new WebSocketServiceHost (4649, "/Echo"); - //var wssv = new WebSocketServiceHost (4649, "/エコー"); - //var wssv = new WebSocketServiceHost ("ws://localhost:4649"); - //var wssv = new WebSocketServiceHost ("ws://localhost:4649/Chat"); - //var wssv = new WebSocketServiceHost ("ws://localhost:4649/チャット"); - //var wssv = new WebSocketServiceHost (4649); - //var wssv = new WebSocketServiceHost (4649, "/Chat"); - //var wssv = new WebSocketServiceHost (4649, "/チャット"); + /* Single service server + var wssv = new WebSocketServiceHost ("ws://localhost:4649", () => new Echo ()); + //var wssv = new WebSocketServiceHost ("ws://localhost:4649/Echo", () => new Echo ()); + //var wssv = new WebSocketServiceHost ("ws://localhost:4649/エコー", () => new Echo ()); + //var wssv = new WebSocketServiceHost (4649, () => new Echo ()); + //var wssv = new WebSocketServiceHost (4649, "/Echo", () => new Echo ()); + //var wssv = new WebSocketServiceHost (4649, "/エコー", () => new Echo ()); + //var wssv = new WebSocketServiceHost ("ws://localhost:4649", () => new Chat ()); + //var wssv = new WebSocketServiceHost ("ws://localhost:4649/Chat", () => new Chat ()); + //var wssv = new WebSocketServiceHost ("ws://localhost:4649/チャット", () => new Chat ()); + //var wssv = new WebSocketServiceHost (4649, () => new Chat ()); + //var wssv = new WebSocketServiceHost (4649, "/Chat", () => new Chat ()); + //var wssv = new WebSocketServiceHost (4649, "/チャット", () => new Chat ()); #if DEBUG wssv.Log.Level = LogLevel.TRACE; #endif @@ -30,7 +30,7 @@ namespace Example2 wssv.Start (); Console.WriteLine ( - "WebSocket Service Host (url: {0})\n listening on address: {1} port: {2}\n", + "A WebSocket Service Host (url: {0})\n listening on address: {1} port: {2}\n", wssv.Uri, wssv.Address, wssv.Port); */ @@ -48,6 +48,7 @@ namespace Example2 //wssv.KeepClean = false; wssv.AddWebSocketService ("/Echo"); wssv.AddWebSocketService ("/Chat"); + //wssv.AddWebSocketService ("/Chat", () => new Chat ("Anon#")); //wssv.AddWebSocketService ("/エコー"); //wssv.AddWebSocketService ("/チャット"); @@ -56,6 +57,7 @@ namespace Example2 "A WebSocket Server listening on port: {0} service path:", wssv.Port); foreach (var path in wssv.WebSocketServices.ServicePaths) Console.WriteLine (" {0}", path); + Console.WriteLine (); Console.WriteLine ("Press Enter key to stop server..."); diff --git a/Example3/Chat.cs b/Example3/Chat.cs index d4036f67..0d49caca 100644 --- a/Example3/Chat.cs +++ b/Example3/Chat.cs @@ -10,10 +10,21 @@ namespace Example3 private static int _num = 0; private string _name; + private string _prefix; + + public Chat () + : this ("anon#") + { + } + + public Chat (string prefix) + { + _prefix = prefix; + } private string getName () { - return Context.QueryString ["name"] ?? ("anon#" + getNum ()); + return Context.QueryString ["name"] ?? (_prefix + getNum ()); } private int getNum () diff --git a/Example3/Program.cs b/Example3/Program.cs index 4ca347bb..deec975d 100644 --- a/Example3/Program.cs +++ b/Example3/Program.cs @@ -25,6 +25,7 @@ namespace Example3 //_httpsv.KeepClean = false; _httpsv.AddWebSocketService ("/Echo"); _httpsv.AddWebSocketService ("/Chat"); + //_httpsv.AddWebSocketService ("/Chat", () => new Chat ("Anon#")); _httpsv.OnGet += (sender, e) => { @@ -34,7 +35,7 @@ namespace Example3 _httpsv.Start (); if (_httpsv.IsListening) { - Console.WriteLine ("HTTP Server listening on port: {0} service path:", _httpsv.Port); + Console.WriteLine ("An HTTP Server listening on port: {0} service path:", _httpsv.Port); foreach (var path in _httpsv.WebSocketServices.ServicePaths) Console.WriteLine (" {0}", path); diff --git a/README.md b/README.md index 8000cefd..b25e7f66 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ The `WebSocket` class exists in the `WebSocketSharp` namespace. #### Step 2 #### -Creating a instance of the `WebSocket` class with the specified WebSocket URL to connect. +Creating an instance of the `WebSocket` class with the specified WebSocket URL to connect. ```cs using (var ws = new WebSocket ("ws://example.com")) @@ -187,7 +187,8 @@ namespace Example { public static void Main (string [] args) { - var wssv = new WebSocketServiceHost ("ws://dragonsnest.far/Laputa"); + var wssv = new WebSocketServer ("ws://dragonsnest.far"); + wssv.AddWebSocketService ("/Laputa"); wssv.Start (); Console.ReadKey (true); wssv.Stop (); @@ -204,11 +205,11 @@ Required namespace. using WebSocketSharp.Server; ``` -The `WebSocketService`, `WebSocketServiceHost` and `WebSocketServer` classes exist in the `WebSocketSharp.Server` namespace. +The `WebSocketService` and `WebSocketServer` classes exist in the `WebSocketSharp.Server` namespace. #### Step 2 #### -Creating a class that inherits the `WebSocketService` class. +Creating the class that inherits the `WebSocketService` class. For example, if you want to provide an echo service, @@ -226,7 +227,7 @@ public class Echo : WebSocketService } ``` -Or if you want to provide a chat service, +And if you want to provide a chat service, ```cs using System; @@ -235,9 +236,21 @@ using WebSocketSharp.Server; public class Chat : WebSocketService { + private string _suffix; + + public Chat () + : this (String.Empty) + { + } + + public Chat (string suffix) + { + _suffix = suffix; + } + protected override void OnMessage (MessageEventArgs e) { - Sessions.Broadcast (e.Data); + Sessions.Broadcast (e.Data + _suffix); } } ``` @@ -248,25 +261,23 @@ In addition, if you override the `OnOpen`, `OnError` and `OnClose` methods, each #### Step 3 #### -Creating a instance of the `WebSocketServiceHost` class if you want the single WebSocket service server. - -```cs -var wssv = new WebSocketServiceHost ("ws://example.com:4649"); -``` - -Or creating a instance of the `WebSocketServer` class if you want the multi WebSocket service server. +Creating an instance of the `WebSocketServer` class. ```cs var wssv = new WebSocketServer (4649); wssv.AddWebSocketService ("/Echo"); -wssv.AddWebSocketService ("/Chat"); +wssv.AddWebSocketService ("/Chat", () => new Chat (" Nice boat.")); ``` -You can add any WebSocket service with a specified path to the service to your `WebSocketServer` by using the `WebSocketServer.AddWebSocketService` method. +You can add any WebSocket service with a specified path to the service to your `WebSocketServer` by using the `WebSocketServer.AddWebSocketService` or `WebSocketServer.AddWebSocketService` method. -The type of `T` inherits `WebSocketService` class, so you can use a class that was created in **Step 2**. +The type of `TWithNew` must inherit the `WebSocketService` class and must have a public parameterless constructor. -If you create a instance of the `WebSocketServer` class without the port number, the `WebSocketServer` set the port number to **80** automatically. So it is necessary to run with root permission. +The type of `T` must inherit `WebSocketService` class. + +So you can use the classes created in **Step 2**. + +If you create an instance of the `WebSocketServer` class without the port number, the `WebSocketServer` set the port number to **80** automatically. So it is necessary to run with root permission. $ sudo mono example2.exe @@ -290,18 +301,19 @@ wssv.Stop (); I modified the `System.Net.HttpListener`, `System.Net.HttpListenerContext` and some other classes of [Mono] to create the HTTP server that can upgrade the connection to the WebSocket connection when receives a WebSocket connection request. -You can add any WebSocket service with a specified path to the service to your `HttpServer` by using the `HttpServer.AddWebSocketService` method. +You can add any WebSocket service with a specified path to the service to your `HttpServer` by using the `HttpServer.AddWebSocketService` or `HttpServer.AddWebSocketService` method. ```cs var httpsv = new HttpServer (4649); -httpsv.AddWebSocketService ("/"); +httpsv.AddWebSocketService ("/Echo"); +httpsv.AddWebSocketService ("/Chat", () => new Chat (" Nice boat.")); ``` For more information, could you see **[Example3]**? ### Secure Connection ### -As a **WebSocket Client**, creating a instance of the `WebSocket` class with the WebSocket URL with **wss** scheme. +As a **WebSocket Client**, creating an instance of the `WebSocket` class with the WebSocket URL with **wss** scheme. ```cs using (var ws = new WebSocket ("wss://example.com")) @@ -322,7 +334,7 @@ ws.ServerCertificateValidationCallback = (sender, certificate, chain, sslPolicyE If you set this property to nothing, the validation does nothing with the server certificate, always returns valid. -As a **WebSocket Server**, creating and setting a instance of the WebSocket server with some settings for the secure connection. +As a **WebSocket Server**, creating and setting an instance of the WebSocket server with some settings for the secure connection. ```cs var wssv = new WebSocketServer (4649, true); @@ -349,7 +361,7 @@ And if you want to output a log, you use some output methods. The following outp ws.Log.Debug ("This is a debug message."); ``` -The `WebSocketServiceHost`, `WebSocketServer` and `HttpServer` classes include the same logging functions. +The `WebSocketServer` and `HttpServer` classes include the same logging functions. ## Examples ## diff --git a/websocket-sharp/Server/HttpServer.cs b/websocket-sharp/Server/HttpServer.cs index 8a747b37..0d2c18c1 100644 --- a/websocket-sharp/Server/HttpServer.cs +++ b/websocket-sharp/Server/HttpServer.cs @@ -2,6 +2,8 @@ /* * HttpServer.cs * + * A simple HTTP server that allows to accept the WebSocket connection requests. + * * The MIT License * * Copyright (c) 2012-2013 sta.blockhead @@ -26,6 +28,13 @@ */ #endregion +#region Thanks +/* + * Thanks: + * Juan Manuel Lallana + */ +#endregion + using System; using System.Collections.Generic; using System.Diagnostics; @@ -510,20 +519,53 @@ namespace WebSocketSharp.Server /// /// A that contains an absolute path to the WebSocket service. /// + /// + /// The type of the WebSocket service. The TWithNew must inherit the class and + /// must have a public parameterless constructor. + /// + public void AddWebSocketService (string servicePath) + where TWithNew : WebSocketService, new () + { + AddWebSocketService (servicePath, () => new TWithNew ()); + } + + /// + /// Adds the specified typed WebSocket service with the specified and + /// . + /// + /// + /// + /// This method converts to URL-decoded string and + /// removes '/' from tail end of . + /// + /// + /// returns a initialized specified typed WebSocket service + /// instance. + /// + /// + /// + /// A that contains an absolute path to the WebSocket service. + /// + /// + /// A Func<T> delegate that references the method used to initialize a new WebSocket service + /// instance (a new WebSocket session). + /// /// /// The type of the WebSocket service. The T must inherit the class. /// - public void AddWebSocketService (string servicePath) - where T : WebSocketService, new () + public void AddWebSocketService (string servicePath, Func serviceConstructor) + where T : WebSocketService { - var msg = servicePath.CheckIfValidServicePath (); + var msg = servicePath.CheckIfValidServicePath () ?? + (serviceConstructor == null ? "'serviceConstructor' must not be null." : null); + if (msg != null) { _logger.Error (String.Format ("{0}\nservice path: {1}", msg, servicePath ?? "")); return; } - var host = new WebSocketServiceHost (_logger); + var host = new WebSocketServiceHost (serviceConstructor, _logger); host.Uri = servicePath.ToUri (); if (!KeepClean) host.KeepClean = false; diff --git a/websocket-sharp/Server/WebSocketServer.cs b/websocket-sharp/Server/WebSocketServer.cs index 10f94763..05e2a2c5 100644 --- a/websocket-sharp/Server/WebSocketServer.cs +++ b/websocket-sharp/Server/WebSocketServer.cs @@ -28,6 +28,13 @@ */ #endregion +#region Thanks +/* + * Thanks: + * Juan Manuel Lallana + */ +#endregion + using System; using System.Collections.Generic; using System.Net.Sockets; @@ -245,20 +252,53 @@ namespace WebSocketSharp.Server /// /// A that contains an absolute path to the WebSocket service. /// + /// + /// The type of the WebSocket service. The TWithNew must inherit the + /// class and must have a public parameterless constructor. + /// + public void AddWebSocketService (string servicePath) + where TWithNew : WebSocketService, new () + { + AddWebSocketService (servicePath, () => new TWithNew ()); + } + + /// + /// Adds the specified typed WebSocket service with the specified and + /// . + /// + /// + /// + /// This method converts to URL-decoded string and + /// removes '/' from tail end of . + /// + /// + /// returns a initialized specified typed WebSocket service + /// instance. + /// + /// + /// + /// A that contains an absolute path to the WebSocket service. + /// + /// + /// A Func<T> delegate that references the method used to initialize a new WebSocket service + /// instance (a new WebSocket session). + /// /// /// The type of the WebSocket service. The T must inherit the class. /// - public void AddWebSocketService (string servicePath) - where T : WebSocketService, new () + public void AddWebSocketService (string servicePath, Func serviceConstructor) + where T : WebSocketService { - var msg = servicePath.CheckIfValidServicePath (); + var msg = servicePath.CheckIfValidServicePath () ?? + (serviceConstructor == null ? "'serviceConstructor' must not be null." : null); + if (msg != null) { Log.Error (String.Format ("{0}\nservice path: {1}", msg, servicePath ?? "")); return; } - var host = new WebSocketServiceHost (Log); + var host = new WebSocketServiceHost (serviceConstructor, Log); host.Uri = BaseUri.IsAbsoluteUri ? new Uri (BaseUri, servicePath) : servicePath.ToUri (); diff --git a/websocket-sharp/Server/WebSocketServiceHost.cs b/websocket-sharp/Server/WebSocketServiceHost.cs index b0d1d3eb..4f49786a 100644 --- a/websocket-sharp/Server/WebSocketServiceHost.cs +++ b/websocket-sharp/Server/WebSocketServiceHost.cs @@ -28,6 +28,13 @@ */ #endregion +#region Thanks +/* + * Thanks: + * Juan Manuel Lallana + */ +#endregion + using System; using System.Collections.Generic; using System.Net.Sockets; @@ -48,10 +55,11 @@ namespace WebSocketSharp.Server /// The T must inherit the class. /// public class WebSocketServiceHost : WebSocketServerBase, IWebSocketServiceHost - where T : WebSocketService, new () + where T : WebSocketService { #region Private Fields + private Func _serviceConstructor; private string _servicePath; private WebSocketSessionManager _sessions; private volatile ServerState _state; @@ -61,9 +69,10 @@ namespace WebSocketSharp.Server #region Internal Constructors - internal WebSocketServiceHost (Logger logger) + internal WebSocketServiceHost (Func serviceConstructor, Logger logger) : base (logger) { + _serviceConstructor = serviceConstructor; _sessions = new WebSocketSessionManager (logger); _state = ServerState.READY; _sync = new object (); @@ -80,8 +89,18 @@ namespace WebSocketSharp.Server /// /// An that contains a port number. /// - public WebSocketServiceHost (int port) - : this (port, "/") + /// + /// A Func<T> delegate that references the method used to initialize a new WebSocket service + /// instance (a new WebSocket session). + /// + /// + /// is . + /// + /// + /// is 0 or less, or 65536 or greater. + /// + public WebSocketServiceHost (int port, Func serviceConstructor) + : this (port, "/", serviceConstructor) { } @@ -92,9 +111,31 @@ namespace WebSocketSharp.Server /// /// A that contains a WebSocket URL. /// - public WebSocketServiceHost (string url) + /// + /// A Func<T> delegate that references the method used to initialize a new WebSocket service + /// instance (a new WebSocket session). + /// + /// + /// + /// is . + /// + /// + /// -or- + /// + /// + /// is . + /// + /// + /// + /// is invalid. + /// + public WebSocketServiceHost (string url, Func serviceConstructor) : base (url) { + if (serviceConstructor == null) + throw new ArgumentNullException ("serviceConstructor"); + + _serviceConstructor = serviceConstructor; _sessions = new WebSocketSessionManager (Log); _state = ServerState.READY; _sync = new object (); @@ -111,14 +152,28 @@ namespace WebSocketSharp.Server /// A that indicates providing a secure connection or not. /// (true indicates providing a secure connection.) /// - public WebSocketServiceHost (int port, bool secure) - : this (port, "/", secure) + /// + /// A Func<T> delegate that references the method used to initialize a new WebSocket service + /// instance (a new WebSocket session). + /// + /// + /// is . + /// + /// + /// is 0 or less, or 65536 or greater. + /// + /// + /// Pair of and is invalid. + /// + public WebSocketServiceHost (int port, bool secure, Func serviceConstructor) + : this (port, "/", secure, serviceConstructor) { } /// /// Initializes a new instance of the WebSocketServiceHost<T> class that listens for - /// incoming connection attempts on the specified and . + /// incoming connection attempts on the specified and + /// . /// /// /// An that contains a port number. @@ -126,8 +181,29 @@ namespace WebSocketSharp.Server /// /// A that contains an absolute path. /// - public WebSocketServiceHost (int port, string servicePath) - : this (System.Net.IPAddress.Any, port, servicePath) + /// + /// A Func<T> delegate that references the method used to initialize a new WebSocket service + /// instance (a new WebSocket session). + /// + /// + /// + /// is . + /// + /// + /// -or- + /// + /// + /// is . + /// + /// + /// + /// is 0 or less, or 65536 or greater. + /// + /// + /// is invalid. + /// + public WebSocketServiceHost (int port, string servicePath, Func serviceConstructor) + : this (System.Net.IPAddress.Any, port, servicePath, serviceConstructor) { } @@ -146,8 +222,37 @@ namespace WebSocketSharp.Server /// 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) + /// + /// A Func<T> delegate that references the method used to initialize a new WebSocket service + /// instance (a new WebSocket session). + /// + /// + /// + /// is . + /// + /// + /// -or- + /// + /// + /// is . + /// + /// + /// + /// is 0 or less, or 65536 or greater. + /// + /// + /// + /// is invalid. + /// + /// + /// -or- + /// + /// + /// Pair of and is invalid. + /// + /// + public WebSocketServiceHost (int port, string servicePath, bool secure, Func serviceConstructor) + : this (System.Net.IPAddress.Any, port, servicePath, secure, serviceConstructor) { } @@ -165,8 +270,36 @@ namespace WebSocketSharp.Server /// /// A that contains an absolute path. /// - public WebSocketServiceHost (System.Net.IPAddress address, int port, string servicePath) - : this (address, port, servicePath, port == 443 ? true : false) + /// + /// A Func<T> delegate that references the method used to initialize a new WebSocket service + /// instance (a new WebSocket session). + /// + /// + /// + /// is . + /// + /// + /// -or- + /// + /// + /// is . + /// + /// + /// -or- + /// + /// + /// is . + /// + /// + /// + /// is 0 or less, or 65536 or greater. + /// + /// + /// is invalid. + /// + public WebSocketServiceHost ( + System.Net.IPAddress address, int port, string servicePath, Func serviceConstructor) + : this (address, port, servicePath, port == 443 ? true : false, serviceConstructor) { } @@ -188,9 +321,49 @@ namespace WebSocketSharp.Server /// 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) + /// + /// A Func<T> delegate that references the method used to initialize a new WebSocket service + /// instance (a new WebSocket session). + /// + /// + /// + /// is . + /// + /// + /// -or- + /// + /// + /// is . + /// + /// + /// -or- + /// + /// + /// is . + /// + /// + /// + /// is 0 or less, or 65536 or greater. + /// + /// + /// + /// is invalid. + /// + /// + /// -or- + /// + /// + /// Pair of and is invalid. + /// + /// + public WebSocketServiceHost ( + System.Net.IPAddress address, int port, string servicePath, bool secure, Func serviceConstructor) : base (address, port, servicePath, secure) { + if (serviceConstructor == null) + throw new ArgumentNullException ("serviceConstructor"); + + _serviceConstructor = serviceConstructor; _sessions = new WebSocketSessionManager (Log); _state = ServerState.READY; _sync = new object (); @@ -450,14 +623,14 @@ namespace WebSocketSharp.Server #region Explicit Interface Implementation /// - /// Binds the specified to a instance. + /// Binds the specified to a WebSocket service instance. /// /// /// A that contains the WebSocket connection request objects to bind. /// void IWebSocketServiceHost.BindWebSocket (WebSocketContext context) { - T service = new T (); + T service = _serviceConstructor (); service.Bind (context, _sessions); service.Start (); }