@subsection s4u_ex_actors_start Starting and stoping actors
- <b>Creating actors</b>.
- @ref examples/s4u/actor-create/s4u-actor-create.cpp \n
+ @ref examples/s4u/actor-create/s4u-actor-create.cpp @n
Most actors are started from the deployment XML file, but there is other methods.
This example show them all.
- <b>Kill actors</b>.
- @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
+ @ref examples/s4u/actor-kill/s4u-actor-kill.cpp @n
Actors can forcefully stop other actors with the @ref
simgrid::s4u::Actor::kill(void) or the @ref
simgrid::s4u::Actor::kill(aid_t) methods.
- <b>Controling the actor life cycle from the XML</b>.
@ref examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
@ref examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
- \n
+ @n
You can specify a start time and a kill time in the deployment file.
- <b>Daemonize actors</b>
- @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp \n
+ @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp @n
Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular
actor into a daemon that will be automatically killed once the simulation is over.
@subsection s4u_ex_actors_synchro Inter-actors interactions
- <b>Suspend and Resume actors</b>.
- @ref examples/s4u/actor-suspend/s4u-actor-suspend.cpp \n
+ @ref examples/s4u/actor-suspend/s4u-actor-suspend.cpp @n
Actors can be suspended and resumed during their executions
thanks to the @ref simgrid::s4u::Actor::suspend and @ref simgrid::s4u::Actor::resume methods.
- <b>Migrating Actors</b>.
- @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
+ @ref examples/s4u/actor-migration/s4u-actor-migration.cpp @n
Actors can move or be moved from a host to another with the @ref
simgrid::s4u::this_actor::migrate() method.
- <b>Waiting for the termination of an actor</b> (joining on it)
- @ref examples/s4u/actor-join/s4u-actor-join.cpp \n
+ @ref examples/s4u/actor-join/s4u-actor-join.cpp @n
The simgrid::s4u::Actor::join() method allows to block the current
actor until the end of the receiving actor.
- <b>Yielding to other actor</b>.
- @ref examples/s4u/actor-yield/s4u-actor-yield.cpp\n
+ @ref examples/s4u/actor-yield/s4u-actor-yield.cpp@n
The simgrid::s4u::this_actor::yield() function interrupts the
execution of the current actor, leaving a chance to the other actors
that are ready to run at this timestamp.
also the tesh files in the example directories for details.
- <b>Communication replay</b>.
- @ref examples/s4u/replay-comm/s4u-replay-comm.cpp \n
+ @ref examples/s4u/replay-comm/s4u-replay-comm.cpp @n
Presents a set of event handlers reproducing classical communication
primitives (asynchronous send/receive at the moment).
- <b>I/O replay</b>.
- @ref examples/s4u/replay-storage/s4u-replay-storage.cpp \n
+ @ref examples/s4u/replay-storage/s4u-replay-storage.cpp @n
Presents a set of event handlers reproducing classical I/O
primitives (open, read, close).
@subsection s4u_ex_activity_comm Communications on the network
- <b>Basic asynchronous communications</b>.
- @ref examples/s4u/async-wait/s4u-async-wait.cpp \n
+ @ref examples/s4u/async-wait/s4u-async-wait.cpp @n
Illustrates how to have non-blocking communications, that are
communications running in the background leaving the process free
to do something else during their completion. The main functions
@ref simgrid::s4u::Comm::wait().
- <b>Waiting for all communications in a set</b>.
- @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n
+ @ref examples/s4u/async-waitall/s4u-async-waitall.cpp@n
The @ref simgrid::s4u::Comm::wait_all() function is useful when you want to block
until all activities in a given set have completed.
- <b>Waiting for the first completed communication in a set</b>.
- @ref examples/s4u/async-waitany/s4u-async-waitany.cpp\n
+ @ref examples/s4u/async-waitany/s4u-async-waitany.cpp@n
The @ref simgrid::s4u::Comm::wait_any() function is useful when you want to block
until one activity of the set completes, no matter which terminates
first.
@subsection s4u_ex_activity_exec Executions on the CPU
- <b>Basic execution</b>.
- @ref examples/s4u/exec-basic/s4u-exec-basic.cpp \n
+ @ref examples/s4u/exec-basic/s4u-exec-basic.cpp @n
The computations done in your program are not reported to the
simulated world, unless you explicitely request the simulator to pause
the actor until a given amount of flops gets computed on its simulated
get more resources.
- <b>Asynchronous execution</b>.
- @ref examples/s4u/exec-async/s4u-exec-async.cpp \n
+ @ref examples/s4u/exec-async/s4u-exec-async.cpp @n
You can start asynchronous executions, just like you would fire
background threads.
- <b>Monitoring asynchronous executions</b>.
- @ref examples/s4u/exec-monitor/s4u-exec-monitor.cpp \n
+ @ref examples/s4u/exec-monitor/s4u-exec-monitor.cpp @n
This example shows how to start an asynchronous execution, and
monitor its status.
- <b>Remote execution</b>.
- @ref examples/s4u/exec-remote/s4u-exec-remote.cpp \n
+ @ref examples/s4u/exec-remote/s4u-exec-remote.cpp @n
Before its start, you can change the host on which a given execution will occur.
- <b>Using Pstates on a host</b>
@ref examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp and
- @ref examples/platforms/energy_platform.xml \n
+ @ref examples/platforms/energy_platform.xml @n
Show how define a set of pstatesfor a host in the XML, and how the current
pstate can be accessed/changed with @ref simgrid::s4u::Host::getPstateSpeed and @ref simgrid::s4u::Host::setPstate.
- <b>Parallel tasks</b>
- @ref examples/s4u/exec-ptask/s4u-exec-ptask.cpp\n
+ @ref examples/s4u/exec-ptask/s4u-exec-ptask.cpp@n
These objects are convenient abstractions of parallel
computational kernels that span over several machines.
write actions on the storage resources.
- <b>Access to raw storage devices</b>.
- @ref examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp \n
+ @ref examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp @n
This example illustrates how to simply read and write data on a
simulated storage resource.
read and write. The file and disk sizes are also dealt with and can
result in short reads and short write, as in reality.
- - <b>File Management</b>. @ref examples/s4u/io-file-system/s4u-io-file-system.cpp \n
+ - <b>File Management</b>. @ref examples/s4u/io-file-system/s4u-io-file-system.cpp @n
This example illustrates the use of operations on files
(read, write, seek, tell, unlink, ...).
- <b>Remote I/O</b>.
- @ref examples/s4u/io-file-remote/s4u-io-file-remote.cpp \n
+ @ref examples/s4u/io-file-remote/s4u-io-file-remote.cpp @n
I/O operations on files can also be done in a remote fashion,
i.e. when the accessed disk is not mounted on the caller's host.
@subsection s4u_ex_activity_synchro Classical synchronization objects
- - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp \n
+ - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp @n
Shows how to use simgrid::s4u::Mutex synchronization objects.
@section s4u_ex_platf Interacting with the platform
- <b>Retrieving the list of hosts matching a given criteria</b>.
- @ref examples/s4u/engine-filtering/s4u-engine-filtering.cpp\n
+ @ref examples/s4u/engine-filtering/s4u-engine-filtering.cpp@n
Filtering the actors that match a given criteria is rather simple.
- <b>User-defined properties</b>.
@ref examples/s4u/platform-properties/s4u-platform-properties.cpp and
@ref examples/s4u/platform-properties/s4u-platform-properties_d.xml and
- @ref examples/platforms/prop.xml \n
+ @ref examples/platforms/prop.xml @n
You can attach arbitrary information to most platform elements from
the XML file, and then interact with these values from your
program. Note that the changes are not written into the XML file: they
@section s4u_ex_energy Simulating the energy consumption
- <b>Describing the energy profiles in the platform</b>
- @ref examples/platforms/energy_platform.xml \n
+ @ref examples/platforms/energy_platform.xml @n
This platform file contains the energy profile of each links and
hosts, which is necessary to get energy consumption predictions.
As usual, you should not trust our example, and you should strive
to double-check that your instanciation matches your target platform.
- <b>Consumption due to the CPU</b>
- @ref examples/s4u/energy-exec/s4u-energy-exec.cpp \n
+ @ref examples/s4u/energy-exec/s4u-energy-exec.cpp @n
This example shows how to retrieve the amount of energy consumed
by the CPU during computations, and the impact of the pstate.
- <b>Modeling the shutdown and boot of hosts</b>
@ref examples/s4u/energy-boot/platform_boot.xml
- @ref examples/s4u/energy-boot/s4u-energy-boot.cpp\n
+ @ref examples/s4u/energy-boot/s4u-energy-boot.cpp@n
Simple example of model of model for the energy consumption during
the host boot and shutdown periods.
options to see the task executions:
- <b>Platform tracing</b>.
- @ref examples/s4u/trace-platform/s4u-trace-platform.cpp \n
+ @ref examples/s4u/trace-platform/s4u-trace-platform.cpp @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
This section contains application examples that are somewhat larger
than the previous examples.
- - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.cpp\n
+ - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.cpp@n
This simple example just sends 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).
+ the simulators (as detailed in Section @ref options).
- - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u-app-token-ring.cpp \n
+ - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u-app-token-ring.cpp @n
Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
participant.
- - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u-app-masterworker.cpp \n
+ - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u-app-masterworker.cpp @n
Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
processes.
@subsection s4u_ex_app_data Data diffusion
- <b>Bit Torrent</b>
- @ref examples/s4u/app-bittorrent/s4u-bittorrent.cpp\n
+ @ref examples/s4u/app-bittorrent/s4u-bittorrent.cpp@n
Classical protocol for Peer-to-Peer data diffusion.
- <b>Chained send</b>
- @ref examples/s4u/app-chainsend/s4u-app-chainsend.cpp\n
+ @ref examples/s4u/app-chainsend/s4u-app-chainsend.cpp@n
Data broadcast over a ring of processes.
@subsection s4u_ex_app_dht Distributed Hash Tables (DHT)
- <b>Chord Protocol</b>
- @ref examples/s4u/dht-chord/s4u-dht-chord.cpp\n
+ @ref examples/s4u/dht-chord/s4u-dht-chord.cpp@n
One of the most famous DHT protocol.
*/
