@section msg_ex_process Acting on Processes
+ - <b>Creating processes</b>.
+ @ref examples/msg/process-create/process-create.c \n
+ Most processes are started from the deployment XML file, but they
+ can also be used with the @ref MSG_process_create() function.
+
- <b>Suspend and Resume processes</b>.
@ref examples/msg/process-suspend/process-suspend.c \n
Processes can be suspended and resumed during their executions
You can specify a start time and a kill time in the deployment
file. See all *_d.xml files in this directory.
-TODO: add an example using @ref MSG_process_create()
-
@section msg_ex_tracing Tracing and visualization features
Tracing can be activated by various configuration options which
are illustrated in these example. See also the
@ref tracing_tracing_options "full list of options related to tracing".
- - <b>Basic example</b>. @ref examples/msg/trace-simple/trace-simple.c \n
- In this very simple program, each process creates, executes,
- and destroy a task. Recommanded options:
- @verbatim --cfg=tracing:yes --cfg=tracing/uncategorized:yes @endverbatim
+It is interesting to run the process-create example with the following
+options to see the task executions:
- <b>Platform tracing</b>.
@ref examples/msg/trace-platform/trace-platform.c \n
constituting a fully working non-trivial example. This
implementation is also very efficient, as demonstrated in
http://hal.inria.fr/inria-00602216/
-
- - @ref examples/msg/task-priority/task-priority.c \n
- - @ref examples/msg/properties/properties.c \n
+@section msg_ex_misc Miscellaneous
+
+ - <b>Task priorities</b>.
+ @ref examples/msg/task-priority/task-priority.c \n
+ Demonstrates the use of @ref MSG_task_set_priority to change the
+ computation priority of a given task.
+
+ - <b>User-defined properties</b>.
+ @ref examples/msg/platform-properties/platform-properties.c \n
+ Attaching arbitrary information to host, processes and
+ such, and retrieving them with @ref MSG_host_get_properties,
+ @ref MSG_host_get_property_value, @ref MSG_process_get_properties, and
+ @ref MSG_process_get_property_value. Also make sure to read the
+ platform and deployment XML files to see how to declare these data.
+
+TODO: Document the many other examples that we have
*/
As a human, you can stop reading at this point. The rest is garbage:
Every example must be listed in the following, but it's not possible
-to move this content upper as each @example directive seems to eat the
-next doxygen commands (and the content is placed at the top of the
-example file).
+to move this content upper as each @example directive seems to eat
+everything until the next */ marker (and the content is placed at the
+top of the example file).
/**
@example examples/msg/async-waitall/async-waitall.c
@example examples/msg/async-waitall/async-waitany.c
+@example examples/msg/process-create/process-create.c
@example examples/msg/process-suspend/process-suspend.c
@example examples/msg/process-kill/process-kill.c
@example examples/msg/process-migration/process-migration.c
@example examples/msg/process-startkilltime/process-startkilltime.c
-@example examples/msg/trace-simple/trace-simple.c
@example examples/msg/trace-platform/trace-platform.c
@example examples/msg/trace-categories/trace-categories.c
@example examples/msg/trace-masterworker/trace-masterworker.c
*/
-Basic examples and features
-===========================
-
- * properties/msg_prop.c Attaching arbitrary information to host,
- processes and such, and retrieving them with
- MSG_host_get_properties(), MSG_host_get_property_value(),
- MSG_process_get_properties() and MSG_process_get_property_value().
- Also make sure to read the platform and deployment XML files to see
- how to declare these data.
-
- * parallel_task/parallel_task.c: Demonstrates the use of
- MSG_parallel_task_create(), to create special tasks that run on
- several hosts at the same time. The resulting simulations are very
- close to what can be achieved in SimDag, but still allows to use
- the other features of MSG (it'd be cool to be able to mix
- interfaces, but it's not possible ATM).
-
- * priority/priority.c: Demonstrates the use of
- MSG_task_set_priority() to change the computation priority of a
- given task.
-
-Examples of full applications
-=============================
-
- * chord/chord.c: Classical Chord P2P protocol This example implements
- the well known Chord P2P protocol. Its main advantage is that it
- constitute a fully working non-trivial example. In addition, its
- implementation is rather efficient, as demonstrated in
- [57]http://hal.inria.fr/inria-00602216/
-
-
