First Commit

Author: Eldin Zenderink

SimpleWebsocketServer.sln

@@ -0,0 +1,34 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 15
+VisualStudioVersion = 15.0.27428.2005
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SimpleWebsocketServer", "SimpleWebsocketServer\SimpleWebsocketServer.csproj", "{AF7A3511-2D27-4BED-B81F-304C508D016B}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WebsocketServerTest", "WebsocketServerTest\WebsocketServerTest.csproj", "{D964861E-249F-42CA-802C-7D02A7872DBC}"
+	ProjectSection(ProjectDependencies) = postProject
+		{AF7A3511-2D27-4BED-B81F-304C508D016B} = {AF7A3511-2D27-4BED-B81F-304C508D016B}
+	EndProjectSection
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{AF7A3511-2D27-4BED-B81F-304C508D016B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{AF7A3511-2D27-4BED-B81F-304C508D016B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{AF7A3511-2D27-4BED-B81F-304C508D016B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{AF7A3511-2D27-4BED-B81F-304C508D016B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D964861E-249F-42CA-802C-7D02A7872DBC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D964861E-249F-42CA-802C-7D02A7872DBC}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D964861E-249F-42CA-802C-7D02A7872DBC}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D964861E-249F-42CA-802C-7D02A7872DBC}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {7F093CC9-7107-4046-A70E-0CD2D51FC33A}
+	EndGlobalSection
+EndGlobal

SimpleWebsocketServer/Doxyfile

@@ -0,0 +1,10 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace SimpleWebsocketServer
+{
+    class HttpServerSettings
+    {
+    }
+}

SimpleWebsocketServer/HttpServerSettings.cs

@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+
+namespace SimpleWebSocketServerLibrary
+{
+    /// <summary>
+    /// Provides settings and default values for the SimpleWebSocketServer Class.
+    /// </summary>
+    public class SimpleWebSocketServerSettings
+    {
+        /// <summary>
+        /// List with url paths where the websocket server needs to listen to. Default = "";
+        /// </summary>
+        public List<string> baseUrls { get; set; } = new List<string>(){"/"};
+        /// <summary>
+        /// Port where the server needs to listen to. Default = 80;
+        /// </summary>
+        public int port { get; set; } = 80;
+        /// <summary>
+        /// Buffer size for receiving messages. Default = 4096; (bytes)
+        /// </summary>
+        public int bufferSize { get; set; } = 4096;
+
+    }
+}

SimpleWebsocketServer/SimpleWebSocketServerSettings.cs

@@ -0,0 +1,314 @@
+using System;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SimpleWebSocketServerLibrary
+{
+    /// <summary>
+    /// Middleware class for interfacing with the WebSocketHandler and WebSocketHttpServer class.
+    /// </summary>
+    public class SimpleWebSocketServer
+    {
+        /// <summary>
+        /// Interface for the WebSocketHandler class.
+        /// </summary>
+        private readonly IWebSocketHandler _WebsocketHandler;
+        /// <summary>
+        /// Interface for the WebSocketHttpServer class.
+        /// </summary>
+        private readonly IWebSocketHttpServer _WebSocketHttpServer;
+
+
+        /// <summary>
+        /// Eventhandler for when events such as receiving messages and errors from the websocket server happen.
+        /// </summary>
+        public event EventHandler<WebSocketEventArg> WebsocketServerEvent;
+
+        /// <summary>
+        /// Constructor for setting up the Library.
+        /// </summary>
+        /// <param name="settings">Settings with default values.</param>
+        public SimpleWebSocketServer(SimpleWebSocketServerSettings settings)
+        {
+            _WebsocketHandler = new WebSocketHandler(settings.bufferSize);
+            _WebsocketHandler.WebsocketEvent += OnWebsocketServerEvent;
+            _WebSocketHttpServer = new WebSocketHttpServer(_WebsocketHandler, settings);
+        }
+
+        /// <summary>
+        /// Overload constructor for setting up library with default values.
+        /// </summary>
+        public SimpleWebSocketServer() : this(new SimpleWebSocketServerSettings()){}
+
+        /// <summary>
+        /// Event handler for receiving websocket messages from the websocket handler.
+        /// </summary>
+        /// <param name="sender">Instance of firing class.</param>
+        /// <param name="arg">Arguments for event.</param>
+        private void OnWebsocketServerEvent(object sender, WebSocketEventArg arg)
+        {
+            WebsocketServerEvent?.Invoke(this, arg);
+        }
+
+        /// <summary>
+        /// Starts running the server async.
+        /// </summary>
+        public async Task StartServerAsync()
+        {
+            await _WebSocketHttpServer.RunServer();
+        }
+
+        /// <summary>
+        /// Starts running the server async.
+        /// </summary>
+        public void StartServer()
+        {
+            Task.Run(async()=> await _WebSocketHttpServer.RunServer());
+        }
+
+        /// <summary>
+        /// Overload method for sending text messages to a specific client, using it's id, asynchronous.
+        /// </summary>
+        /// <param name="messageToSend"></param>
+        /// <param name="clientId"></param>
+        /// <returns>True when send succesfully.</returns>
+        public async Task<bool> SendTextMessageAsync(string messageToSend, string clientId = null)
+        {
+            WebSocketMessageContainer message = new WebSocketMessageContainer()
+            {
+                data = Encoding.UTF8.GetBytes(messageToSend),
+                isText = true
+            };
+
+            if (clientId != null)
+            {
+                return await _WebsocketHandler.SendMessage(message, clientId);
+            }
+
+            return await _WebsocketHandler.SendMessage(message);
+        }
+
+        /// <summary>
+        /// Overload method for sending text messages to a specific client, using it's id, synchronous.
+        /// </summary>
+        /// <param name="messageToSend"></param>
+        /// <param name="clientId"></param>
+        /// <returns>True when send succesfully.</returns>
+        public bool SendTextMessage(string messageToSend, string clientId = null)
+        {
+            WebSocketMessageContainer message = new WebSocketMessageContainer()
+            {
+                data = Encoding.UTF8.GetBytes(messageToSend),
+                isText = true
+            };
+
+            if (clientId != null)
+            {
+                return Task.Run(async () => await _WebsocketHandler.SendMessage(message, clientId)).GetAwaiter().GetResult();
+            }
+
+            return Task.Run(async () => await _WebsocketHandler.SendMessage(message)).GetAwaiter().GetResult();
+        }
+
+
+        /// <summary>
+        /// Sends a binary "message" to a specific client asynchronous.
+        /// </summary>
+        /// <param name="messageToSend">Message in binary format (byte array).</param>
+        /// <param name="clientId">Client to send to.</param>
+        /// <returns>True when succesfully send.</returns>
+        public async Task<bool> SendBinaryMessageAsync(byte[] messageToSend, string clientId = null)
+        {
+            WebSocketMessageContainer message = new WebSocketMessageContainer()
+            {
+                data = messageToSend,
+                isBinary= true
+            };
+
+            if (clientId != null)
+            {
+                return await _WebsocketHandler.SendMessage(message, clientId);
+            }
+
+            return await _WebsocketHandler.SendMessage(message);
+        }
+
+        /// <summary>
+        /// Sends a binary "message" to a specific client synchronous.
+        /// </summary>
+        /// <param name="messageToSend">Message in binary format (byte array).</param>
+        /// <param name="clientId">Client to send to.</param>
+        /// <returns>True when succesfully send.</returns>
+        public bool SendBinaryMessage(byte[] messageToSend, string clientId = null)
+        {
+            WebSocketMessageContainer message = new WebSocketMessageContainer()
+            {
+                data = messageToSend,
+                isBinary = true
+            };
+
+            if (clientId != null)
+            {
+                return Task.Run(async () => await _WebsocketHandler.SendMessage(message, clientId)).GetAwaiter().GetResult();
+            }
+
+            return Task.Run(async () => await _WebsocketHandler.SendMessage(message)).GetAwaiter().GetResult();
+        }
+
+        /// <summary>
+        /// Sends a ping message to all clients asynchronous, can have message.
+        /// </summary>
+        /// <param name="messageToSend">Possible extra message to send along ping.</param>
+        /// <param name="clientId">Set clientId in case you want to send to a specific client.</param>
+        /// <returns>True when succesfully send.</returns>
+        public async Task<bool> SendPingMessageAsync(string messageToSend = "", string clientId = null)
+        {
+            WebSocketMessageContainer message = new WebSocketMessageContainer()
+            {
+                data = Encoding.UTF8.GetBytes(messageToSend),
+                isPing = true
+            };
+
+            if (clientId != null)
+            {
+                return await _WebsocketHandler.SendMessage(message, clientId);
+            }
+            return await _WebsocketHandler.SendMessage(message);
+        }
+
+        /// <summary>
+        /// Sends a ping message to all clients synchronous, can have message.
+        /// </summary>
+        /// <param name="messageToSend">Possible extra message to send along ping.</param>
+        /// <param name="clientId">Set clientId in case you want to send to a specific client.</param>
+        /// <returns>True when succesfully send.</returns>
+        public bool SendPingMessage(string messageToSend = "", string clientId = null)
+        {
+            WebSocketMessageContainer message = new WebSocketMessageContainer()
+            {
+                data = Encoding.UTF8.GetBytes(messageToSend),
+                isPing = true
+            };
+
+            if (clientId != null)
+            {
+                return Task.Run(async () => await _WebsocketHandler.SendMessage(message, clientId)).GetAwaiter().GetResult();
+            }
+            return Task.Run(async () => await _WebsocketHandler.SendMessage(message)).GetAwaiter().GetResult();
+        }
+
+        /// <summary>
+        /// Send pong message to all available clients asynchronous, can have message.
+        /// </summary>
+        /// <param name="messageToSend">Possible extra message to send along ping.</param>
+        /// <param name="clientId">Set clientId in case you want to send to a specific client.</param>
+        /// <returns>True when succesfully send.</returns>
+        public async Task<bool> SendPongMessageAsync(string messageToSend = "", string clientId = null)
+        {
+            WebSocketMessageContainer message = new WebSocketMessageContainer()
+            {
+                data = Encoding.UTF8.GetBytes(messageToSend),
+                isPong = true
+            };
+
+            if (clientId != null)
+            {
+                return await _WebsocketHandler.SendMessage(message, clientId);
+            }
+            return await _WebsocketHandler.SendMessage(message);
+        }
+
+        /// <summary>
+        /// Send pong message to all available clients synchronous, can have message.
+        /// </summary>
+        /// <param name="messageToSend">Possible extra message to send along ping.</param>
+        /// <param name="clientId">Set clientId in case you want to send to a specific client.</param>
+        /// <returns>True when succesfully send.</returns>
+        public bool SendPongMessage(string messageToSend = "", string clientId = null)
+        {
+            WebSocketMessageContainer message = new WebSocketMessageContainer()
+            {
+                data = Encoding.UTF8.GetBytes(messageToSend),
+                isPong = true
+            };
+
+            if (clientId != null)
+            {
+                return Task.Run(async () => await _WebsocketHandler.SendMessage(message, clientId)).GetAwaiter().GetResult();
+            }
+            return Task.Run(async () => await _WebsocketHandler.SendMessage(message)).GetAwaiter().GetResult();
+        }
+
+        /// <summary>
+        /// Stops a connection with a specific client asynchronous. Can provide reason.
+        /// </summary>
+        /// <param name="clientId">Specific client to close connection with.</param>
+        /// <param name="reason">Possible reason to close the connection.</param>
+        /// <returns>True when succesfully closed.</returns>
+        public async Task<bool> StopClientAsync(string clientId, string reason = "")
+        {
+            if (reason.Length > 0)
+            {
+                return await _WebsocketHandler.StopClient(clientId, reason);
+            }
+            else
+            {
+                return await _WebsocketHandler.StopClient(clientId);
+            }
+        }
+
+        /// <summary>
+        /// Stops a connection with a specific client synchronous. Can provide reason.
+        /// </summary>
+        /// <param name="clientId">Specific client to close connection with.</param>
+        /// <param name="reason">Possible reason to close the connection.</param>
+        /// <returns>True when succesfully closed.</returns>
+        public bool StopClient(string clientId, string reason = "")
+        {
+            if (reason.Length > 0)
+            {
+                return Task.Run(async () => await _WebsocketHandler.StopClient(clientId, reason)).GetAwaiter().GetResult();
+            }
+            else
+            {
+                return Task.Run(async () => await _WebsocketHandler.StopClient(clientId)).GetAwaiter().GetResult();
+            }
+        }
+
+
+        /// <summary>
+        /// Stops all connections with all clients asynchronous. Can provide reason.
+        /// </summary>
+        /// <param name="reason">Possible reason to close the connection.</param>
+        /// <returns>True when succesfully closed.</returns>
+        public async Task<bool> StopAllAsync(string reason = "")
+        {
+            if (reason.Length > 0)
+            {
+                return await _WebsocketHandler.StopAll( reason);
+            }
+            else
+            {
+                return await _WebsocketHandler.StopAll();
+            }
+        }
+
+        /// <summary>
+        /// Stops all connections with all clients synchronous. Can provide reason.
+        /// </summary>
+        /// <param name="reason">Possible reason to close the connection.</param>
+        /// <returns>True when succesfully closed.</returns>
+        public bool StopAll(string reason = "")
+        {
+            if (reason.Length > 0)
+            {
+                return Task.Run(async()=>await _WebsocketHandler.StopAll(reason)).GetAwaiter().GetResult();
+            }
+            else
+            {
+                return Task.Run(async () => await _WebsocketHandler.StopAll()).GetAwaiter().GetResult();
+            }
+        }
+
+    }
+}