- Moving _Socket and _Parameter variables into their proper classes for proper OOP

- Disabled auto-connecting to UPS on first start since it locks the GUI thread on a slow connection
- Cleaned up UPS_Connect subroutine for readability, improved log messages, and add a handler for lost_connection events
- Cleaned up UPSDisconnect function: Handlers removed, modified to be reactive in the UI rather than controlling the backend
- Disallowed changing config on the fly from external sources (a Nut_Socket object instead could be considered immutable, and must be destroyed if needing to change settings. Hopefully prevents unexpected bugs)
- Add a dedicated disconnect subroutine to the Socket class.
- Fixed underlying socket not being connected
- Removed dedicated ConnectionStatus variable; not quite sure what its purpose was (might regret this...)
- Made UPS_Device the dedicated object for handling connection monitoring logic (was competing with _Socket before)

Author: gbakeman

WinNUT_V2/WinNUT-Client_Common/Common_Classes.vb

@@ -52,6 +52,16 @@ Public Class Nut_Parameter
     Public UPSName As String = ""
     Public AutoReconnect As Boolean = False
 
+    Public Sub New(Host As String, Port As Integer, Login As String, Password As String, UPSName As String,
+                   Optional AutoReconnect As Boolean = False)
+        Me.Host = Host
+        Me.Port = Port
+        Me.Login = Login
+        Me.Password = Password
+        Me.UPSName = UPSName
+        Me.AutoReconnect = AutoReconnect
+    End Sub
+
     ''' <summary>
     ''' Generate an informative String representing this Parameter object. Note password is not printed.
     ''' </summary>

WinNUT_V2/WinNUT-Client_Common/Nut_Socket.vb

@@ -15,8 +15,10 @@ Imports System.IO
 Imports System.Windows.Forms
 
 Public Class Nut_Socket
+
 #Region "Properties"
-    Public ReadOnly Property ConnectionStatus
+
+    Public ReadOnly Property ConnectionStatus As Boolean
         Get
             If NutSocket IsNot Nothing Then
                 Return NutSocket.Connected
@@ -25,6 +27,7 @@ Public Class Nut_Socket
             End If
         End Get
     End Property
+
 #End Region
 
     Private LogFile As Logger
@@ -36,12 +39,11 @@ Public Class Nut_Socket
     Private WriterStream As StreamWriter
 
     Private Nut_Parameter As Nut_Parameter
+    Private NutConfig As Nut_Parameter
 
     Private Nut_Ver As String
     Private Net_Ver As String
 
-    Private Nut_Config As Nut_Parameter
-
     Public Auth_Success As Boolean = False
     Private ReadOnly WatchDog As New Timer
 
@@ -53,16 +55,21 @@ Public Class Nut_Socket
 
     Public Event Unknown_UPS()
     Public Event Socket_Broken()
-    Public Event Socket_Deconnected()
 
-    Public Sub New(ByVal Nut_Config As Nut_Parameter, ByRef logger As Logger)
+    ''' <summary>
+    ''' Socket was disconnected as a part of normal operations.
+    ''' </summary>
+    Public Event SocketDisconnected()
+
+    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
-        Update_Config(Nut_Config)
     End Sub
     Public ReadOnly Property IsConnected() As Boolean
         Get
@@ -96,17 +103,17 @@ Public Class Nut_Socket
             End If
         End Get
     End Property
-    Public Sub Update_Config(ByVal New_Nut_Config As Nut_Parameter)
-        Me.Nut_Config = New_Nut_Config
-    End Sub
+    'Public Sub Update_Config(ByVal New_Nut_Config As Nut_Parameter)
+    '    Me.NutConfig = New_Nut_Config
+    'End Sub
 
     Public Function Connect() As Boolean
         Try
             'TODO: Use LIST UPS protocol command to get valid UPSs.
-            Dim Host = Nut_Config.Host
-            Dim Port = Nut_Config.Port
-            Dim Login = Nut_Config.Login
-            Dim Password = Nut_Config.Password
+            Dim Host = NutConfig.Host
+            Dim Port = NutConfig.Port
+            Dim Login = NutConfig.Login
+            Dim Password = NutConfig.Password
 
             If Not String.IsNullOrEmpty(Host) And Not IsNothing(Port) Then
                 Create_Socket(Host, Port)
@@ -145,16 +152,30 @@ Public Class Nut_Socket
         Return False
     End Function
 
-    Private Sub Create_Socket(ByVal Host As String, ByVal Port As Integer)
+    ''' <summary>
+    ''' Gracefully disconnect the socket from the NUT server.
+    ''' </summary>
+    ''' <param name="Silent">Skip raising the <see cref="SocketDisconnected"/> event if true.</param>
+    Public Sub Disconnect(Optional Silent = False)
+        WatchDog.Stop()
+        Query_Data("LOGOUT")
+        Close_Socket()
+
+        If Not Silent Then
+            RaiseEvent SocketDisconnected()
+        End If
+    End Sub
+
+    Private Sub Create_Socket(Host As String, 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)
+            NutSocket.Connect(Host, Port)
             NutTCP = New TcpClient(Host, Port)
             NutStream = NutTCP.GetStream
             ReaderStream = New StreamReader(NutStream)
             WriterStream = New StreamWriter(NutStream)
-            ' 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)
@@ -191,7 +212,7 @@ Public Class Nut_Socket
                 RaiseEvent Socket_Broken()
                 Throw New Nut_Exception(Nut_Exception_Value.SOCKET_BROKEN, VarName)
             Else
-                Dim Nut_Query = Query_Data("GET DESC " & Me.Nut_Config.UPSName & " " & VarName)
+                Dim Nut_Query = Query_Data("GET DESC " & Me.NutConfig.UPSName & " " & VarName)
                 Select Case Nut_Query.Response
                     Case NUTResponse.OK
                         'LogFile.LogTracing("Process Result With " & VarName & " : " & Nut_Query.Data, LogLvl.LOG_DEBUG, Me)
@@ -434,17 +455,4 @@ Public Class Nut_Socket
                                LogLvl.LOG_ERROR, Me)
         End Try
     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()
-        Me.WatchDog.Stop()
-        If Not ForceDisconnect Then
-            RaiseEvent Socket_Deconnected()
-        End If
-    End Sub
 End Class

WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb

@@ -12,7 +12,7 @@ Public Class UPS_Device
     'Private Nut_Conn As Nut_Comm
     ' Private LogFile As Logger
     Private Freq_Fallback As Double
-    Private ciClone As System.Globalization.CultureInfo
+    Private ciClone As CultureInfo
     Private Const CosPhi As Double = 0.6
 
     Public Nut_Config As Nut_Parameter
@@ -23,8 +23,10 @@ Public Class UPS_Device
     Public Retry As Integer = 0
     Public MaxRetry As Integer = 30
     Private ReadOnly Reconnect_Nut As New System.Windows.Forms.Timer
+
     Private ReadOnly WatchDog As New System.Windows.Forms.Timer
-    Private Socket_Status As Boolean = False
+
+    Private keepConnection As Boolean = False
 
 
     Private LogFile As Logger
@@ -84,7 +86,7 @@ Public Class UPS_Device
 
     Public ReadOnly Property IsConnected() As Boolean
         Get
-            Return (Me.Nut_Socket.IsConnected And Me.Socket_Status)
+            Return (Me.Nut_Socket.IsConnected) ' And Me.keepConnection
         End Get
     End Property
 
@@ -101,7 +103,7 @@ Public Class UPS_Device
                 LogFile.LogTracing("WatchDog Socket report a Broken State", LogLvl.LOG_WARNING, Me)
                 Nut_Socket.Disconnect(True)
                 RaiseEvent Lost_Connect()
-                Me.Socket_Status = False
+                keepConnection = False
             End If
         End If
     End Sub
@@ -122,7 +124,7 @@ Public Class UPS_Device
             .Enabled = False
             AddHandler .Tick, AddressOf Event_WatchDog
         End With
-        AddHandler Nut_Socket.Socket_Deconnected, AddressOf Socket_Deconnected
+        AddHandler Nut_Socket.SocketDisconnected, AddressOf Socket_Deconnected
         ' Connect_UPS()
     End Sub
 
@@ -131,8 +133,8 @@ Public Class UPS_Device
         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
+            ' LogFile.LogTracing("TCP Socket Created", LogLvl.LOG_NOTICE, Me)
+            keepConnection = True
             If Nut_Socket.IsKnownUPS(Nut_Config.UPSName) Then
                 Me.UPS_Datas = GetUPSProductInfo()
                 Init_Constant(Nut_Socket)
@@ -141,11 +143,11 @@ Public Class UPS_Device
                 LogFile.LogTracing("Given UPS Name is unknown", LogLvl.LOG_NOTICE, Me)
                 RaiseEvent Unknown_UPS()
             End If
-            Me.WatchDog.Start()
+            WatchDog.Start()
             'Else
             '    If Not Reconnect_Nut.Enabled Then
             '        RaiseEvent Lost_Connect()
-            '        Me.Socket_Status = False
+            '        Me.keepConnection = False
             '    End If
         End If
     End Sub
@@ -156,6 +158,10 @@ Public Class UPS_Device
     '    End If
     'End Sub
 
+    Public Sub Disconnect()
+
+    End Sub
+
     Private Function GetUPSProductInfo() As UPS_Datas
         Dim UDatas As New UPS_Datas
         Dim UPSName = Me.Nut_Config.UPSName
@@ -377,13 +383,13 @@ Public Class UPS_Device
         Return StringArray(StringArray.Length - 1)
     End Function
 
-    Private Sub Socket_Deconnected()
+    Private Sub Socket_Deconnected() Handles Nut_Socket.SocketDisconnected
         WatchDog.Stop()
-        LogFile.LogTracing("TCP Socket Deconnected", LogLvl.LOG_WARNING, Me)
-        If Not Me.Socket_Status Then
+        LogFile.LogTracing("TCP Socket Deconnected", LogLvl.LOG_NOTICE, Me)
+        If Not IsConnected And keepConnection Then
             RaiseEvent Lost_Connect()
         End If
-        Me.Socket_Status = False
+        ' Me.keepConnection = False
         If Me.Nut_Config.AutoReconnect Then
             LogFile.LogTracing("Reconnection Process Started", LogLvl.LOG_NOTICE, Me)
             Reconnect_Nut.Enabled = True
@@ -395,6 +401,7 @@ Public Class UPS_Device
         LogFile.LogTracing("TCP Socket seems Broken", LogLvl.LOG_WARNING, Me)
         Socket_Deconnected()
     End Sub
+
     Private Sub Reconnect_Socket(sender As Object, e As EventArgs)
         Me.Retry += 1
         If Me.Retry <= Me.MaxRetry Then

WinNUT_V2/WinNUT_GUI/List_Var_Gui.vb

@@ -8,13 +8,11 @@
 ' This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY
 
 Imports WinNUT_Client_Common
-Imports System.Threading
-Imports System.ComponentModel
 
 Public Class List_Var_Gui
     Private List_Var_Datas As List(Of UPS_List_Datas)
     Private LogFile As Logger
-    Private UPS_Name = WinNUT.Nut_Config.UPSName
+    Private UPS_Name = WinNUT.UPS_Device.Nut_Config.UPSName
     Private Sub List_Var_Gui_Load(sender As Object, e As EventArgs) Handles MyBase.Load
         ' Me.LogFile = WinNUT.LogFile
         LogFile.LogTracing("Load List Var Gui", LogLvl.LOG_DEBUG, Me)