-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2023. 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. */
#include <simgrid/s4u/Actor.hpp>
#include <simgrid/s4u/Comm.hpp>
#include <smpi/forward.hpp>
-#include <xbt/string.hpp>
#include <memory>
#include <string>
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
/** @brief Mailboxes: Network rendez-vous points. */
class XBT_PUBLIC Mailbox {
+#ifndef DOXYGEN
friend Comm;
friend smpi::Request;
friend kernel::activity::MailboxImpl;
+#endif
kernel::activity::MailboxImpl* const pimpl_;
public:
/** @brief Retrieves the name of that mailbox as a C++ string */
- const xbt::string& get_name() const;
+ const std::string& get_name() const;
/** @brief Retrieves the name of that mailbox as a C string */
const char* get_cname() const;
- /** Retrieve the mailbox associated to the given name. Mailboxes are created on demand. */
+ /** \static Retrieve the mailbox associated to the given name. Mailboxes are created on demand. */
static Mailbox* by_name(const std::string& name);
/** Returns whether the mailbox contains queued communications */
bool empty() const;
+ /* Returns the number of queued communications */
+ size_t size() const;
+
/** Check if there is a communication going on in a mailbox. */
bool listen() const;
/** Look if there is a communication going on in a mailbox and return the PID of the sender actor */
aid_t listen_from() const;
- /** Check if there is a communication ready to be consumed from a mailbox. */
+ /** Check if there is a communication ready to be consumed from a mailbox.
+ * \beginrst
+ * See :ref:`this example <s4u_ex_mailbox_ready>`.
+ * \endrst
+ */
bool ready() const;
/** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */
/** Creates (but don't start) a data transmission to that mailbox */
CommPtr put_init();
- /** Creates (but don't start) a data transmission to that mailbox */
+ /** Creates (but don't start) a data transmission to that mailbox.
+ *
+ * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
+ * communication, or the receiver will get a pointer to a garbled memory area.
+ */
CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
- /** Creates and start a data transmission to that mailbox */
+ /** Creates and start a data transmission to that mailbox.
+ *
+ * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
+ * communication, or the receiver will get a pointer to a garbled memory area.
+ */
CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
- kernel::activity::ActivityImplPtr iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*),
- void* data);
- /** Blocking data transmission */
+ kernel::activity::ActivityImplPtr
+ iprobe(int type, const std::function<bool(void*, void*, kernel::activity::CommImpl*)>& match_fun, void* data);
+ /** Blocking data transmission.
+ *
+ * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
+ * communication, or the receiver will get a pointer to a garbled memory area.
+ */
void put(void* payload, uint64_t simulated_size_in_bytes);
/** Blocking data transmission with timeout */
void put(void* payload, uint64_t simulated_size_in_bytes, double timeout);
- /** Creates (but don't start) a data reception onto that mailbox */
+ /** Creates (but don't start) a data reception onto that mailbox.
+ * @verbatim embed:rst:inline You probably want to use :cpp:func:`simgrid::s4u::Comm::set_dst_data` and friends before
+ * starting that activity. @endverbatim */
CommPtr get_init();
/** Creates and start an async data reception to that mailbox */
- XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get_async<>()") CommPtr get_async(void** data);
template <typename T> CommPtr get_async(T** data);
+ /** Creates and start an async data reception to that mailbox. Since the data location is not provided, you'll have to
+ * use Comm::get_payload once the comm terminates */
+ CommPtr get_async();
/** Blocking data reception */
template <typename T> T* get();
- XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get<>()") void* get();
template <typename T> std::unique_ptr<T> get_unique() { return std::unique_ptr<T>(get<T>()); }
/** Blocking data reception with timeout */
template <typename T> T* get(double timeout);
- XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get<>()") void* get(double timeout);
template <typename T> std::unique_ptr<T> get_unique(double timeout) { return std::unique_ptr<T>(get<T>(timeout)); }
+
+ void clear();
};
template <typename T> CommPtr Mailbox::get_async(T** data)
{
- CommPtr res = get_init();
- res->set_dst_data(reinterpret_cast<void**>(data), sizeof(void*));
- res->vetoable_start();
+ CommPtr res = get_init()->set_dst_data(reinterpret_cast<void**>(data), sizeof(void*));
+ res->start();
return res;
}
get_async<T>(&res)->wait_for(timeout);
return res;
}
-
-inline CommPtr Mailbox::get_async(void** data) // XBT_ATTRIB_DEPRECATED_v331
-{
- return get_async<void>(data);
-}
-inline void* Mailbox::get() // XBT_ATTRIB_DEPRECATED_v331
-{
- return get<void>();
-}
-inline void* Mailbox::get(double timeout) // XBT_ATTRIB_DEPRECATED_v331
-{
- return get<void>(timeout);
-}
-
-} // namespace s4u
-} // namespace simgrid
+} // namespace simgrid::s4u
#endif /* SIMGRID_S4U_MAILBOX_HPP */