include/simgrid/s4u/mailbox.hpp

   1 /* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifdef __cplusplus
   7
   8 #ifndef SIMGRID_S4U_MAILBOX_HPP
   9 #define SIMGRID_S4U_MAILBOX_HPP
  10
  11 #include <boost/unordered_map.hpp>
  12
  13 #include <xbt/base.h>
  14 #include <simgrid/s4u/forward.hpp>
  15 #include <simgrid/s4u/actor.hpp>
  16
  17 namespace simgrid {
  18 namespace s4u {
  19
  20 /** @brief Mailboxes
  21  *
  22  * Rendez-vous point for network communications, similar to URLs on which you could post and retrieve data.
  23  * They are not network locations: you can post and retrieve on a given mailbox from anywhere on the network.
  24  * You can access any mailbox without any latency. The network delay are only related to the location of the
  25  * sender and receiver.
  26  */
  27 XBT_PUBLIC_CLASS Mailbox {
  28   friend Comm;
  29
  30 private:
  31   Mailbox(const char*name, smx_mailbox_t inferior);
  32 public:
  33   ~Mailbox();
  34
  35 protected:
  36   smx_mailbox_t getInferior() { return inferior_; }
  37
  38 public:
  39   /** Retrieve the mailbox associated to the given string */
  40   static Mailbox *byName(const char *name);
  41
  42 private:
  43   smx_mailbox_t inferior_;
  44   static boost::unordered_map<std::string, Mailbox *> *mailboxes;
  45 };
  46 }} // namespace simgrid::s4u
  47
  48 #endif
  49
  50 #endif /* SIMGRID_S4U_MAILBOX_HPP */