-This file follows the Doxygen syntax to be included in the
-documentation, but it should remain readable directly.
+// This file follows the Doxygen syntax to be included in the
+// documentation, but it should remain readable directly.
/**
@defgroup msg_examples MSG examples
- @ref msg_ex_tracing_user_variables
- @ref msg_ex_models
- @ref msg_ex_ns3
- - @ref msg_ex_apps
- - @ref msg_ex_misc
-@section msg_ex_basics Basic examples and features
-
- - <b>Ping Pong</b>: @ref examples/msg/app-pingpong/app-pingpong.c\n
- It's hard to think of a simpler example: it is just sending one
- message back and forth.
- The tesh file laying in the directory show how to start the
- simulator binary, highlighting how to pass options to the simulators
- (as detailed in Section \ref options).
+@warning MSG was deprecated in SimGrid v3.18. These examples should be
+ converted to S4U in the next releases. You really should
+ consider using S4U in your next project.
- - <b>Token Ring</b>.
- @ref examples/msg/app-token-ring/app-token-ring.c\n
- Classical communication pattern, where a token is exchanged
- along a ring to reach every participant.
- The tesh file laying in the directory shows how to run the same
- example on different virtual platforms.
+@section msg_ex_basics Basic examples and features
- <b>Master Workers</b>.
@ref examples/msg/app-masterworker/app-masterworker.c\n
Another good old example, where one Master process has a bunch of
- task to dispatch to a set of several Worker processes. It is fully
- commented in @ref msg_ex_master_worker.
+ task to dispatch to a set of several Worker processes.
@section msg_ex_process Acting on Processes
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
- This program is a toy example just loading the platform, so that
- you can play with the platform visualization. Recommanded options:
- @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes
- @endverbatim
-
- <b>Setting Categories</b>.
@ref examples/msg/trace-categories/trace-categories.c \n
This example declares several tracing categories
*/
-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
-everything until the next */ marker (and the content is placed at the
-top of the example file).
+// 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
+// everything until the next */ marker (and the content is placed at the
+// top of the example file).
/**
-@example examples/msg/app-pingpong/app-pingpong.c
-@example examples/msg/app-token-ring/app-token-ring.c
@example examples/msg/app-masterworker/app-masterworker.c
@example examples/msg/process-create/process-create.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
@example examples/msg/trace-process-migration/trace-process-migration.c