Add BUGS and review TODO.

[loba.git] / communicator.h

diff --git a/communicator.h b/communicator.h
index f1ee1d96cc0eb11d98ad1cb95585f8f6c417448c..66dc800b4feeea9502902348847fa85757e41682 100644 (file)
--- a/communicator.h
+++ b/communicator.h
@@ -4,46 +4,76 @@
 #define COMMUNICATOR_H
 
 #include <list>
 #define COMMUNICATOR_H
 
 #include <list>

-
+#include <queue>
+#include <string>

 #include <msg/msg.h>
 #include <msg/msg.h>

-#include <xbt/sysdep.h>
-#include "neighbor.h"
+#include "hostdata.h"
+
+class message {
+public:
+    enum message_type { INFO, CREDIT, LOAD, CTRL_CLOSE, DATA_CLOSE };
+
+    message(message_type t, double a): type(t), amount(a) { }
+
+    message_type get_type() const       { return type;   }
+    double get_amount() const           { return amount; }
+
+    std::string to_string();
+
+private:
+    message_type type;
+    double amount;
+};

 
 class communicator {
 public:
     communicator();
     ~communicator();
 
 
 class communicator {
 public:
     communicator();
     ~communicator();
 

-    void send_info(const neighbor& dest, double amount);
-    void send_credit(const neighbor& dest, double amount);
-    void send_load(const neighbor& dest, double amount);
+    // Send a message to the "dest" mailbox
+    void send(const char* dest, message* msg);

 
 

-    bool recv_info(double& amount, m_host_t& from);
-    bool recv_credit(double& amount, m_host_t& from);
-    bool recv_load(double& amount, m_host_t& from);
+    // Try to get a message.  Returns true on success.
+    // Parameter "timeout" may be 0 for non-blocking operation, -1 for
+    // infinite waiting, or any positive timeout.
+    bool recv(message*& msg, m_host_t& from, double timeout);

 
 

-    int send_backlog();
+    // Try to flush pending sending communications.
+    // If "wait" is true, blocks until success.
+    void flush(bool wait);

 
 private:
 
 private:

-    enum message_type { INFO_MSG, CREDIT_MSG };
-    class message;
+    // Myself
+    const hostdata* host;
+
+    // Used to synchronize main and receiver thread 
+    xbt_mutex_t mutex;
+    xbt_cond_t cond;

 
     // List of pending send communications
     std::list<msg_comm_t> sent_comm;
 
 
     // List of pending send communications
     std::list<msg_comm_t> sent_comm;
 

+    // Queue of received messages
+    std::queue<m_task_t> received;
+

     // Control channel for receiving
     // Control channel for receiving

-    char*       ctrl_mbox;
-    msg_comm_t  ctrl_comm;
-    m_task_t    ctrl_task;
+    m_task_t    ctrl_task;          // receive buffer
+    msg_comm_t  ctrl_comm;          // receive communication

 
     // Data channel for receiving
 
     // Data channel for receiving

-    char*       data_mbox;
-    msg_comm_t  data_comm;
-    m_task_t    data_task;
+    m_task_t    data_task;          // receive buffer
+    msg_comm_t  data_comm;          // receive communication
+
+    const char* get_ctrl_mbox() const   { return host->get_ctrl_mbox(); }
+    const char* get_data_mbox() const   { return host->get_data_mbox(); }
+
+    // Handling of receiving thread
+    m_process_t receiver_process;
+    static int receiver_wrapper(int, char* []);
+    int receiver();

 
 

-    bool recv_ctrl(message_type type, double& amount, m_host_t& from);
-    void send(const char* dest, m_task_t task);
-    void flush_sent();
+    // Used to test if a communication is over, and to destroy it if it is
+    static bool comm_test_n_destroy(msg_comm_t comm);

 };
 
 #endif // !COMMUNICATOR_H
 };
 
 #endif // !COMMUNICATOR_H