Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rename S4U::Channel to S4U::Mailbox. It was not a good idea
[simgrid.git] / include / simgrid / s4u / mailbox.hpp
similarity index 51%
rename from include/simgrid/s4u/channel.hpp
rename to include/simgrid/s4u/mailbox.hpp
index 1c3abd2..c76a4d9 100644 (file)
@@ -3,8 +3,8 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#ifndef SIMGRID_S4U_CHANNEL_HPP
-#define SIMGRID_S4U_CHANNEL_HPP
+#ifndef SIMGRID_S4U_MAILBOX_HPP
+#define SIMGRID_S4U_MAILBOX_HPP
 
 #include <boost/unordered_map.hpp>
 
 namespace simgrid {
 namespace s4u {
 
-/** @brief Channel
+/** @brief Mailboxes
  *
  * Rendez-vous point for network communications, similar to URLs on which you could post and retrieve data.
- * They are not network locations (you can post and retrieve on a given mailbox from anywhere on the network).
+ * They are not network locations: you can post and retrieve on a given mailbox from anywhere on the network.
+ * You can access any mailbox without any latency. The network delay are only related to the location of the
+ * sender and receiver.
  */
-class Channel {
+class Mailbox {
        friend Process;
 
 private:
-       Channel(const char*name, smx_rdv_t inferior);
+       Mailbox(const char*name, smx_rdv_t inferior);
 public:
-       ~Channel();
+       ~Mailbox();
        
 protected:
        smx_rdv_t getInferior() { return p_inferior; }
 
 public:
-       /** Retrieve the channel associated to the given string */
-       static Channel *byName(const char *name);
+       /** Retrieve the mailbox associated to the given string */
+       static Mailbox *byName(const char *name);
 
 private:
        std::string p_name;
        smx_rdv_t p_inferior;
-       static boost::unordered_map<std::string, Channel *> *channels;
+       static boost::unordered_map<std::string, Mailbox *> *channels;
 };
 }} // namespace simgrid::s4u
 
-#endif /* SIMGRID_S4U_CHANNEL_HPP */
+#endif /* SIMGRID_S4U_MAILBOX_HPP */