X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/da0c93fd67406d11975b3704c04898f8a133508c..944e89a912796773ddff48f4fc58628f59991ede:/include/simgrid/s4u/Mailbox.hpp diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp index f7797dd75b..642ce4a386 100644 --- a/include/simgrid/s4u/Mailbox.hpp +++ b/include/simgrid/s4u/Mailbox.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2018. 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. */ @@ -9,6 +9,7 @@ #include #include +#include #include #include @@ -103,9 +104,8 @@ namespace s4u { * * @section s4u_mb_api The API */ -XBT_PUBLIC_CLASS Mailbox { +class XBT_PUBLIC Mailbox { friend Comm; - friend simgrid::s4u::Engine; friend simgrid::kernel::activity::MailboxImpl; simgrid::kernel::activity::MailboxImpl* pimpl_; @@ -120,8 +120,10 @@ public: /** private function, do not use. FIXME: make me protected */ kernel::activity::MailboxImpl* getImpl() { return pimpl_; } - /** Gets the name of that mailbox */ - const char* getName(); + /** @brief Retrieves the name of that mailbox as a C++ string */ + const simgrid::xbt::string& getName() const; + /** @brief Retrieves the name of that mailbox as a C string */ + const char* getCname() const; /** Retrieve the mailbox associated to the given C string */ static MailboxPtr byName(const char *name); @@ -149,26 +151,26 @@ public: /** Return the actor declared as permanent receiver, or nullptr if none **/ ActorPtr getReceiver(); - /** Creates (but don't start) an emission to that mailbox */ + /** Creates (but don't start) a data 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); + /** Creates (but don't start) a data emission to that mailbox */ + CommPtr put_init(void* data, uint64_t simulatedSizeInBytes); + /** Creates and start a data emission to that mailbox */ + CommPtr put_async(void* data, uint64_t simulatedSizeInBytes); - /** Blocking put */ - void put(void* payload, double simulatedSize); - /** Blocking put with timeout */ - void put(void* payload, double simulatedSize, double timeout); + /** Blocking data emission */ + void put(void* payload, uint64_t simulatedSizeInBytes); + /** Blocking data emission with timeout */ + void put(void* payload, uint64_t simulatedSizeInBytes, double timeout); - /** Creates (but don't start) a reception onto that mailbox */ + /** Creates (but don't start) a data reception onto that mailbox */ CommPtr get_init(); - /** Creates and start an async reception to that mailbox */ + /** Creates and start an async data reception to that mailbox */ CommPtr get_async(void** data); - /** Blocking reception */ + /** Blocking data reception */ void* get(); - /** Blocking reception with timeout */ + /** Blocking data reception with timeout */ void* get(double timeout); };