- 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();
+ Activity* set_rate(double rate);
+
+ /** Specify the data to send.
+ *
+ * This is way will get actually copied over to the receiver.
+ * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
+ * you can send a short buffer in your simulator, that represents a very large message
+ * in the simulated world, or the opposite.
+ */
+ Activity* set_src_data(void* buff);
+ /** Specify the size of the data to send. Not to be mixed with @ref Activity::set_remaining()
+ *
+ * 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 Activity::set_remaining()):
+ * you can send a short buffer in your simulator, that represents a very large message
+ * in the simulated world, or the opposite.
+ */
+ Activity* set_src_data_size(size_t size);
+ /** Specify the data to send and its size. Don't mix the size with @ref Activity::set_remaining()
+ *
+ * This is way will get actually copied over to the receiver.
+ * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
+ * you can send a short buffer in your simulator, that represents a very large message
+ * in the simulated world, or the opposite.
+ */
+ Activity* 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 */
+ Activity* 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 */
+ Activity* set_dst_data(void** buff, size_t size);
+ /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */
+ size_t get_dst_data_size();
+
+ Activity* cancel() override;
+
+ /** Retrieve the mailbox on which this comm acts */
+ MailboxPtr get_mailbox();
+
+#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v324("Please use Comm::wait_for()") void wait(double t) override { wait_for(t); }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate) { return set_rate(rate); }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff)
+ {
+ return set_src_data(buff);
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size)
+ {
+ return set_src_data(buff, size);
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size)
+ {
+ return set_src_data_size(size);
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff)
+ {
+ return set_dst_data(buff);
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size)
+ {
+ return set_dst_data(buff, size);
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize()
+ {
+ return get_dst_data_size();
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") MailboxPtr getMailbox() { return get_mailbox(); }
+#endif