/** @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_;
/** 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;
/** 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 */
+ /** 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 */
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);
/** 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)); }
+
+#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get_async<>()") CommPtr get_async(void** data);
+ XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get<>()") void* get();
+ XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get<>()") void* get(double timeout);
+#endif
};
template <typename T> CommPtr Mailbox::get_async(T** data)
{
- CommPtr res = get_init();
- res->set_dst_data(reinterpret_cast<void**>(data), sizeof(void*));
+ CommPtr res = get_init()->set_dst_data(reinterpret_cast<void**>(data), sizeof(void*));
res->vetoable_start();
return res;
}
return res;
}
+#ifndef DOXYGEN
inline CommPtr Mailbox::get_async(void** data) // XBT_ATTRIB_DEPRECATED_v331
{
return get_async<void>(data);
{
return get<void>(timeout);
}
-
+#endif
} // namespace s4u
} // namespace simgrid