Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
this file should be compilable in C
[simgrid.git] / 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 <xbt/base.h>
10 #include <simgrid/s4u/forward.hpp>
11
12 #ifdef __cplusplus
13
14 # include <boost/unordered_map.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   /** Get the name of that mailbox */
40   const char *getName();
41   /** Retrieve the mailbox associated to the given string */
42   static Mailbox *byName(const char *name);
43   /** Returns whether the mailbox contains queued communications */
44   bool empty();
45
46 private:
47   std::string name_;
48   smx_mailbox_t inferior_;
49   static boost::unordered_map<std::string, Mailbox *> *mailboxes;
50 };
51 }} // namespace simgrid::s4u
52
53 #endif /* C++ */
54
55 XBT_PUBLIC(sg_mbox_t) sg_mbox_by_name(const char*name);
56 XBT_PUBLIC(int) sg_mbox_is_empty(sg_mbox_t mbox);
57
58 #endif /* SIMGRID_S4U_MAILBOX_HPP */