X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3368ca8f8b3fb922a94a217f0afc3243ae18c8f5..55c213429acfbb56f761aadbbf4f5144a2e7d5c2:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index c205e6c5ce..17df5019df 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2017. 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. */ @@ -197,20 +197,20 @@ public: /** This actor will be automatically terminated when the last non-daemon process finishes **/ void daemonize(); - /** Retrieves the name of that actor as a C string */ - const char* cname(); /** Retrieves the name of that actor as a C++ string */ - simgrid::xbt::string name(); + const simgrid::xbt::string& getName() const; + /** Retrieves the name of that actor as a C string */ + const char* getCname() const; /** Retrieves the host on which that actor is running */ - s4u::Host* host(); + s4u::Host* getHost(); /** Retrieves the PID of that actor * * actor_id_t is an alias for unsigned long */ - aid_t pid(); + aid_t getPid(); /** Retrieves the PPID of that actor * * actor_id_t is an alias for unsigned long */ - aid_t ppid(); + aid_t getPpid(); /** Suspend an actor by suspending the task on which it was waiting for the completion. */ void suspend(); @@ -232,7 +232,7 @@ public: /** Sets the time at which that actor should be killed */ void setKillTime(double time); /** Retrieves the time at which that actor will be killed (or -1 if not set) */ - double killTime(); + double getKillTime(); void migrate(Host * new_host); @@ -267,8 +267,9 @@ public: simix::ActorImpl* getImpl(); /** Retrieve the property value (or nullptr if not set) */ - const char* property(const char* key); + const char* getProperty(const char* key); void setProperty(const char* key, const char* value); + Actor* restart(); }; /** @ingroup s4u_api @@ -285,74 +286,81 @@ template inline void sleep_for(std::chrono::duration(duration); this_actor::sleep_for(seconds.count()); - } - template - inline void sleep_until(const SimulationTimePoint& timeout_time) - { - auto timeout_native = std::chrono::time_point_cast(timeout_time); - this_actor::sleep_until(timeout_native.time_since_epoch().count()); - } +} - XBT_ATTRIB_DEPRECATED("Use sleep_for()") - inline void sleep(double duration) - { - return sleep_for(duration); - } +template inline void sleep_until(const SimulationTimePoint& timeout_time) +{ + auto timeout_native = std::chrono::time_point_cast(timeout_time); + this_actor::sleep_until(timeout_native.time_since_epoch().count()); +} - /** Block the actor, computing the given amount of flops */ - XBT_PUBLIC(e_smx_state_t) execute(double flop); +XBT_ATTRIB_DEPRECATED_v320("Use sleep_for(): v3.20 will turn this warning into an error.") inline void sleep( + double duration) +{ + return sleep_for(duration); +} - /** Block the actor until it gets a message from the given mailbox. - * - * See \ref Comm for the full communication API (including non blocking communications). - */ - XBT_PUBLIC(void*) XBT_ATTRIB_DEPRECATED("Please use Mailbox::recv") recv(MailboxPtr chan); // 3.17 - XBT_PUBLIC(void*) XBT_ATTRIB_DEPRECATED("Please use Mailbox::recv") recv(MailboxPtr chan, double timeout); // 3.17 - XBT_PUBLIC(CommPtr) - XBT_ATTRIB_DEPRECATED("Please use Mailbox::recv_async") irecv(MailboxPtr chan, void** data); // 3.17 +/** Block the actor, computing the given amount of flops */ +XBT_PUBLIC(void) execute(double flop); +/** Block the actor, computing the given amount of flops at the given priority. + * An execution of priority 2 computes twice as fast as an execution at priority 1. */ +XBT_PUBLIC(void) execute(double flop, double priority); - /** Block the actor until it delivers a message of the given simulated size to the given mailbox - * - * See \ref Comm for the full communication API (including non blocking communications). - */ - XBT_PUBLIC(void) - XBT_ATTRIB_DEPRECATED("Please use Mailbox::send") send(MailboxPtr chan, void* payload, double simulatedSize); // 3.17 - XBT_PUBLIC(void) - XBT_ATTRIB_DEPRECATED("Please use Mailbox::send") - send(MailboxPtr chan, void* payload, double simulatedSize, double timeout); // 3.17 +/** Block the actor until it gets a message from the given mailbox. + * + * See \ref Comm for the full communication API (including non blocking communications). + */ +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*) + recv(MailboxPtr chan); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*) + recv(MailboxPtr chan, double timeout); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr) + irecv(MailboxPtr chan, void** data); + +/** Block the actor until it delivers a message of the given simulated size to the given mailbox + * + * See \ref Comm for the full communication API (including non blocking communications). +*/ +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void) + send(MailboxPtr chan, void* payload, double simulatedSize); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void) + send(MailboxPtr chan, void* payload, double simulatedSize, double timeout); - XBT_PUBLIC(CommPtr) - XBT_ATTRIB_DEPRECATED("Please use Mailbox::send_async") isend(MailboxPtr chan, void* payload, double simulatedSize); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr) + isend(MailboxPtr chan, void* payload, double simulatedSize); - /** @brief Returns the actor ID of the current actor (same as pid). */ - XBT_PUBLIC(aid_t) pid(); +/** @brief Returns the actor ID of the current actor). */ +XBT_PUBLIC(aid_t) getPid(); - /** @brief Returns the ancestor's actor ID of the current actor (same as ppid). */ - XBT_PUBLIC(aid_t) ppid(); +/** @brief Returns the ancestor's actor ID of the current actor. */ +XBT_PUBLIC(aid_t) getPpid(); - /** @brief Returns the name of the current actor. */ - XBT_PUBLIC(std::string) name(); +/** @brief Returns the name of the current actor. */ +XBT_PUBLIC(std::string) getName(); - /** @brief Returns the name of the host on which the process is running. */ - XBT_PUBLIC(Host*) host(); +/** @brief Returns the name of the current actor as a C string. */ +XBT_PUBLIC(const char*) getCname(); - /** @brief Suspend the actor. */ - XBT_PUBLIC(void) suspend(); +/** @brief Returns the name of the host on which the process is running. */ +XBT_PUBLIC(Host*) getHost(); - /** @brief Resume the actor. */ - XBT_PUBLIC(void) resume(); +/** @brief Suspend the actor. */ +XBT_PUBLIC(void) suspend(); - XBT_PUBLIC(bool) isSuspended(); +/** @brief Resume the actor. */ +XBT_PUBLIC(void) resume(); - /** @brief kill the actor. */ - XBT_PUBLIC(void) kill(); +XBT_PUBLIC(bool) isSuspended(); - /** @brief Add a function to the list of "on_exit" functions. */ - XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data); +/** @brief kill the actor. */ +XBT_PUBLIC(void) kill(); - /** @brief Migrate the actor to a new host. */ - XBT_PUBLIC(void) migrate(Host* new_host); -}; +/** @brief Add a function to the list of "on_exit" functions. */ +XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data); + +/** @brief Migrate the actor to a new host. */ +XBT_PUBLIC(void) migrate(Host* new_host); +} /** @} */