- /** Specify where to receive the data */
- Activity* set_dst_data(void** buff);
- /** Specify the buffer in which the data should be received */
- Activity* set_dst_data(void** buff, size_t size);
- /** Retrieve the size of the received data */
- size_t get_dst_data_size();
-
- bool test();
- Activity* cancel() override;
+ /** Sets the maximal communication rate (in byte/sec). Must be done before start */
+ CommPtr set_rate(double rate);
+
+ /** 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 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 set_payload_size())
+ *
+ * @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 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
+ */
+ CommPtr set_payload_size(uint64_t bytes);
+
+ /** 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 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);
+
+ /** Specify where to receive the data.
+ *
+ * That's a buffer where the sent data will be copied */
+ CommPtr set_dst_data(void** buff);
+ /** Specify the buffer in which the data should be received
+ *
+ * That's a buffer where the sent data will be copied */
+ CommPtr set_dst_data(void** buff, size_t size);
+ /** Retrieve where the data will be copied on the receiver side */
+ void* get_dst_data();