X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d9f8f81af86c42774b718736826255cbc523691d..916422155091e4e7e0f463cec933b88fed642e8a:/include/simgrid/s4u/Comm.hpp diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index 84b0cbbb3f..393b48ac5c 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2023. 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. */ @@ -12,14 +12,14 @@ #include #include -namespace simgrid { -namespace s4u { +namespace simgrid::s4u { /** @brief Communication async * * Represents all asynchronous communications, that you can test or wait onto. */ class XBT_PUBLIC Comm : public Activity_T { friend Mailbox; // Factory of comms + friend kernel::activity::CommImpl; /* specified for normal mailbox-based communications*/ Mailbox* mailbox_ = nullptr; kernel::actor::ActorImpl* sender_ = nullptr; @@ -37,23 +37,42 @@ class XBT_PUBLIC Comm : public Activity_T { std::function copy_data_function_; Comm() = default; + Comm* do_start() override; -public: - /* signals and related callbacks */ -#ifndef DOXYGEN - /* FIXME signals should be private */ +protected: static xbt::signal on_send; static xbt::signal on_recv; - static xbt::signal on_start; -#endif + inline static xbt::signal on_start; + xbt::signal on_this_start; + + void fire_on_completion() const override { + /* The completion signal of a Comm has to be thrown only once and not by the sender AND the receiver. + then Comm::on_completion is thrown in the kernel in CommImpl::finish. + */ + } + void fire_on_this_completion() const override { + /* The completion signal of a Comm has to be thrown only once and not by the sender AND the receiver. + then Comm::on_completion is thrown in the kernel in CommImpl::finish. + */ + } + void fire_on_suspend() const override { on_suspend(*this); } + void fire_on_this_suspend() const override { on_this_suspend(*this); } + void fire_on_resume() const override { on_resume(*this); } + void fire_on_this_resume() const override { on_this_resume(*this); } + void fire_on_veto() const override { on_veto(const_cast(*this)); } + void fire_on_this_veto() const override { on_this_veto(const_cast(*this)); } +public: static void on_send_cb(const std::function& cb) { on_send.connect(cb); } static void on_recv_cb(const std::function& cb) { on_recv.connect(cb); } static void on_start_cb(const std::function& cb) { on_start.connect(cb); } - /* More callbacks */ + void on_this_start_cb(const std::function& cb) { on_this_start.connect(cb); } + CommPtr set_copy_data_callback(const std::function& callback); - static void copy_buffer_callback(kernel::activity::CommImpl*, void*, size_t); - static void copy_pointer_callback(kernel::activity::CommImpl*, void*, size_t); + XBT_ATTRIB_DEPRECATED_v337("Please manifest if you actually need this function") static void copy_buffer_callback( + kernel::activity::CommImpl*, void*, size_t); + XBT_ATTRIB_DEPRECATED_v337("Please manifest if you actually need this function") static void copy_pointer_callback( + kernel::activity::CommImpl*, void*, size_t); ~Comm() override; @@ -128,7 +147,7 @@ public: CommPtr set_dst_data(void** buff, size_t size); /** Retrieve where the data will be copied on the receiver side */ void* get_dst_data() const { return dst_buff_; } - /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */ + /** Retrieve the size of the received data. Not to be mixed with @ref Activity::get_remaining() */ size_t get_dst_data_size() const { return dst_buff_size_; } /* Common functions */ @@ -146,9 +165,9 @@ public: bool is_assigned() const override; Actor* get_sender() const; + Actor* get_receiver() const; /* Comm life cycle */ - Comm* start() override; /** Start the comm, and ignore its result. It can be completely forgotten after that. */ Comm* detach(); /** Start the comm, and ignore its result. It can be completely forgotten after that. */ @@ -175,7 +194,6 @@ public: * occurs). */ static size_t wait_all_for(const std::vector& comms, double timeout); }; -} // namespace s4u -} // namespace simgrid +} // namespace simgrid::s4u #endif /* SIMGRID_S4U_COMM_HPP */