From: Martin Quinson Date: Fri, 24 Aug 2018 13:43:59 +0000 (+0200) Subject: rename Activity::wait(double) to Activity::wait_for(double) X-Git-Tag: v3_21~191 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/a47e722190af3bc98a0d5bd16807cb3939f6e4af rename Activity::wait(double) to Activity::wait_for(double) Along with the deprecation wrappers, and in all subclasses also. --- diff --git a/examples/s4u/dht-chord/s4u-dht-chord-node.cpp b/examples/s4u/dht-chord/s4u-dht-chord-node.cpp index 90ae8c18b4..f535b3114e 100644 --- a/examples/s4u/dht-chord/s4u-dht-chord-node.cpp +++ b/examples/s4u/dht-chord/s4u-dht-chord-node.cpp @@ -239,7 +239,7 @@ void Node::checkPredecessor() simgrid::s4u::CommPtr comm = return_mailbox->get_async(&data); try { - comm->wait(timeout); + comm->wait_for(timeout); XBT_DEBUG("Received the answer to my 'Predecessor Alive': my predecessor %d is alive", pred_id_); delete static_cast(data); } catch (xbt_ex& e) { @@ -284,7 +284,7 @@ int Node::remoteGetPredecessor(int ask_to) simgrid::s4u::CommPtr comm = return_mailbox->get_async(&data); try { - comm->wait(timeout); + comm->wait_for(timeout); ChordMessage* answer = static_cast(data); XBT_DEBUG("Received the answer to my 'Get Predecessor' request: the predecessor of node %d is %d", ask_to, answer->answer_id); @@ -358,7 +358,7 @@ int Node::remoteFindSuccessor(int ask_to, int id) simgrid::s4u::CommPtr comm = return_mailbox->get_async(&data); try { - comm->wait(timeout); + comm->wait_for(timeout); ChordMessage* answer = static_cast(data); XBT_DEBUG("Received the answer to my 'Find Successor' request for id %d: the successor of key %d is %d", answer->request_id, id_, answer->answer_id); diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index 3a374a40ca..cd68b0a561 100644 --- a/include/simgrid/s4u/Activity.hpp +++ b/include/simgrid/s4u/Activity.hpp @@ -61,7 +61,7 @@ public: virtual Activity* wait() = 0; /** Blocks until the activity is terminated, or until the timeout is elapsed * Raises: timeout exception.*/ - virtual Activity* wait(double timeout) = 0; + virtual Activity* wait_for(double timeout) = 0; /** Cancel that activity */ virtual Activity* cancel() = 0; /** Retrieve the current state of the activity */ @@ -87,21 +87,17 @@ public: void* get_user_data() { return user_data_; } #ifndef DOXYGEN - /** @deprecated See Activity::get_state()*/ + XBT_ATTRIB_DEPRECATED_v324("Please use Activity::wait_for()") virtual void wait(double timeout) = 0; XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_state()") Activity::State getState() { return state_; } - /** @deprecated See Activity::get_remaining() */ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_remaining()") double getRemains() { return get_remaining(); } - /** @deprecated See Activity::set_remaining() */ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_remaining()") Activity* setRemains(double remains) { return set_remaining(remains); } - /** @deprecated See Activity::set_user_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data) { return set_user_data(data); } - /** @deprecated See Activity::get_user_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; } #endif diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index a057630588..ff9c3737a0 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -44,7 +44,7 @@ public: Activity* start() override; Activity* wait() override; - Activity* wait(double timeout) override; + Activity* wait_for(double timeout) override; bool test() override; /** Start the comm, and ignore its result. It can be completely forgotten after that. */ @@ -79,39 +79,32 @@ public: MailboxPtr get_mailbox(); #ifndef DOXYGEN - /** @deprecated See Comm::set_rate() */ + 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); } - /** @deprecated See Comm::set_src_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff) { return set_src_data(buff); } - /** @deprecated See Comm::set_src_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size) { return set_src_data(buff, size); } - /** @deprecated See Comm::set_src_data_size() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size) { return set_src_data_size(size); } - /** @deprecated See Comm::set_dst_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff) { return set_dst_data(buff); } - /** @deprecated See Comm::set_dst_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size) { return set_dst_data(buff, size); } - /** @deprecated See Comm::get_dst_data_size() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize() { return get_dst_data_size(); } - /** @deprecated See Comm::get_mailbox() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") MailboxPtr getMailbox() { return get_mailbox(); } #endif diff --git a/include/simgrid/s4u/Exec.hpp b/include/simgrid/s4u/Exec.hpp index 94e64f3bda..18f00283e9 100644 --- a/include/simgrid/s4u/Exec.hpp +++ b/include/simgrid/s4u/Exec.hpp @@ -33,7 +33,7 @@ public: Activity* start() override; Activity* wait() override; - Activity* wait(double timeout) override; + Activity* wait_for(double timeout) override; Activity* cancel() override; bool test() override; @@ -47,23 +47,21 @@ public: double get_remaining() override; double get_remaining_ratio(); +#ifndef DOXYGEN //////////////// Deprecated functions - /** @deprecated See Exec::set_priority() */ + XBT_ATTRIB_DEPRECATED_v324("Please use Exec::wait_for()") void wait(double t) override { wait_for(t); } XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_priority()") ExecPtr setPriority(double priority) { return set_priority(priority); } - /** @deprecated See Exec::set_bound() */ XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_bound()") ExecPtr setBound(double bound) { return set_bound(bound); } - /** @deprecated See Exec::set_host() */ XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_host()") ExecPtr setHost(Host* host) { return set_host(host); } - /** @deprecated See Exec::get_host() */ XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_host()") Host* getHost() { return get_host(); } - /** @deprecated See Exec::get_remaining_ratio() */ XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_remaining_ratio()") double getRemainingRatio() { return get_remaining_ratio(); } +#endif private: Host* host_ = nullptr; diff --git a/include/simgrid/s4u/Io.hpp b/include/simgrid/s4u/Io.hpp index 2bbdb75042..2fb16f1c6f 100644 --- a/include/simgrid/s4u/Io.hpp +++ b/include/simgrid/s4u/Io.hpp @@ -35,13 +35,17 @@ public: Activity* start() override; Activity* wait() override; - Activity* wait(double timeout) override; + Activity* wait_for(double timeout) override; Activity* cancel() override; bool test() override; double get_remaining() override; sg_size_t get_performed_ioops(); +#ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v324("Please use Io::wait_for()") void wait(double t) override { wait_for(t); } +#endif + private: sg_size_t size_ = 0; sg_storage_t storage_ = nullptr; diff --git a/src/plugins/vm/VmLiveMigration.cpp b/src/plugins/vm/VmLiveMigration.cpp index 2cdd524126..72eadf5c11 100644 --- a/src/plugins/vm/VmLiveMigration.cpp +++ b/src/plugins/vm/VmLiveMigration.cpp @@ -104,9 +104,9 @@ sg_size_t MigrationTx::sendMigrationData(sg_size_t size, int stage, int stage2_r s4u::Activity* comm = nullptr; try { if (mig_speed > 0) - comm = mbox->put_init(msg, size)->set_rate(mig_speed)->wait(timeout); + comm = mbox->put_init(msg, size)->set_rate(mig_speed)->wait_for(timeout); else - comm = mbox->put_async(msg, size)->wait(); + comm = mbox->put_async(msg, size)->wait_for(timeout); } catch (xbt_ex& e) { if (comm) { sg_size_t remaining = static_cast(comm->get_remaining()); diff --git a/src/s4u/s4u_Comm.cpp b/src/s4u/s4u_Comm.cpp index a5d5e5f501..14741370c9 100644 --- a/src/s4u/s4u_Comm.cpp +++ b/src/s4u/s4u_Comm.cpp @@ -132,7 +132,7 @@ Activity* Comm::start() /** @brief Block the calling actor until the communication is finished */ Activity* Comm::wait() { - return this->wait(-1); + return this->wait_for(-1); } /** @brief Block the calling actor until the communication is finished, or until timeout @@ -141,7 +141,7 @@ Activity* Comm::wait() * * @param timeout the amount of seconds to wait for the comm termination. * Negative values denote infinite wait times. 0 as a timeout returns immediately. */ -Activity* Comm::wait(double timeout) +Activity* Comm::wait_for(double timeout) { switch (state_) { case State::FINISHED: diff --git a/src/s4u/s4u_Exec.cpp b/src/s4u/s4u_Exec.cpp index c864b65b17..8250f946a0 100644 --- a/src/s4u/s4u_Exec.cpp +++ b/src/s4u/s4u_Exec.cpp @@ -40,7 +40,7 @@ Activity* Exec::wait() return this; } -Activity* Exec::wait(double timeout) +Activity* Exec::wait_for(double timeout) { THROW_UNIMPLEMENTED; return this; diff --git a/src/s4u/s4u_Io.cpp b/src/s4u/s4u_Io.cpp index c80bd87635..25cb01261e 100644 --- a/src/s4u/s4u_Io.cpp +++ b/src/s4u/s4u_Io.cpp @@ -38,7 +38,7 @@ Activity* Io::wait() return this; } -Activity* Io::wait(double timeout) +Activity* Io::wait_for(double timeout) { THROW_UNIMPLEMENTED; return this; diff --git a/src/s4u/s4u_Mailbox.cpp b/src/s4u/s4u_Mailbox.cpp index 8156900c05..bcf03097f2 100644 --- a/src/s4u/s4u_Mailbox.cpp +++ b/src/s4u/s4u_Mailbox.cpp @@ -114,7 +114,7 @@ void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes, double timeou c->set_remaining(simulated_size_in_bytes); c->set_src_data(payload); // c->start() is optional. - c->wait(timeout); + c->wait_for(timeout); } s4u::CommPtr Mailbox::get_init() @@ -145,7 +145,7 @@ void* Mailbox::get(double timeout) void* res = nullptr; CommPtr c = get_init(); c->set_dst_data(&res, sizeof(res)); - c->wait(timeout); + c->wait_for(timeout); return res; } } // namespace s4u