Connection streamlining and debugging

- Socket ConnectionStatus is derived from Socket directly
- Bring Logger object into Socket
- Create_Socket is turned into a subroutine; utilizing Events and Exceptions for communication
- Attempted to make AuthLogin failures non-critical
- Removed ReConnect subroutine from UPS_Device
- Additional bits of logging sprinkled everywhere
- Tried implementing Connection event for WinNUT to prevent hanging main thread, needs work
- No longer attempt to connect immediatly at start up
- Breakout UPS connection login into a seperate subroutine
- Tweak disconnection subroutine
- Reconnect menu now disconnects and connects again
- Uncomment part of prefs_changed, now disconnect and connect UPS again.

Author: gbakeman

WinNUT_V2/WinNUT-Client_Common/Common_Classes.vb

@@ -58,7 +58,7 @@ Public Class Nut_Parameter
     ''' <returns></returns>
     Public Overrides Function ToString() As String
         Return String.Format("{0}@{1}:{2}, Name: {3}" & If(AutoReconnect, " [AutoReconnect]", Nothing),
-                             Login, Host, Port, AutoReconnect)
+                             Login, Host, Port, UPSName, AutoReconnect)
         ' Return MyBase.ToString())
     End Function
 End Class

WinNUT_V2/WinNUT-Client_Common/Nut_Socket.vb

@@ -15,6 +15,19 @@ Imports System.IO
 Imports System.Windows.Forms
 
 Public Class Nut_Socket
+#Region "Properties"
+    Public ReadOnly Property ConnectionStatus
+        Get
+            If NutSocket IsNot Nothing Then
+                Return NutSocket.Connected
+            Else
+                Return False
+            End If
+        End Get
+    End Property
+#End Region
+
+    Private LogFile As Logger
     'Socket Variables
     Private NutSocket As Socket
     Private NutTCP As TcpClient
@@ -27,8 +40,6 @@ Public Class Nut_Socket
     Private Nut_Ver As String
     Private Net_Ver As String
 
-    Private ConnectionStatus As Boolean = False
-
     Private Nut_Config As Nut_Parameter
 
     Public Auth_Success As Boolean = False
@@ -44,8 +55,8 @@ Public Class Nut_Socket
     Public Event Socket_Broken()
     Public Event Socket_Deconnected()
 
-    Public Sub New(ByVal Nut_Config As Nut_Parameter)
-
+    Public Sub New(ByVal Nut_Config As Nut_Parameter, ByRef logger As Logger)
+        LogFile = logger
         With Me.WatchDog
             .Interval = 1000
             .Enabled = False
@@ -88,6 +99,7 @@ Public Class Nut_Socket
     Public Sub Update_Config(ByVal New_Nut_Config As Nut_Parameter)
         Me.Nut_Config = New_Nut_Config
     End Sub
+
     Public Function Connect() As Boolean
         Try
             'TODO: Use LIST UPS protocol command to get valid UPSs.
@@ -97,24 +109,26 @@ Public Class Nut_Socket
             Dim Password = Nut_Config.Password
 
             If Not String.IsNullOrEmpty(Host) And Not IsNothing(Port) Then
-                If Not Create_Socket(Host, Port) Then
-                    ' Don't duplicate/override Create_Socket's error throwing functionality.
-                    ' Throw New Nut_Exception(Nut_Exception_Value.CONNECT_ERROR)
-                    Disconnect()
-                Else
-                    If Not AuthLogin(Login, Password) Then
-                        Throw New Nut_Exception(Nut_Exception_Value.INVALID_AUTH_DATA)
-                    End If
+                Create_Socket(Host, Port)
+
+                If ConnectionStatus Then
+                    AuthLogin(Login, Password)
+                    'If Not AuthLogin(Login, Password) Then
+                    '    ' Throw New Nut_Exception(Nut_Exception_Value.INVALID_AUTH_DATA)
+                    '    RaiseEvent OnNUTException()
+                    'End If
                     Dim Nut_Query = Query_Data("VER")
 
                     If Nut_Query.Response = NUTResponse.OK Then
-                        Me.Nut_Ver = (Nut_Query.Data.Split(" "c))(4)
+                        Nut_Ver = (Nut_Query.Data.Split(" "c))(4)
                     End If
                     Nut_Query = Query_Data("NETVER")
 
                     If Nut_Query.Response = NUTResponse.OK Then
-                        Me.Net_Ver = Nut_Query.Data
+                        Net_Ver = Nut_Query.Data
                     End If
+
+                    LogFile.LogTracing(String.Format("NUT server reports VER: {0} NETVER: {1}", Nut_Ver, Net_Ver), LogLvl.LOG_NOTICE, Me)
                     Return True
                 End If
             End If
@@ -131,21 +145,23 @@ Public Class Nut_Socket
         Return False
     End Function
 
-    Private Function Create_Socket(ByVal Host As String, ByVal Port As Integer) As Boolean
+    Private Sub Create_Socket(ByVal Host As String, ByVal Port As Integer)
         Try
             ' NutSocket = New Socket(AddressFamily.InterNetwork, ProtocolType.IP)
             NutSocket = New Socket(SocketType.Stream, ProtocolType.IP)
+            LogFile.LogTracing(String.Format("Attempting TCP socket connection to {0}:{1}...", Host, Port), LogLvl.LOG_NOTICE, Me)
             NutTCP = New TcpClient(Host, Port)
             NutStream = NutTCP.GetStream
             ReaderStream = New StreamReader(NutStream)
             WriterStream = New StreamWriter(NutStream)
-            ConnectionStatus = True
+            ' ConnectionStatus = True
+            LogFile.LogTracing(String.Format("Connection established and streams ready for {0}:{1}", Host, Port), LogLvl.LOG_NOTICE, Me)
         Catch Excep As Exception
+            Disconnect(True)
             RaiseEvent OnNUTException(New Nut_Exception(Nut_Exception_Value.CONNECT_ERROR, Excep.Message), LogLvl.LOG_ERROR, Me)
-            Me.ConnectionStatus = False
         End Try
-        Return Me.ConnectionStatus
-    End Function
+    End Sub
+
     Public Function Query_Data(Query_Msg As String) As (Data As String, Response As NUTResponse)
         Dim Response As NUTResponse = NUTResponse.NORESPONSE
         Dim DataResult As String = ""
@@ -338,9 +354,11 @@ Public Class Nut_Socket
         End Select
         Return Response
     End Function
-    Private Function AuthLogin(ByVal Login As String, ByVal Password As String) As Boolean
+
+    Private Sub AuthLogin(Login As String, Password As String)
         Try
-            Me.Auth_Success = False
+            LogFile.LogTracing("Attempting authentication...", LogLvl.LOG_NOTICE, Me)
+            Auth_Success = False
             If Not String.IsNullOrEmpty(Login) AndAlso String.IsNullOrEmpty(Password) Then
                 Dim Nut_Query = Query_Data("USERNAME " & Login)
 
@@ -366,23 +384,27 @@ Public Class Nut_Socket
                     End If
                 End If
             End If
-            Me.Auth_Success = True
-            Return Me.Auth_Success
+
+            LogFile.LogTracing("Authenticated successfully.", LogLvl.LOG_NOTICE, Me)
+            Auth_Success = True
+            ' Return Me.Auth_Success
+        Catch nutEx As Nut_Exception
+            ' Auth issues aren't necessarily fatal - some interaction can still occur unauthenticated.
+            RaiseEvent OnNUTException(nutEx, LogLvl.LOG_ERROR, Me)
+            ' Auth_Success = False
+            ' Disconnect(True)
         Catch Excep As Exception
             RaiseEvent OnError(Excep, LogLvl.LOG_ERROR, Me)
-            Me.Disconnect()
-            Return False
+            Disconnect(True)
+            ' Auth_Success = False
         End Try
-    End Function
+    End Sub
 
     Private Sub Event_WatchDog(sender As Object, e As EventArgs)
         Dim Nut_Query = Query_Data("")
         If Nut_Query.Response = NUTResponse.NORESPONSE Then
-            Me.ConnectionStatus = False
             Disconnect(True)
             RaiseEvent Socket_Broken()
-        ElseIf Nut_Query.Response = NUTResponse.UNKNOWNCOMMAND Then
-            Me.ConnectionStatus = True
         End If
     End Sub
 
@@ -408,10 +430,15 @@ Public Class Nut_Socket
                 NutSocket.Close()
             End If
         Catch Excep As Exception
+            LogFile.LogTracing("Error encountered while shutting down socket: " & vbNewLine & Excep.ToString(),
+                               LogLvl.LOG_ERROR, Me)
         End Try
-        Me.ConnectionStatus = False
     End Sub
 
+    ''' <summary>
+    ''' Gracefully disconnect the socket from the NUT server.
+    ''' </summary>
+    ''' <param name="ForceDisconnect">Skip raising the <see cref="Socket_Deconnected"/> event if true.</param>
     Public Sub Disconnect(Optional ByVal ForceDisconnect = False)
         Query_Data("LOGOUT")
         Close_Socket()

WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb

@@ -15,7 +15,7 @@ Public Class UPS_Device
     Private ciClone As System.Globalization.CultureInfo
     Private Const CosPhi As Double = 0.6
 
-    Private Nut_Config As Nut_Parameter
+    Public Nut_Config As Nut_Parameter
 
     Public UPS_Datas As New UPS_Datas
     Public WithEvents Nut_Socket As Nut_Socket
@@ -111,7 +111,7 @@ Public Class UPS_Device
         Me.Nut_Config = Nut_Config
         Me.ciClone = CType(CultureInfo.InvariantCulture.Clone(), CultureInfo)
         Me.ciClone.NumberFormat.NumberDecimalSeparator = "."
-        Me.Nut_Socket = New Nut_Socket(Me.Nut_Config)
+        Me.Nut_Socket = New Nut_Socket(Me.Nut_Config, LogFile)
         With Me.Reconnect_Nut
             .Interval = 30000
             .Enabled = False
@@ -123,14 +123,17 @@ Public Class UPS_Device
             AddHandler .Tick, AddressOf Event_WatchDog
         End With
         AddHandler Nut_Socket.Socket_Deconnected, AddressOf Socket_Deconnected
-        Connect_UPS()
+        ' Connect_UPS()
     End Sub
+
     Public Sub Connect_UPS()
-        Dim UPSName = Me.Nut_Config.UPSName
+        ' Dim UPSName = Me.Nut_Config.UPSName
+        LogFile.LogTracing("Beginning connection: " & Nut_Config.ToString(), LogLvl.LOG_DEBUG, Me)
+
         If Me.Nut_Socket.Connect() And Me.Nut_Socket.IsConnected Then
             LogFile.LogTracing("TCP Socket Created", LogLvl.LOG_NOTICE, Me)
             Me.Socket_Status = True
-            If Nut_Socket.IsKnownUPS(UPSName) Then
+            If Nut_Socket.IsKnownUPS(Nut_Config.UPSName) Then
                 Me.UPS_Datas = GetUPSProductInfo()
                 Init_Constant(Nut_Socket)
                 RaiseEvent Connected()
@@ -146,11 +149,13 @@ Public Class UPS_Device
             '    End If
         End If
     End Sub
-    Public Sub ReConnect()
-        If Not Me.IsConnected Then
-            Nut_Socket.Connect()
-        End If
-    End Sub
+
+    'Public Sub ReConnect()
+    '    If Not Me.IsConnected Then
+    '        Nut_Socket.Connect()
+    '    End If
+    'End Sub
+
     Private Function GetUPSProductInfo() As UPS_Datas
         Dim UDatas As New UPS_Datas
         Dim UPSName = Me.Nut_Config.UPSName