Add new entry in Release_Notes.

[simgrid.git] / include / simgrid / engine.h

diff --git a/include/simgrid/engine.h b/include/simgrid/engine.h
index 95b9ae4..b5b6524 100644 (file)
--- a/include/simgrid/engine.h
+++ b/include/simgrid/engine.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2018-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. */
@@ -7,10 +7,13 @@
 #define INCLUDE_SIMGRID_ENGINE_H_
 
 #include <simgrid/forward.h>
+#include <stddef.h>
 
 SG_BEGIN_DECL /* C interface */
+
 /** Initialize the SimGrid engine, taking the command line parameters of your main function. */
-XBT_PUBLIC void simgrid_init(int* argc, char** argv);
+XBT_PUBLIC void
+simgrid_init(int* argc, char** argv);
 
 /** Creates a new platform, including hosts, links, and the routing table.
  *
@@ -26,26 +29,31 @@ XBT_PUBLIC void simgrid_load_platform(const char* filename);
  * \endrst
  */
 XBT_PUBLIC void simgrid_load_deployment(const char* filename);
-/** Run the simulation after initialization */
+/** Run the simulation until its end */
 XBT_PUBLIC void simgrid_run();
+/** Run the simulation until the specified date */
+XBT_PUBLIC void simgrid_run_until(double max_date);
 /** Registers the main function of an actor that will be launched from the deployment file */
 XBT_PUBLIC void simgrid_register_function(const char* name, void (*code)(int, char**));
 /** Registers a function as the default main function of actors
  *
  * It will be used as fallback when the function requested from the deployment file was not registered.
- * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
+ * It is used for trace-based simulations (see examples/cpp/replay-comms and similar).
  */
 XBT_PUBLIC void simgrid_register_default(void (*code)(int, char**));
 /** Retrieve the simulation time (in seconds) */
 XBT_PUBLIC double simgrid_get_clock();
-/** Retrieve the number of actors in the simulation */
-XBT_PUBLIC int simgrid_get_actor_count();
+/* Set some code to execute in the maestro (must be used before the engine creation)
+ *
+ * If no maestro code is registered (the default), the main thread
+ * is assumed to be the maestro. */
+XBT_PUBLIC void simgrid_set_maestro(void (*code)(void*), void* data);
 
 /** @brief Allow other libraries to react to the --help flag, too
  *
- * When finding --help on the command line, simgrid usually stops right after displaying its help message.
- * If you are writing a library using simgrid, you may want to display your own help message before everything stops.
- * If so, just call this function before having simgrid parsing the command line, and you will be given the control
+ * When finding --help on the command line, SimGrid usually stops right after displaying its help message.
+ * If you are writing a library using SimGrid, you may want to display your own help message before everything stops.
+ * If so, just call this function before having SimGrid parsing the command line, and you will be given the control
  * even if the user is asking for help.
  */
 XBT_PUBLIC void sg_config_continue_after_help();