Changeset 1132 for trunk/sources/HeuristicLab.Hive.Client.Core

Timestamp:

01/15/09 14:46:57 (15 years ago)

Author:

kgrading

Message:

added licence information and comments (#467)

Location:

trunk/sources/HeuristicLab.Hive.Client.Core

Files:

• ClientConsoleService/ClientConsoleCommunicator.cs (modified) (1 diff)
• ClientConsoleService/Interfaces/IClientConsoleCommunicator.cs (modified) (2 diffs)
• ClientConsoleService/TransferObjects/ConnectionContainer.cs (modified) (1 diff)
• ClientConsoleService/TransferObjects/JobStatus.cs (modified) (2 diffs)
• ClientConsoleService/TransferObjects/StatusCommons.cs (modified) (2 diffs)
• ConfigurationManager/ConfigManager.cs (modified) (5 diffs)
• Core.cs (modified) (7 diffs)

trunk/sources/HeuristicLab.Hive.Client.Core/ClientConsoleService/ClientConsoleCommunicator.cs

@@ -17 +17 @@
         return ConfigManager.Instance.GetStatusForClientConsole();
       }
-    }
-
-    public ConnectionContainer GetConnection() {
-      return new ConnectionContainer{IPAdress = WcfService.Instance.ServerIP, Port = WcfService.Instance.ServerPort } ;
     }
 

trunk/sources/HeuristicLab.Hive.Client.Core/ClientConsoleService/Interfaces/IClientConsoleCommunicator.cs

@@ -1 @@
-using System;
+#region License Information
+/* HeuristicLab
+ * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
+ *
+ * This file is part of HeuristicLab.
+ *
+ * HeuristicLab is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * HeuristicLab is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
+ */
+#endregion
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -6 +27 @@
 
 namespace HeuristicLab.Hive.Client.Core.ClientConsoleService.Interfaces {
+  /// <summary>
+  /// Defines the interfaces for the Client Console
+  /// </summary>
   [ServiceContract]
   public interface IClientConsoleCommunicator {
+    /// <summary>
+    /// Gets all status information concerning the client Service
+    /// </summary>
+    /// <returns>the StatusCommons Object, filled with the client details</returns>
     [OperationContract]
     StatusCommons GetStatusInfos();
-    [OperationContract]
-    ConnectionContainer GetConnection();
+    /// <summary>
+    /// Set the connection settings in the wcfService
+    /// </summary>
+    /// <param name="container">the container with the connection details</param>
     [OperationContract]
     void SetConnection(ConnectionContainer container);
+    /// <summary>
+    /// Signals the client to disconnect from the server
+    /// </summary>
     [OperationContract]
     void Disconnect();
+    /// <summary>
+    /// Get the current connection details
+    /// </summary>
+    /// <returns>the ConnectionContainer Object</returns>
     [OperationContract]
     ConnectionContainer GetCurrentConnection();
+    /// <summary>
+    /// Signals the client to exit all jobs and shutdown
+    /// </summary>
     [OperationContract]
     void ShutdownClient();

trunk/sources/HeuristicLab.Hive.Client.Core/ClientConsoleService/TransferObjects/ConnectionContainer.cs

@@ -1 @@
-using System;
+#region License Information
+/* HeuristicLab
+ * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
+ *
+ * This file is part of HeuristicLab.
+ *
+ * HeuristicLab is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * HeuristicLab is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
+ */
+#endregion
+
+using System;
 using System.Collections.Generic;
 using System.Linq;

trunk/sources/HeuristicLab.Hive.Client.Core/ClientConsoleService/TransferObjects/JobStatus.cs

@@ -1 @@
-using System;
+#region License Information
+/* HeuristicLab
+ * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
+ *
+ * This file is part of HeuristicLab.
+ *
+ * HeuristicLab is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * HeuristicLab is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
+ */
+#endregion
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -8 +29 @@
   [DataContract]
   public class JobStatus {
+    /// <summary>
+    /// Id of the Job
+    /// </summary>
     [DataMember]
     public long JobId { get; set; }
+    /// <summary>
+    /// When has the calculation of the Job begun?
+    /// </summary>
     [DataMember]
     public DateTime Since { get; set; }
+    /// <summary>
+    /// Current progress
+    /// </summary>
     [DataMember]
     public double Progress { get; set; }

trunk/sources/HeuristicLab.Hive.Client.Core/ClientConsoleService/TransferObjects/StatusCommons.cs

@@ -1 @@
-using System;
+#region License Information
+/* HeuristicLab
+ * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
+ *
+ * This file is part of HeuristicLab.
+ *
+ * HeuristicLab is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * HeuristicLab is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
+ */
+#endregion
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -7 +28 @@
 
 namespace HeuristicLab.Hive.Client.Core.ClientConsoleService {
+  /// <summary>
+  /// Various Status Information for the ClientConsole
+  /// </summary>
   [DataContract]
   public class StatusCommons {    

trunk/sources/HeuristicLab.Hive.Client.Core/ConfigurationManager/ConfigManager.cs

@@ -51 +51 @@
     /// Constructor for the singleton, must recover Guid, Calendar, ...
     /// </summary>
-    private ConfigManager() {
-      //retrive GUID from XML file, or burn in hell. as in hell. not heaven.
-      //this won't work this way. We need a plugin for XML Handling.      
+    private ConfigManager() {      
       hardwareInfo = new ClientInfo();
 
@@ -68 +66 @@
     }
 
+    /// <summary>
+    /// Get all the Information about the client
+    /// </summary>
+    /// <returns>the ClientInfo object</returns>
     public ClientInfo GetClientInfo() {
       hardwareInfo.Login = WcfService.Instance.ConnectedSince;
@@ -73 +75 @@
     }
 
+    /// <summary>
+    /// Returns the connectioncontainer with the IP and Port, storred in the Settings framework
+    /// </summary>
+    /// <returns>The IP and Port of the server</returns>
     public ConnectionContainer GetServerIPAndPort() {
       ConnectionContainer cc = new ConnectionContainer();
@@ -80 +86 @@
     }
 
+    /// <summary>
+    /// Sets and saves IP and Port in the Settings framework
+    /// </summary>
+    /// <param name="cc"></param>
     public void SetServerIPAndPort(ConnectionContainer cc) {
       Settings.Default.ServerIP = cc.IPAdress;
@@ -85 +95 @@
       Settings.Default.Save();
     }
-
+    /// <summary>
+    /// collects and returns information that get displayed by the Client Console
+    /// </summary>
+    /// <returns></returns>
     public StatusCommons GetStatusForClientConsole() {
       StatusCommons st = new StatusCommons();

trunk/sources/HeuristicLab.Hive.Client.Core/Core.cs

@@ -46 +46 @@
 
 namespace HeuristicLab.Hive.Client.Core {
+  /// <summary>
+  /// The core component of the Hive Client
+  /// </summary>
   public class Core: MarshalByRefObject {
     public delegate string GetASnapshotDelegate();
@@ -59 +62 @@
     private WcfService wcfService;
     private Heartbeat beat;
-
+    
+    /// <summary>
+    /// Main Method for the client
+    /// </summary>
     public void Start() {
       Core.Locker = new Object();
@@ -70 +76 @@
       ConfigManager manager = ConfigManager.Instance;
       manager.Core = this;
-
+      
+      //Register all Wcf Service references
       wcfService = WcfService.Instance;
       wcfService.LoginCompleted += new EventHandler<LoginCompletedEventArgs>(wcfService_LoginCompleted);
@@ -78 +85 @@
       wcfService.ServerChanged += new EventHandler(wcfService_ServerChanged);
       wcfService.Connected += new EventHandler(wcfService_Connected);
-      ConnectionContainer cc = ConfigManager.Instance.GetServerIPAndPort();
+      //Recover Server IP and Port from the Settings Framework
+      ConnectionContainer cc = ConfigManager.Instance.GetServerIPAndPort();     
       if (cc.IPAdress != String.Empty && cc.Port != 0) {
         wcfService.Connect(cc.IPAdress, cc.Port);
       }
    
+      //Initialize the heartbeat
       beat = new Heartbeat { Interval = 10000 };
       beat.StartHeartbeat();     
 
       MessageQueue queue = MessageQueue.GetInstance();
+      
+      //Main processing loop
       while (!ShutdownFlag) {
         MessageContainer container = queue.GetMessage();
@@ -95 +106 @@
     }
 
+    /// <summary>
+    /// Reads and analyzes the Messages from the MessageQueue and starts corresponding actions
+    /// </summary>
+    /// <param name="container">The Container, containing the message</param>
     private void DetermineAction(MessageContainer container) {
       switch (container.Message) {
+        //Server requests to abort a job
         case MessageContainer.MessageType.AbortJob:
           engines[container.JobId].Abort();
           break;
+        //Job has been successfully aborted
         case MessageContainer.MessageType.JobAborted:
           Debug.WriteLine("-- Job Aborted Message received");
           break;
-
+        //Request a Snapshot from the Execution Engine
         case MessageContainer.MessageType.RequestSnapshot:
           engines[container.JobId].RequestSnapshot();
           break;
+        //Snapshot is ready and can be sent back to the Server
         case MessageContainer.MessageType.SnapshotReady:
           Thread ssr = new Thread(new ParameterizedThreadStart(GetSnapshot));
           ssr.Start(container.JobId);          
           break;
-
+        //Pull a Job from the Server
         case MessageContainer.MessageType.FetchJob: 
           wcfService.PullJobAsync(Guid.NewGuid());
           break;          
+        //A Job has finished and can be sent back to the server
         case MessageContainer.MessageType.FinishedJob:
           Thread finThread = new Thread(new ParameterizedThreadStart(GetFinishedJob));
           finThread.Start(container.JobId);          
           break;     
+        //Hard shutdown of the client
         case MessageContainer.MessageType.Shutdown:
           ShutdownFlag = true;
@@ -126 +146 @@
     }
 
+    //Asynchronous Threads for interaction with the Execution Engine
     #region Async Threads for the EE
     
@@ -146 +167 @@
     #endregion
 
+    //Eventhandlers for the communication with the wcf Layer 
     #region wcfService Events