-/* 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. */
#include <string>
#include <xbt/base.h>
+#include <xbt/string.hpp>
#include <simgrid/s4u/forward.hpp>
#include <simgrid/s4u/Actor.hpp>
*
* @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_;
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*) {}
+ friend XBT_PUBLIC void intrusive_ptr_add_ref(Mailbox*) {}
/** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */
- friend void intrusive_ptr_release(Mailbox*) {}
+ friend XBT_PUBLIC void intrusive_ptr_release(Mailbox*) {}
public:
/** private function, do not use. FIXME: make me protected */
kernel::activity::MailboxImpl* getImpl() { return pimpl_; }
- /** Gets the name of that mailbox */
- const char *name();
+ /** @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);
void setReceiver(ActorPtr actor);
/** Return the actor declared as permanent receiver, or nullptr if none **/
- ActorPtr receiver();
+ ActorPtr getReceiver();
+
+ /** Creates (but don't start) a data emission to that mailbox */
+ CommPtr put_init();
+ /** 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 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 data reception onto that mailbox */
+ CommPtr get_init();
+ /** Creates and start an async data reception to that mailbox */
+ CommPtr get_async(void** data);
+
+ /** Blocking data reception */
+ void* get();
+ /** Blocking data reception with timeout */
+ void* get(double timeout);
};
}} // namespace simgrid::s4u