Added support for custom Http Headers for Websocket (#22)

Author: Feiko

WebSockets.Client/System.Net.WebSockets.Client.nfproj

@@ -38,6 +38,9 @@
     </Compile>
     <Compile Include="..\WebSockets\ClientWebSocket\ClientWebSocketOptions.cs">
       <Link>ClientWebSocket\ClientWebSocketOptions.cs</Link>
+	</Compile>
+    <Compile Include="..\WebSockets\ClientWebSocket\ClientWebSocketHeaders.cs">
+      <Link>ClientWebSocket\ClientWebSocketHeaders.cs</Link>
     </Compile>
     <Compile Include="..\WebSockets\MessageReceivedEventArgs.cs">
       <Link>MessageReceivedEventArgs.cs</Link>

WebSockets/ClientWebSocket/ClientWebSocket.cs

@@ -111,7 +111,8 @@ public ClientWebSocket(ClientWebSocketOptions options = null) : base(options)
         /// Connect to a WebSocket server.
         /// </summary>
         /// <param name="uri">The URI of the WebSocket server to connect to.</param>
-        public void Connect(string uri)
+        /// <param name="headers">Optional <see cref="ClientWebSocketHeaders"/> for setting custom headers.</param>
+        public void Connect(string uri, ClientWebSocketHeaders headers = null)
         {
             State = WebSocketFrame.WebSocketState.Connecting;
 
@@ -195,7 +196,7 @@ public void Connect(string uri)
                     _networkStream = new NetworkStream(_tcpSocket, true);
                 }
 
-                WebSocketClientConnect(ep, prefix, Host);
+                WebSocketClientConnect(ep, prefix, Host, headers);
             }
             catch (SocketException ex)
             {
@@ -212,15 +213,27 @@ private void WebSocket_ConnectionClosed(object sender, EventArgs e)
             _tcpSocket.Close();
         }
 
-        private void WebSocketClientConnect(IPEndPoint remoteEndPoint, string prefix = "/", string host = null)
+        private void WebSocketClientConnect(IPEndPoint remoteEndPoint, string prefix = "/", string host = null, ClientWebSocketHeaders customHeaders = null)
         {
+            string customHeaderString = string.Empty;
+            if (customHeaders != null)
+            {
+                var headerKeys = customHeaders.Keys;
+                foreach (string key in headerKeys)
+                {
+                    if (!string.IsNullOrEmpty(key))
+                    {
+                        customHeaderString += $"{key}: {customHeaders[key]}\r\n";
+                    }
+                }
+            }
             if (prefix[0] != '/') throw new Exception("websocket prefix has to start with '/'");
 
             byte[] keyBuf = new byte[16];
             new Random().NextBytes(keyBuf);
             string swk = Convert.ToBase64String(keyBuf);
 
-            byte[] sendBuffer = Encoding.UTF8.GetBytes($"GET {prefix} HTTP/1.1\r\nHost: {(host != null ? host : remoteEndPoint.Address.ToString())}\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-WebSocket-Key: {swk}\r\nSec-WebSocket-Version: 13\r\n\r\n");
+            byte[] sendBuffer = Encoding.UTF8.GetBytes($"GET {prefix} HTTP/1.1\r\nHost: {(host != null ? host : remoteEndPoint.Address.ToString())}\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-WebSocket-Key: {swk}\r\nSec-WebSocket-Version: 13\r\n{customHeaderString}\r\n");
             _networkStream.Write(sendBuffer, 0, sendBuffer.Length);
 
             string beginHeader = ($"HTTP/1.1 101".ToLower());

WebSockets/ClientWebSocket/ClientWebSocketHeaders.cs

@@ -0,0 +1,85 @@
+using System;
+using System.Collections;
+using System.Text;
+
+namespace System.Net.WebSockets
+{
+    /// <summary>
+    /// A Dictionary to store custom Http Headers to use with the ClientWebsocket
+    /// </summary>
+    public class ClientWebSocketHeaders
+    {
+        private Hashtable _headers = new Hashtable();
+
+        /// <summary>
+        /// Gets the number of headers.
+        /// </summary>
+        public int Count { get { return _headers.Count; } }
+
+        /// <summary>
+        /// Gets all header keys.
+        /// </summary>
+        public string[] Keys { get { return GetKeys(); } }
+
+        /// <summary>
+        /// Gets all header values.
+        /// </summary>
+        public string[] Values { get { return GetValues(); } }
+
+        /// <summary>
+        /// Gets a value header or Sets a header value
+        /// </summary>
+        public string this[string key]
+        {
+            get
+            {
+                return _headers[key] as string;
+            }
+            set
+            {
+
+                _headers[key] = value;
+                
+            }
+        }
+
+        /// <summary>
+        /// Removes a header from the dictionary
+        /// </summary>
+        public void Remove(string value)
+        {
+            _headers.Remove(value);
+            
+        }
+
+        private string[] GetKeys()
+        {
+            var keys = _headers.Keys;
+            string[] returnkeys = new string[keys.Count];
+
+            int i = 0;
+            foreach (object key in keys)
+            {
+                returnkeys[i] = key as string;
+                i++;
+            }
+
+            return returnkeys;
+        }
+
+        private string[] GetValues()
+        {
+            var values = _headers.Values;
+            string[] returnkeys = new string[values.Count];
+
+            int i = 0;
+            foreach (object value in values)
+            {
+                returnkeys[i] = value as string;
+                i++;
+            }
+
+            return returnkeys;
+        }
+    }
+}

WebSockets/System.Net.WebSockets.nfproj

@@ -33,6 +33,7 @@
   </ItemGroup>
   <Import Project="$(NanoFrameworkProjectSystemPath)NFProjectSystem.props" Condition="Exists('$(NanoFrameworkProjectSystemPath)NFProjectSystem.props')" />
   <ItemGroup>
+    <Compile Include="ClientWebSocket\ClientWebSocketHeaders.cs" />
     <Compile Include="MessageReceivedEventArgs.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="WebSocket.cs" />

WebSockets/WebSocket.cs

@@ -302,9 +302,15 @@ internal void HardClose()
             ConnectionClosed?.Invoke(this, new EventArgs());
 
             //Let the tcp socket linger for a second so it can try and send all data out before final close. 
-            _socket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, 1); 
-            
-            _socket.Close();
+            try
+            {
+                _socket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, 1);
+                _socket.Close();
+            }
+            catch (ObjectDisposedException e)
+            {
+                Debug.WriteLine("socket could not be closed properly because it was already disposed");
+            }
         }
 
         internal bool QueueMessageToSend(SendMessageFrame frame)