]> AND Private Git Repository - loba.git/blobdiff - neighbor.h
Logo AND Algorithmique Numérique Distribuée

Private GIT Repository
Add more documentation.
[loba.git] / neighbor.h
index 7700cb3c9f6fc113cbfd39e1d27cd0b05f364b90..9607c072f49c8dbd5de11adab45e3eaca3746e81 100644 (file)
@@ -9,26 +9,32 @@ public:
     neighbor(const char* hostname);
     ~neighbor();
 
+    // returns name, ctrl or data mbox
     const char* get_name() const        { return host->get_name(); }
     const char* get_ctrl_mbox() const   { return host->get_ctrl_mbox(); }
     const char* get_data_mbox() const   { return host->get_data_mbox(); }
 
+    // Getter and setter for load
     double get_load() const             { return load;   }
     void set_load(double amount)        { load = amount; }
 
+    // Getter and setter for debt
     double get_debt() const             { return debt;   }
     void set_debt(double amount)        { debt = amount; }
 
+    // Getter and setter for to_send
     double get_to_send() const          { return to_send;   }
     void set_to_send(double amount)     { to_send = amount; }
 
 private:
-    const hostdata* host;
+    const hostdata* host;       // pointer to this neighbor's hostdata
 
-    double load;
-    double debt;
+    double load;                // the load information we know for it
+    double debt;                // the load we had to send to it, but
+                                // that we have not currently sent
+                                // (in bookkeeping mode)
 
-    double to_send;
+    double to_send;             // the load we have to send to it
 };
 
 #endif // !NEIGHBOR_H