/*! Creates a communication beween the two given hosts, bypassing the mailbox mechanism. */
static CommPtr sendto_init(Host* from, Host* to);
- /*! Creates and start a communication of the given amount of bytes beween the two given hosts, bypassing the mailbox
- * mechanism */
+ /** Do an asynchronous communication between two arbitrary hosts.
+ *
+ * This initializes a communication that completely bypass the mailbox and actors mechanism.
+ * There is really no limit on the hosts involved. In particular, the actor does not have to be on one of the involved
+ * hosts.
+ */
static CommPtr sendto_async(Host* from, Host* to, double simulated_size_in_bytes);
+ /** Do a blocking communication between two arbitrary hosts.
+ *
+ * This starts a blocking communication right away, bypassing the mailbox and actors mechanism.
+ * The calling actor is blocked until the end of the communication; there is really no limit on the hosts involved.
+ * In particular, the actor does not have to be on one of the involved hosts. Enjoy the comfort of the simulator :)
+ */
+ static void sendto(Host* from, Host* to, double simulated_size_in_bytes);
static xbt::signal<void(Comm const&, bool is_sender)> on_start;
static xbt::signal<void(Comm const&)> on_completion;
/** Specify the data to send.
*
+ * @beginrst
* This is way will get actually copied over to the receiver.
- * That's completely unrelated from the simulated size (given with @ref Comm::set_payload_size()):
+ * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
* you can send a short buffer in your simulator, that represents a very large message
* in the simulated world, or the opposite.
+ * @endrst
*/
CommPtr set_src_data(void* buff);
- /** Specify the size of the data to send. Not to be mixed with @ref Comm::set_payload_size()
+ /** Specify the size of the data to send (not to be mixed with set_payload_size())
*
- * That's the size of the data to actually copy in the simulator (ie, the data passed with Activity::set_src_data()).
- * That's completely unrelated from the simulated size (given with @ref Comm::set_payload_size()):
- * you can send a short buffer in your simulator, that represents a very large message
- * in the simulated world, or the opposite.
+ * @beginrst
+ * That's the size of the data to actually copy in the simulator (ie, the data passed with
+ * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
+ * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
+ * a very large message in the simulated world, or the opposite.
+ * @endrst
*/
CommPtr set_src_data_size(size_t size);
- /* Specify the amount of bytes which exchange should be simulated. Not to be mixed with @ref Comm::set_src_data_size()
+ /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
*
- * That's the size of the simulated data, that's completely related from the actual data size (given with @ref
- * Comm::set_src_data_size()).
+ * @beginrst
+ * That's the size of the simulated data, that's completely related from the actual data size (given by
+ * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
+ * @endrst
*/
- Comm* set_payload_size(double bytes);
+ CommPtr set_payload_size(double bytes);
- /** Specify the data to send and its size. Don't mix the size with @ref Comm::set_payload_size()
+ /** Specify the data to send and its size (not to be mixed with set_payload_size())
*
+ * @beginrst
* This is way will get actually copied over to the receiver.
- * That's completely unrelated from the simulated size (given with @ref Comm::set_payload_size()):
+ * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
* you can send a short buffer in your simulator, that represents a very large message
* in the simulated world, or the opposite.
+ * @endrst
*/
CommPtr set_src_data(void* buff, size_t size);
size_t get_dst_data_size() const;
Actor* get_sender() const;
+
+ bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); }
};
} // namespace s4u
} // namespace simgrid