- void setRate(double rate);
-
- /** Specify the data to send */
- void setSrcData(void* buff);
- /** Specify the size of the data to send */
- void setSrcDataSize(size_t size);
- /** Specify the data to send and its size */
- void setSrcData(void* buff, size_t size);
-
- /** Specify where to receive the data */
- void setDstData(void** buff);
- /** Specify the buffer in which the data should be received */
- void setDstData(void** buff, size_t size);
- /** Retrieve the size of the received data */
- size_t getDstDataSize();
-
- bool test();
- void cancel();
-
-private:
- double rate_ = -1;
- void* dstBuff_ = nullptr;
- size_t dstBuffSize_ = 0;
- void* srcBuff_ = nullptr;
- size_t srcBuffSize_ = sizeof(void*);
-
- /* FIXME: expose these elements in the API */
- int detached_ = 0;
- int (*matchFunction_)(void*, void*, smx_activity_t) = nullptr;
- void (*cleanFunction_)(void*) = nullptr;
- void (*copyDataFunction_)(smx_activity_t, void*, size_t) = nullptr;
-
- smx_actor_t sender_ = nullptr;
- smx_actor_t receiver_ = nullptr;
- MailboxPtr mailbox_ = nullptr;
-
- std::atomic_int_fast32_t refcount_{0};
+ 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(double 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();
+
+ /** Retrieve the mailbox on which this comm acts */
+ Mailbox* get_mailbox() const;
+ /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */
+ size_t get_dst_data_size() const;
+
+ Actor* get_sender() const;
+
+ bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); }