Changeset 735

Timestamp:

11/11/08 18:15:55 (16 years ago)

Author:

kgrading

Message:

added comments (#348)

Location:

trunk/sources

Files:

• HeuristicLab.Hive.Client.Common/CommonPlugin.cs (modified) (1 diff)
• HeuristicLab.Hive.Client.Common/Logging.cs (modified) (5 diffs)
• HeuristicLab.Hive.Client.Common/MessageContainer.cs (modified) (2 diffs)
• HeuristicLab.Hive.Client.Core/Core.cs (modified) (1 diff)
• HeuristicLab.Hive.Client.Core/CoreApplication.cs (modified) (2 diffs)
• HeuristicLab.Hive.Client.Core/CorePlugin.cs (modified) (1 diff)
• HeuristicLab.Hive.Client.Core/Heartbeat.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.Hive.Client.Common/CommonPlugin.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.Common/Logging.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.Common {
+  /// <summary>
+  /// The Logging class uses the Windows Event logging mechanism. It writes the logs to a custom log 
+  /// called "Hive Client". For the creation of the Hive Client Log the program must be executed with
+  /// Administrator privileges   
+  /// </summary>
   public class Logging {      
     private static Logging instance = null;
     private EventLog eventLogger = null;
 
+    /// <summary>
+    /// This is an implementation of the singleton design pattern.
+    /// </summary>
+    /// <returns>the instance of the logger</returns>
     public static Logging getInstance() {
       if (instance == null)
@@ -17 +47 @@
 
     private Logging() {
-      eventLogger = new EventLog("Hive Client Core");    
+      eventLogger = new EventLog("Hive Client");    
     }
 
+    /// <summary>
+    /// Writes an Info Log-Entry
+    /// </summary>
+    /// <param name="source">string representation of the caller</param>
+    /// <param name="message">the message</param>
     public void Info(String source, String message) {
       eventLogger.Source = source;
@@ -26 +61 @@
     }
 
+    /// <summary>
+    /// Writes an Error Log-Entry
+    /// </summary>
+    /// <param name="source">string representation of the caller</param>
+    /// <param name="message">the message</param>
     public void Error(String source, String message) {
       eventLogger.Source = source;
@@ -32 +72 @@
     }
 
+    /// <summary>
+    /// Writes an Error Log-Entry
+    /// </summary>
+    /// <param name="source">string representation of the caller</param>
+    /// <param name="message">the message</param>
+    /// <param name="e">the exception</param>
     public void Error(String source, String message, Exception e) {
       eventLogger.Source = source;

trunk/sources/HeuristicLab.Hive.Client.Common/MessageContainer.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;
@@ -5 +26 @@
 
 namespace HeuristicLab.Hive.Client.Common {
+  /// <summary>
+  /// The MessageContainer is a container class for Messages. Its two parts are:
+  /// the actual message itself and the JobId, refered by the message
+  /// </summary>
   public class MessageContainer {
     public MessageQueue.MessageType Message { get; set; }

trunk/sources/HeuristicLab.Hive.Client.Core/Core.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;
 using System.Text;
+using HeuristicLab.Hive.Client.Common;
 
 namespace HeuristicLab.Hive.Client.Core {
   public class Core {
+    public void Start() {
+      //Logging.getInstance().Info(this.Name, "Info Message");
+      //Logging.getInstance().Error(this.Name, "Error Message");
+      //Logging.getInstance().Error(this.Name, "Exception Message", new Exception("Exception"));
+
+      Heartbeat beat = new Heartbeat();
+      beat.Interval = 1000;
+      beat.StartHeartbeat();
+      MessageQueue queue = MessageQueue.GetInstance();
+
+      while (true) {
+        MessageContainer container = queue.GetMessage();
+        Console.WriteLine(container.Message.ToString());
+      }
+    }
   }
 }

trunk/sources/HeuristicLab.Hive.Client.Core/CoreApplication.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;
@@ -13 +34 @@
   public class CoreApplication: ApplicationBase {
     public override void Run() {
- 
-      //Logging.getInstance().Info(this.Name, "Info Message");
-      //Logging.getInstance().Error(this.Name, "Error Message");
-      //Logging.getInstance().Error(this.Name, "Exception Message", new Exception("Exception"));
-      
-      Heartbeat beat = new Heartbeat();
-      beat.Interval = 1000;
-      beat.StartHeartbeat();
-      MessageQueue queue = MessageQueue.GetInstance();
-      
-      while (true) {
-        MessageContainer container = queue.GetMessage();
-        Console.WriteLine(container.Message.ToString());
-      }
-
-      
+      Core core = new Core();
+      core.Start();
     }
   }

trunk/sources/HeuristicLab.Hive.Client.Core/CorePlugin.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/Heartbeat.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 {
+  /// <summary>
+  /// Heartbeat class. It sends every x ms a heartbeat to the server and receives a Message
+  /// </summary>
   public class Heartbeat {
-    public double Interval { get; set; }
-    
+    public double Interval { get; set; }    
     private Timer heartbeatTimer = null;
         
@@ -20 +43 @@
     }
 
+    /// <summary>
+    /// Starts the Heartbeat signal.
+    /// </summary>
     public void StartHeartbeat() {
       heartbeatTimer = new System.Timers.Timer();
@@ -28 +54 @@
     }
 
+    /// <summary>
+    /// This Method is called every time the timer ticks
+    /// </summary>
+    /// <param name="sender"></param>
+    /// <param name="e"></param>
     void heartbeatTimer_Elapsed(object sender, ElapsedEventArgs e) {
       Console.WriteLine("tick");