- @ref msg_ex_tracing_user_variables
- @ref msg_ex_models
- @ref msg_ex_ns3
- - @ref msg_ex_io
- @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).
-
- <b>Token Ring</b>.
@ref examples/msg/app-token-ring/app-token-ring.c\n
Classical communication pattern, where a token is exchanged
Most processes are started from the deployment XML file, but they
can also be used with the @ref MSG_process_create() function.
- - <b>Controling the process life cycle from the XML</b>.
- @ref examples/msg/process-startkilltime/process-startkilltime.c \n
- You can specify a start time and a kill time in the deployment
- file. See all *_d.xml files in this directory.
-
- - <b>Using Pstates on a host</b>
- @ref examples/msg/energy-pstate/energy-pstate.c\n
- Show how define a set of pstates for a host and how the current
- pstate can be accessed/changed with @ref MSG_get_host_current_power_peak and @ref MSG_set_host_pstate.
- See also the platform XML file for have a details on how to declare the CPU capacity for each pstate.
-
@section msg_ex_tracing Tracing and visualization features
Tracing can be activated by various configuration options which
TODO: show the XML files instead if it's what is interesting. On a "XML example files" page that does not exist yet.
-@subsection msg_ex_io Simulating disks and files
-
-The examples of this section demonstrate how to interact with the
-simulated storages.
-
- - <b>File Management</b>. @ref examples/msg/io-file/io-file.c \n
- This example illustrates the use of operations on file
- (@ref MSG_file_open, @ref MSG_file_read, @ref MSG_file_write,
- or @ref MSG_file_close).
-
- - <b>Remote I/O</b>. @ref examples/msg/io-remote/io-remote.c \n
- I/O operations can also be done in a remote, i.e. when the
- accessed disk is not mounted on the caller's host.
-
-@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:
/**
-@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/process-startkilltime/process-startkilltime.c
@example examples/msg/trace-platform/trace-platform.c
@example examples/msg/trace-categories/trace-categories.c
@example examples/msg/network-ns3/network-ns3.c
-@example examples/msg/io-storage/io-storage.c
-@example examples/msg/io-file/io-file.c
-@example examples/msg/io-remote/io-remote.c
-
-@example examples/msg/task-priority/task-priority.c
-@example examples/msg/platform-properties/platform-properties.c
-
*/
