X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d468bfe9e511204a05ddff628f356b8966963e55..dceed88b84f4c8dccf94f8031cc9ba635eaf75da:/include/simgrid/s4u/Mailbox.hpp diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp index 272aa02619..42e08f7bbd 100644 --- a/include/simgrid/s4u/Mailbox.hpp +++ b/include/simgrid/s4u/Mailbox.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */ /* 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. */ @@ -26,7 +26,7 @@ namespace s4u { * Rendez-vous point for network communications, similar to URLs on * which you could post and retrieve data. Actually, the mailboxes are * not involved in the communication once it starts, but only to find - * the contact with which you want to communicate. + * the contact with which you want to communicate. * Here are some mechanisms similar to the mailbox in other * communication systems: The phone number, which allows the caller to @@ -93,8 +93,8 @@ namespace s4u { * starts to flow as soon as the sender posts it, even if the receiver * did not post its recv() yet. This can obviously lead to bad * simulation timings, as the simulated communications do not start at - * the exact same time than the real ones. - * + * the exact same time than the real ones. + * * If the simulation timings are very important to you, you can * declare a specific receiver to a given mailbox (with the function * setReceiver()). That way, any send() posted to that mailbox will @@ -106,11 +106,11 @@ namespace s4u { XBT_PUBLIC_CLASS Mailbox { friend Comm; friend simgrid::s4u::Engine; - friend simgrid::simix::MailboxImpl; + friend simgrid::kernel::activity::MailboxImpl; - simgrid::simix::MailboxImpl* pimpl_; + simgrid::kernel::activity::MailboxImpl* pimpl_; - explicit Mailbox(simix::MailboxImpl * mbox) : pimpl_(mbox) {} + explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {} /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */ friend void intrusive_ptr_add_ref(Mailbox*) {} @@ -118,7 +118,7 @@ XBT_PUBLIC_CLASS Mailbox { friend void intrusive_ptr_release(Mailbox*) {} public: /** private function, do not use. FIXME: make me protected */ - simix::MailboxImpl* getImpl() { return pimpl_; } + kernel::activity::MailboxImpl* getImpl() { return pimpl_; } /** Gets the name of that mailbox */ const char *name(); @@ -132,6 +132,9 @@ public: /** Returns whether the mailbox contains queued communications */ bool empty(); + /** Check if there is a communication going on in a mailbox. */ + bool listen(); + /** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */ smx_activity_t front(); @@ -145,6 +148,28 @@ public: /** Return the actor declared as permanent receiver, or nullptr if none **/ ActorPtr receiver(); + + /** Creates (but don't start) an emission to that mailbox */ + CommPtr put_init(); + /** Creates (but don't start) an emission to that mailbox */ + CommPtr put_init(void* data, int simulatedByteAmount); + /** Creates and start an async emission to that mailbox */ + CommPtr put_async(void* data, int simulatedByteAmount); + + /** Blocking put */ + void put(void* payload, double simulatedSize); + /** Blocking put with timeout */ + void put(void* payload, double simulatedSize, double timeout); + + /** Creates (but don't start) a reception onto that mailbox */ + CommPtr get_init(); + /** Creates and start an async reception to that mailbox */ + CommPtr get_async(void** data); + + /** Blocking reception */ + void* get(); + /** Blocking reception with timeout */ + void* get(double timeout); }; }} // namespace simgrid::s4u