X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ea74f5d95928a521a588737e81f1de94eef25d19..d7bc42299b363a112f3b8154e95cd80706cda6d2:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 28f59a7b4c..56af65fe32 100644 --- a/include/simgrid/s4u/Engine.hpp +++ b/include/simgrid/s4u/Engine.hpp @@ -42,7 +42,7 @@ public: #endif /** Finalize the default engine and all its dependencies */ - void shutdown(); + XBT_ATTRIB_DEPRECATED_v335("Users are not supposed to shutdown the Engine") void shutdown(); /** Run the simulation until its end */ void run() const; @@ -60,13 +60,17 @@ public: void load_platform(const std::string& platf) const; void seal_platform() const; + /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking classical argc/argv parameters. See the :ref:`example `. @endverbatim */ void register_function(const std::string& name, const std::function& code); + /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking a vector of strings as a parameter. See the :ref:`example `. @endverbatim */ void register_function(const std::string& name, const std::function)>& code); void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory); + /** @verbatim embed:rst:inline Provide a default function to be used when the name used in a :ref:`pf_tag_actor` tag was not binded with ``register_function`` nor ``register_actor``. @endverbatim */ void register_default(const std::function& code); void register_default(const kernel::actor::ActorCodeFactory& factory); + /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a class name passed as a template parameter. See the :ref:`example `. @endverbatim */ template void register_actor(const std::string& name) { kernel::actor::ActorCodeFactory code_factory = [](std::vector args) { @@ -77,6 +81,7 @@ public: }; register_function(name, code_factory); } + /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function name passed as a parameter. See the :ref:`example `. @endverbatim */ template void register_actor(const std::string& name, F code) { kernel::actor::ActorCodeFactory code_factory = [code](std::vector args) { @@ -88,6 +93,7 @@ public: /** If non-null, the provided set will be filled with all activities that fail to start because of a veto */ void track_vetoed_activities(std::set* vetoed_activities) const; + /** @verbatim embed:rst:inline Load a deployment file. See:ref:`deploy` and the :ref:`example `. @endverbatim */ void load_deployment(const std::string& deploy) const; protected: @@ -99,12 +105,9 @@ protected: friend kernel::routing::NetZoneImpl; friend kernel::resource::HostImpl; friend kernel::resource::StandardLinkImpl; - void host_register(const std::string& name, Host* host); - void host_unregister(const std::string& name); - void link_register(const std::string& name, const Link* link); - void link_unregister(const std::string& name); void netpoint_register(simgrid::kernel::routing::NetPoint* card); void netpoint_unregister(simgrid::kernel::routing::NetPoint* card); + void set_netzone_root(const NetZone* netzone); #endif /*DOXYGEN*/ public: @@ -148,7 +151,6 @@ public: kernel::routing::NetPoint* netpoint_by_name(const std::string& name) const; NetZone* get_netzone_root() const; - void set_netzone_root(const NetZone* netzone); NetZone* netzone_by_name_or_null(const std::string& name) const; @@ -194,7 +196,8 @@ public: static void set_config(const std::string& name, double value); static void set_config(const std::string& name, const std::string& value); - Engine* set_default_comm_data_copy_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t)); + Engine* + set_default_comm_data_copy_callback(const std::function& callback); /** Add a callback fired when the platform is created (ie, the xml file parsed), * right before the actual simulation starts. */ @@ -202,10 +205,15 @@ public: /** Add a callback fired when the platform is about to be created * (ie, after any configuration change and just before the resource creation) */ static void on_platform_creation_cb(const std::function& cb) { on_platform_creation.connect(cb); } + /** Add a callback fired when the main simulation loop starts, at the beginning of the first call to Engine::run() */ + static void on_simulation_start_cb(const std::function& cb) { on_simulation_start.connect(cb); } /** Add a callback fired when the main simulation loop ends, just before the end of Engine::run() */ static void on_simulation_end_cb(const std::function& cb) { on_simulation_end.connect(cb); } - /** Add a callback fired when the time jumps into the future */ + /** Add a callback fired when the time jumps into the future. + * + * It is fired right after the time change (use get_clock() to get the new timestamp). + * The callback parameter is the time delta since previous timestamp. */ static void on_time_advance_cb(const std::function& cb) { on_time_advance.connect(cb); } /** Add a callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each @@ -217,10 +225,13 @@ public: static xbt::signal on_platform_created; static xbt::signal on_platform_creation; #endif + private: - static xbt::signal on_simulation_end; + static xbt::signal on_simulation_start; static xbt::signal on_time_advance; static xbt::signal on_deadlock; + static xbt::signal on_simulation_end; + kernel::EngineImpl* const pimpl; static Engine* instance_; void initialize(int* argc, char** argv);