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

Timestamp:

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

Author:

kgrading

Message:

added licence information and comments (#467)

File:

• trunk/sources/HeuristicLab.Hive.Client.Communication/WcfService.cs (modified) (9 diffs)

trunk/sources/HeuristicLab.Hive.Client.Communication/WcfService.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;
@@ -11 +32 @@
 
 namespace HeuristicLab.Hive.Client.Communication {
+  /// <summary>
+  /// WcfService class is implemented as a Singleton and works as a communication Layer with the Server
+  /// </summary>
   public class WcfService {
     private static WcfService instance;
+    /// <summary>
+    /// Getter for the Instance of the WcfService
+    /// </summary>
+    /// <returns>the Instance of the WcfService class</returns>
     public static WcfService Instance {
       get {
@@ -33 +61 @@
     public ClientCommunicatorClient proxy = null;
 
+    /// <summary>
+    /// Constructor
+    /// </summary>
     private WcfService() {
       ConnState = NetworkEnum.WcfConnState.Disconnected;
     }
+
+    /// <summary>
+    /// Connects with the Server, registers the events and fires the Connected (and quiet possibly the ConnectionRestored) Event.
+    /// </summary>
     public void Connect() {
       try {
@@ -63 +98 @@
     }
 
+    /// <summary>
+    /// Changes the Connectionsettings (serverIP & serverPort) and reconnects
+    /// </summary>
+    /// <param name="serverIP">current Server IP</param>
+    /// <param name="serverPort">current Server Port</param>
     public void Connect(String serverIP, int serverPort) {
       String oldIp = this.ServerIP;
@@ -73 +113 @@
           ServerChanged(this, new EventArgs());
     }
-
+    
+    /// <summary>
+    /// Disconnects the Client from the Server
+    /// </summary>
     public void Disconnect() {
       ConnState = NetworkEnum.WcfConnState.Disconnected;
     }
 
+    /// <summary>
+    /// Network communication Error Handler - Every network error gets logged and the connection switches to faulted state
+    /// </summary>
+    /// <param name="e">The Exception</param>
     private void NetworkErrorHandling(Exception e) {
       ConnState = NetworkEnum.WcfConnState.Failed;
@@ -83 +130 @@
     }
 
+    
+
+    /// <summary>
+    /// Methods for the Server Login
+    /// </summary>
     #region Login
     public event System.EventHandler<LoginCompletedEventArgs> LoginCompleted;
@@ -110 +162 @@
     #endregion
 
+    /// <summary>
+    /// Pull a Job from the Server
+    /// </summary>
     #region PullJob
     public event System.EventHandler<PullJobCompletedEventArgs> PullJobCompleted;
@@ -124 +179 @@
     #endregion
 
+    /// <summary>
+    /// Send back finished Job Results
+    /// </summary>
     #region SendJobResults
     public event System.EventHandler<SendJobResultCompletedEventArgs> SendJobResultCompleted;
@@ -147 +205 @@
     #endregion
 
+    /// <summary>
+    /// Methods for sending the periodically Heartbeat
+    /// </summary>
     #region Heartbeat