Refactoring, event handling

- General code cleanup throughout files

- Refactored Disconnect subroutine in the Socket class; there is no more "silent" operation, and the SocketDisconnected event is always raised regardless of result. We will also avoid trying to log out when not already logged in.
- Added a ToString function to UPS_Device to give the UPSName property. I'm realizing that depending on a valid instance of Nut_Config for any of the properties to successfully return is fairly problematic, so this may necessitate the need to migrate to Nut.Net.
- Made the Disconnect subroutine in UPS_Device the final stop for handling exceptions generated during the procedure. Any communication is raised as events back to a listening client.
- Removed unused Watchdog subroutine

Author: gbakeman

Diff for: WinNUT_V2/WinNUT-Client/WinNUT.vb

@@ -297,6 +297,7 @@ Public Class WinNUT
                                        Arr_Reg_Key.Item("AutoReconnect"))
 
         UPS_Device = New UPS_Device(Nut_Config, LogFile, Arr_Reg_Key.Item("Delay"))
+        AddHandler UPS_Device.EncounteredNUTException, AddressOf HandleNUTException
         UPS_Device.Connect_UPS(retryOnConnFailure)
     End Sub
 
@@ -331,15 +332,16 @@ Public Class WinNUT
     End Sub
 
     ''' <summary>
-    ''' Prepare application for and handle disconnecting from the UPS.
+    ''' Prepare application for and initiate disconnecting from the UPS.
     ''' </summary>
-    Private Sub UPSDisconnect() ' Handles UPS_Device.Disconnected
-        ' LogFile.LogTracing("Running Client disconnect subroutine.", LogLvl.LOG_DEBUG, Me)
+    Private Sub UPSDisconnect()
+        LogFile.LogTracing("Running Client disconnect subroutine.", LogLvl.LOG_DEBUG, Me)
 
         If UPS_Device IsNot Nothing Then
             UPS_Device.Disconnect(True)
+            RemoveHandler UPS_Device.EncounteredNUTException, AddressOf HandleNUTException
         Else
-            LogFile.LogTracing("Attempted to disconnect when UPS_Device is Nothing.", LogLvl.LOG_DEBUG, Me)
+            LogFile.LogTracing("Attempted to disconnect when UPS_Device is Nothing.", LogLvl.LOG_ERROR, Me)
         End If
     End Sub
 
@@ -415,18 +417,14 @@ Public Class WinNUT
             NotifyIcon.Visible = True
             e.Cancel = True
         Else
-            ' TODO: Common shutdown subroutine? --v
             LogFile.LogTracing("Init Disconnecting Before Close WinNut", LogLvl.LOG_DEBUG, Me)
-            RemoveHandler Microsoft.Win32.SystemEvents.PowerModeChanged, AddressOf SystemEvents_PowerModeChanged
             UPSDisconnect()
-            LogFile.LogTracing("WinNut Is now Closed", LogLvl.LOG_DEBUG, Me)
-            End
         End If
     End Sub
 
     Private Sub Menu_Quit_Click_1(sender As Object, e As EventArgs) Handles Menu_Quit.Click
         LogFile.LogTracing("Close WinNut From Menu Quit", LogLvl.LOG_DEBUG, Me)
-        End
+        Application.Exit()
     End Sub
 
     Private Sub Menu_Settings_Click(sender As Object, e As EventArgs) Handles Menu_Settings.Click
@@ -439,7 +437,7 @@ Public Class WinNUT
 
     Private Sub Menu_Sys_Exit_Click(sender As Object, e As EventArgs) Handles Menu_Sys_Exit.Click
         LogFile.LogTracing("Close WinNut From Systray", LogLvl.LOG_DEBUG, Me)
-        End
+        Application.Exit()
     End Sub
 
     Private Sub Menu_Sys_Settings_Click(sender As Object, e As EventArgs) Handles Menu_Sys_Settings.Click
@@ -572,11 +570,12 @@ Public Class WinNUT
         LogFile.LogTracing("Battery Status => " & Status, LogLvl.LOG_DEBUG, Me)
     End Sub
 
-    Sub HandleNUTException(ex As NutException, sender As Object) Handles UPS_Device.EncounteredNUTException
+    Private Sub HandleNUTException(sender As UPS_Device, ex As NutException)
         If ex.LastTransaction.ResponseType = NUTResponse.UNKNOWNUPS Then
             Event_Unknown_UPS()
         End If
 
+        LogFile.LogTracing("NUT protocol error encoutnered:" + vbNewLine + ex.ToString(), LogLvl.LOG_NOTICE, sender)
     End Sub
 
     Public Sub Event_Unknown_UPS() ' Handles UPS_Device.Unknown_UPS

Diff for: WinNUT_V2/WinNUT-Client_Common/Nut_Socket.vb

@@ -10,8 +10,8 @@
 
 
 ' Class dealing only with the management of the communication socket with the Nut server
-Imports System.Net.Sockets
 Imports System.IO
+Imports System.Net.Sockets
 
 Public Class Nut_Socket
 
@@ -79,12 +79,6 @@ Public Class Nut_Socket
     Public Sub New(Nut_Config As Nut_Parameter, ByRef logger As Logger)
         LogFile = logger
         NutConfig = Nut_Config
-
-        'With Me.WatchDog
-        '    .Interval = 1000
-        '    .Enabled = False
-        '    AddHandler .Tick, AddressOf Event_WatchDog
-        'End With
     End Sub
 
     Public Sub Connect()
@@ -111,7 +105,7 @@ Public Class Nut_Socket
 
             ' Something went wrong - cleanup and pass along error.
         Catch Excep As Exception
-            Disconnect(True, True)
+            Disconnect(True)
             Throw ' Pass exception on up to UPS
         End Try
 
@@ -167,19 +161,15 @@ Public Class Nut_Socket
     ''' <summary>
     ''' Perform various functions necessary to disconnect the socket from the NUT server.
     ''' </summary>
-    ''' <param name="Silent">Skip raising the <see cref="SocketDisconnected"/> event if true.</param>
     ''' <param name="Forceful">Skip sending the LOGOUT command to the NUT server. Unknown effects.</param>
-    Public Sub Disconnect(Optional silent = False, Optional forceful = False)
-        ' WatchDog.Stop()
-
-        If IsConnected AndAlso Not forceful Then
-            Query_Data("LOGOUT")
-        End If
-
-        Close_Socket()
-
-        If Not silent Then
-            RaiseEvent SocketDisconnected()
+    Public Sub Disconnect(Optional forceful = False)
+        If Not forceful AndAlso IsConnected AndAlso IsLoggedIn Then
+            Try
+                Query_Data("LOGOUT")
+            Finally
+                Close_Socket()
+                RaiseEvent SocketDisconnected()
+            End Try
         End If
     End Sub
 
@@ -391,7 +381,7 @@ Public Class Nut_Socket
     Private Sub Event_WatchDog(sender As Object, e As EventArgs)
         Dim Nut_Query = Query_Data("")
         If Nut_Query.ResponseType = NUTResponse.NORESPONSE Then
-            Disconnect(True, True)
+            Disconnect(True)
             RaiseEvent Socket_Broken(New NutException(Nut_Query))
         End If
     End Sub

Diff for: WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb

@@ -15,13 +15,17 @@ Public Class UPS_Device
 
     Public ReadOnly Property Name As String
         Get
-            Return Nut_Config.UPSName
+            If Nut_Config IsNot Nothing Then
+                Return Nut_Config.UPSName
+            Else
+                Return "null"
+            End If
         End Get
     End Property
 
     Public ReadOnly Property IsConnected As Boolean
         Get
-            Return (Nut_Socket.IsConnected) ' And Me.Socket_Status
+            Return (Nut_Socket.IsConnected)
         End Get
     End Property
 
@@ -74,11 +78,18 @@ Public Class UPS_Device
     Public Event Lost_Connect()
     ' Error encountered when trying to connect.
     Public Event ConnectionError(sender As UPS_Device, innerException As Exception)
-    Public Event EncounteredNUTException(ex As NutException, sender As Object)
     Public Event New_Retry()
     ' Public Event Shutdown_Condition()
     ' Public Event Stop_Shutdown()
 
+    ''' <summary>
+    ''' Raised when the NUT server returns an error during normal communication and is deemed important for the client
+    ''' application to know.
+    ''' </summary>
+    ''' <param name="sender">The device object that has received the error.</param>
+    ''' <param name="nutEx">An exception detailing the error and cirucmstances surrounding it.</param>
+    Public Event EncounteredNUTException(sender As UPS_Device, nutEx As NutException)
+
 #End Region
 
     Private Const CosPhi As Double = 0.6
@@ -124,13 +135,7 @@ Public Class UPS_Device
         With Reconnect_Nut
             .Interval = DEFAULT_RECONNECT_WAIT_MS
             .Enabled = False
-            ' AddHandler .Tick, AddressOf Reconnect_Socket
         End With
-        'With WatchDog
-        '    .Interval = 1000
-        '    .Enabled = False
-        '    AddHandler .Tick, AddressOf Event_WatchDog
-        'End With
     End Sub
 
     Public Sub Connect_UPS(Optional retryOnConnFailure = False)
@@ -144,7 +149,7 @@ Public Class UPS_Device
             RaiseEvent Connected(Me)
         Catch ex As NutException
             ' This is how we determine if we have a valid UPS name entered, among other errors.
-            RaiseEvent EncounteredNUTException(ex, Me)
+            RaiseEvent EncounteredNUTException(Me, ex)
 
         Catch ex As Exception
             RaiseEvent ConnectionError(Me, ex)
@@ -156,33 +161,23 @@ Public Class UPS_Device
         End Try
     End Sub
 
-    'Private Sub HandleDisconnectRequest(sender As Object, Optional cancelAutoReconnect As Boolean = True) Handles Me.RequestDisconnect
-    '    If disconnectInProgress Then
-    '        Throw New InvalidOperationException("Disconnection already in progress.")
-    '    End If
-
-    '    ' WatchDog.Stop()
-
-    '    If cancelAutoReconnect And Reconnect_Nut.Enabled = True Then
-    '        Debug.WriteLine("Cancelling ")
-    '    End If
-    'End Sub
-
-    Public Sub Disconnect(Optional cancelReconnect As Boolean = True, Optional silent As Boolean = False, Optional forceful As Boolean = False)
+    Public Sub Disconnect(Optional cancelReconnect As Boolean = True, Optional forceful As Boolean = False)
         LogFile.LogTracing("Processing request to disconnect...", LogLvl.LOG_DEBUG, Me)
-        ' WatchDog.Stop()
+
         Update_Data.Stop()
         If cancelReconnect And Reconnect_Nut.Enabled Then
             LogFile.LogTracing("Stopping Reconnect timer.", LogLvl.LOG_DEBUG, Me)
             Reconnect_Nut.Stop()
         End If
 
         Retry = 0
-        Nut_Socket.Disconnect(silent, forceful)
-        ' Confirmation of disconnection will come from raised Disconnected event.
-
-        'LogFile.LogTracing("Completed disconnecting UPS, notifying listeners.", LogLvl.LOG_DEBUG, Me)
-        'RaiseEvent Disconnected()
+        Try
+            Nut_Socket.Disconnect(forceful)
+        Catch nutEx As NutException
+            RaiseEvent EncounteredNUTException(Me, nutEx)
+        Finally
+            RaiseEvent Disconnected()
+        End Try
     End Sub
 
 #Region "Socket Interaction"
@@ -193,29 +188,8 @@ Public Class UPS_Device
         RaiseEvent Disconnected()
     End Sub
 
-    ''' <summary>
-    ''' Check underlying connection for an error state by sending an empty query to the server.
-    ''' A watchdog may not actually be necessary under normal circumstances, since queries are regularly being sent to
-    ''' the NUT server and will catch a broken socket that way.
-    ''' </summary>
-    ''' <param name="sender"></param>
-    ''' <param name="e"></param>
-    Private Sub Event_WatchDog(sender As Object, e As EventArgs)
-        If IsConnected Then
-            Dim Nut_Query = Nut_Socket.Query_Data("")
-            If Nut_Query.ResponseType = NUTResponse.NORESPONSE Then
-                LogFile.LogTracing("WatchDog Socket report a Broken State", LogLvl.LOG_WARNING, Me)
-                Nut_Socket.Disconnect(True)
-                RaiseEvent Lost_Connect()
-                ' Me.Socket_Status = False
-            End If
-        End If
-    End Sub
-
     Private Sub Socket_Broken() Handles Nut_Socket.Socket_Broken
-        ' LogFile.LogTracing("TCP Socket seems Broken", LogLvl.LOG_WARNING, Me)
         LogFile.LogTracing("Socket has reported a Broken event.", LogLvl.LOG_WARNING, Me)
-        ' SocketDisconnected()
         RaiseEvent Lost_Connect()
 
         If Nut_Config.AutoReconnect Then
@@ -228,7 +202,7 @@ Public Class UPS_Device
         Retry += 1
         If Retry <= MaxRetry Then
             RaiseEvent New_Retry()
-            LogFile.LogTracing(String.Format("Try Reconnect {0} / {1}", Retry, MaxRetry), LogLvl.LOG_NOTICE, Me, String.Format(WinNUT_Globals.StrLog.Item(AppResxStr.STR_LOG_NEW_RETRY), Retry, MaxRetry))
+            LogFile.LogTracing(String.Format("Try Reconnect {0} / {1}", Retry, MaxRetry), LogLvl.LOG_NOTICE, Me, String.Format(StrLog.Item(AppResxStr.STR_LOG_NEW_RETRY), Retry, MaxRetry))
             Connect_UPS()
             If IsConnected Then
                 LogFile.LogTracing("Nut Host Reconnected", LogLvl.LOG_DEBUG, Me)
@@ -237,9 +211,7 @@ Public Class UPS_Device
                 RaiseEvent ReConnected(Me)
             End If
         Else
-            LogFile.LogTracing("Max Retry reached. Stop Process Autoreconnect and wait for manual Reconnection", LogLvl.LOG_ERROR, Me, WinNUT_Globals.StrLog.Item(AppResxStr.STR_LOG_STOP_RETRY))
-            'Reconnect_Nut.Stop()
-            'RaiseEvent Disconnected()
+            LogFile.LogTracing("Max Retry reached. Stop Process Autoreconnect and wait for manual Reconnection", LogLvl.LOG_ERROR, Me, StrLog.Item(AppResxStr.STR_LOG_STOP_RETRY))
             Disconnect(True)
         End If
     End Sub
@@ -259,7 +231,7 @@ Public Class UPS_Device
 
         ' Other constant values for UPS calibration.
         freshData.UPS_Value.Batt_Capacity = Double.Parse(GetUPSVar("battery.capacity", 7), ciClone)
-        Freq_Fallback = Double.Parse(GetUPSVar("output.frequency.nominal", (50 + CInt(WinNUT_Params.Arr_Reg_Key.Item("FrequencySupply")) * 10)), ciClone)
+        Freq_Fallback = Double.Parse(GetUPSVar("output.frequency.nominal", (50 + CInt(Arr_Reg_Key.Item("FrequencySupply")) * 10)), ciClone)
 
         Return freshData
     End Function
@@ -340,10 +312,8 @@ Public Class UPS_Device
         Catch Excep As Exception
             ' Something went wrong while trying to read the data... Consider the socket broken and proceed from here.
             LogFile.LogTracing("Something went wrong in Retrieve_UPS_Datas: " & Excep.ToString(), LogLvl.LOG_ERROR, Me)
-            Disconnect(False, True, True)
+            Disconnect(False, True)
             Socket_Broken()
-            'Me.Disconnect(True)
-            'Enter_Reconnect_Process(Excep, "Error When Retrieve_UPS_Data : ")
         End Try
     End Sub
 
@@ -435,4 +405,8 @@ Public Class UPS_Device
         End Try
         Return StringArray(StringArray.Length - 1)
     End Function
+
+    Public Overrides Function ToString() As String
+        Return Name
+    End Function
 End Class