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 #ifndef SIMGRID_S4U_MAILBOX_HPP
   7 #define SIMGRID_S4U_MAILBOX_HPP
   8
   9 #include <string>
  10
  11 #include <boost/intrusive_ptr.hpp>
  12
  13 #include <xbt/base.h>
  14
  15 #include <simgrid/s4u/forward.hpp>
  16 #include <simgrid/s4u/actor.hpp>
  17
  18 namespace simgrid {
  19 namespace s4u {
  20
  21 /** @brief Mailboxes
  22  *
  23  * Rendez-vous point for network communications, similar to URLs on which you could post and retrieve data.
  24  * They are not network locations: you can post and retrieve on a given mailbox from anywhere on the network.
  25  * You can access any mailbox without any latency. The network delay are only related to the location of the
  26  * sender and receiver.
  27  */
  28 XBT_PUBLIC_CLASS Mailbox {
  29   friend Comm;
  30   friend simgrid::s4u::Engine;
  31   friend simgrid::simix::Mailbox;
  32
  33   smx_mailbox_t pimpl_;
  34
  35   Mailbox(smx_mailbox_t mbox): pimpl_(mbox) {}
  36
  37 protected:
  38   smx_mailbox_t getInferior() { return pimpl_; }
  39
  40 public:
  41
  42   // We don't have to manage the lifetime of mailboxes:
  43   friend void intrusive_ptr_add_ref(Mailbox*) {}
  44   friend void intrusive_ptr_release(Mailbox*) {}
  45   using Ptr = boost::intrusive_ptr<Mailbox>;
  46
  47   /** Get the name of that mailbox */
  48   const char *getName();
  49
  50   /** Retrieve the mailbox associated to the given string */
  51   static Ptr byName(const char *name);
  52
  53   /** Returns whether the mailbox contains queued communications */
  54   bool empty();
  55
  56   /** Declare that the specified process is a permanent receiver on that mailbox
  57    *
  58    * It means that the communications sent to this mailbox will start flowing to its host even before he does a recv().
  59    * This models the real behavior of TCP and MPI communications, amongst other.
  60    */
  61   void setReceiver(Actor* process);
  62
  63   /** Return the process declared as permanent receiver, or nullptr if none **/
  64   Actor& receiver();
  65 };
  66
  67 using MailboxPtr = Mailbox::Ptr;
  68
  69 }} // namespace simgrid::s4u
  70
  71 XBT_PUBLIC(sg_mbox_t) sg_mbox_by_name(const char*name);
  72 XBT_PUBLIC(int) sg_mbox_is_empty(sg_mbox_t mbox);
  73 XBT_PUBLIC(void)sg_mbox_setReceiver(sg_mbox_t mbox, smx_process_t process);
  74 XBT_PUBLIC(smx_process_t) sg_mbox_receiver(sg_mbox_t mbox);
  75
  76 #endif /* SIMGRID_S4U_MAILBOX_HPP */