Refactor to Connect and ConnectAsync

Author: acupofjose

Realtime/Client.cs

@@ -130,9 +130,11 @@ public static Client Initialize(string realtimeUrl, ClientOptions options = null
 
         /// <summary>
         /// Attempts to connect to the socket given the params specified in `Initialize`
+        ///
+        /// Returns when socket has successfully connected.
         /// </summary>
         /// <returns></returns>
-        public Task<Client> Connect()
+        public Task<Client> ConnectAsync()
         {
             var tsc = new TaskCompletionSource<Client>();
 
@@ -180,6 +182,48 @@ public Task<Client> Connect()
             return tsc.Task;
         }
 
+        /// <summary>
+        /// Attempts to connect to the socket given the params specified in `Initialize`
+        ///
+        /// Provides a callback for `Task` driven returns.
+        /// </summary>
+        /// <param name="callback"></param>
+        /// <returns></returns>
+        public Client Connect(Action<Client> callback = null)
+        {
+            if (Socket != null)
+            {
+                Debug.WriteLine("Socket already exists.");
+                return this;
+            }
+
+            EventHandler<SocketStateChangedEventArgs> cb = null;
+            cb = (object sender, SocketStateChangedEventArgs args) =>
+            {
+                switch (args.State)
+                {
+                    case SocketStateChangedEventArgs.ConnectionState.Open:
+                        Socket.StateChanged -= cb;
+                        callback?.Invoke(this);
+                        break;
+                    case SocketStateChangedEventArgs.ConnectionState.Close:
+                    case SocketStateChangedEventArgs.ConnectionState.Error:
+                        Socket.StateChanged -= cb;
+                        throw new Exception("Error occurred connecting to Socket. Check logs.");
+                }
+            };
+
+            Socket = new Socket(realtimeUrl, Options);
+
+            Socket.StateChanged += HandleSocketStateChanged;
+            Socket.OnMessage += HandleSocketMessage;
+
+            Socket.StateChanged += cb;
+            Socket.Connect();
+
+            return this;
+        }
+
         /// <summary>
         /// Disconnects from the socket server (if connected).
         /// </summary>
@@ -188,22 +232,14 @@ public Task<Client> Connect()
         /// <returns></returns>
         public Client Disconnect(CloseStatusCode code = WebSocketSharp.CloseStatusCode.Normal, string reason = "Programmatic Disconnect")
         {
-            try
-            {
-                if (Socket != null)
-                {
-                    Socket.StateChanged -= HandleSocketStateChanged;
-                    Socket.OnMessage -= HandleSocketMessage;
-                    Socket.Disconnect(code, reason);
-                    Socket = null;
-                }
-                return this;
-            }
-            catch (Exception ex)
+            if (Socket != null)
             {
-                Debug.WriteLine($"Failed to disconnect socket.");
-                throw ex;
+                Socket.StateChanged -= HandleSocketStateChanged;
+                Socket.OnMessage -= HandleSocketMessage;
+                Socket.Disconnect(code, reason);
+                Socket = null;
             }
+            return this;
         }
 
         /// <summary>

Realtime/Socket.cs

@@ -86,30 +86,22 @@ public void Connect()
         {
             if (connection != null && connection.IsAlive) return;
 
-            try
+            if (connection == null)
             {
-                if (connection == null)
-                {
-                    connection = new WebSocket(endpointUrl);
-
-                    if (endpointUrl.Contains("wss"))
-                        connection.SslConfiguration.EnabledSslProtocols = SslProtocols.Tls11 | SslProtocols.Tls12;
+                connection = new WebSocket(endpointUrl);
 
-                    connection.EnableRedirection = true;
-                    connection.WaitTime = options.LongPollerTimeout;
-                    connection.OnOpen += OnConnectionOpened;
-                    connection.OnMessage += OnConnectionMessage;
-                    connection.OnError += OnConnectionError;
-                    connection.OnClose += OnConnectionClosed;
-                }
+                if (endpointUrl.Contains("wss"))
+                    connection.SslConfiguration.EnabledSslProtocols = SslProtocols.Tls11 | SslProtocols.Tls12;
 
-                connection.Connect();
-            }
-            catch (Exception ex)
-            {
-                Debug.WriteLine(ex.Message);
-                throw ex;
+                connection.EnableRedirection = true;
+                connection.WaitTime = options.LongPollerTimeout;
+                connection.OnOpen += OnConnectionOpened;
+                connection.OnMessage += OnConnectionMessage;
+                connection.OnError += OnConnectionError;
+                connection.OnClose += OnConnectionClosed;
             }
+
+            connection.Connect();
         }
 
         /// <summary>
@@ -209,7 +201,7 @@ private void OnConnectionMessage(object sender, MessageEventArgs args)
         {
             options.Decode(args.Data, decoded =>
             {
-                options.Logger("receive", $"{decoded.Payload} {decoded.Topic} {decoded.Event} ({decoded.Ref})", null);
+                options.Logger("receive", $"{args.Data} {decoded.Topic} {decoded.Event} ({decoded.Ref})", null);
 
                 // Ignore sending heartbeat event to `OnMessage` handler 
                 if (decoded.Ref == pendingHeartbeatRef) return;

RealtimeExample/Program.cs

@@ -19,7 +19,7 @@ static async Task Main(string[] args)
             realtimeClient.OnClose += (s, args) => Console.WriteLine("CLOSED");
             realtimeClient.OnError += (s, args) => Console.WriteLine("ERROR");
 
-            await realtimeClient.Connect();
+            await realtimeClient.ConnectAsync();
 
             // Subscribe to a channel and events
             var channelUsers = realtimeClient.Channel("realtime", "public", "users");

RealtimeTests/API.cs

@@ -28,7 +28,7 @@ public API()
         [TestInitialize]
         public async Task InitializeTest()
         {
-            await SocketClient.Connect();
+            await SocketClient.ConnectAsync();
         }
 
         [TestCleanup]