X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f934c17cc5f1cb03e8dda185651a800ad4caee1b..HEAD:/include/simgrid/engine.h

diff --git a/include/simgrid/engine.h b/include/simgrid/engine.h
index 4582699518..b5b652485e 100644
--- a/include/simgrid/engine.h
+++ b/include/simgrid/engine.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018. 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,18 +7,57 @@
 #define INCLUDE_SIMGRID_ENGINE_H_
 
 #include <simgrid/forward.h>
+#include <stddef.h>
 
-/* C interface */
-SG_BEGIN_DECL()
-XBT_PUBLIC void simgrid_init(int* argc, char** argv);
+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);
+
+/** Creates a new platform, including hosts, links, and the routing table.
+ *
+ * \beginrst
+ * See also: :ref:`platform`.
+ * \endrst
+ */
 XBT_PUBLIC void simgrid_load_platform(const char* filename);
+/** Load a deployment file and launch the actors that it contains
+ *
+ * \beginrst
+ * See also: :ref:`deploy`.
+ * \endrst
+ */
 XBT_PUBLIC void simgrid_load_deployment(const char* filename);
+/** Run the simulation until its end */
 XBT_PUBLIC void simgrid_run();
-XBT_PUBLIC void simgrid_register_function(const char* name, int (*code)(int, char**));
-XBT_PUBLIC void simgrid_register_default(int (*code)(int, char**));
+/** 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/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();
+/* 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
+ * even if the user is asking for help.
+ */
 XBT_PUBLIC void sg_config_continue_after_help();
-SG_END_DECL()
+
+SG_END_DECL
 
 #endif /* INCLUDE_SIMGRID_ENGINE_H_ */