- @ref s4u_ex_platf
- @ref s4u_ex_energy
- @ref s4u_ex_tracing
- - @ref s4u_ex_examplars
+ - @ref s4u_ex_app
+ - @ref s4u_ex_app_data
+ - @ref s4u_ex_app_dht
TODO: document here the examples about plugins
- <b>Kill actors</b>.
@ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
Actors can forcefully stop other actors with the @ref
- simgrid::s4u::Actor::kill() method.
+ simgrid::s4u::Actor::kill(void) method.
+
+ - <b>Kill actors (other function)</b>.
+ @ref examples/s4u/actor-kill-pid/s4u-actor-kill-pid.cpp \n
+ Actors can forcefully stop other actors with the @ref
+ simgrid::s4u::Actor::kill(aid_t) method.
- <b>Controling the actor life cycle from the XML</b>.
@ref examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
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.
- TODO: add an example about parallel executions.
+ - <b>Parallel tasks</b>
+ @ref examples/s4u/exec-ptask/s4u-exec-ptask.cpp\n
+ These objects are convenient abstractions of parallel
+ computational kernels that span over several machines.
@subsection s4u_ex_activity_io I/O on disks and files
@section s4u_ex_energy Simulating the energy consumption
+ - <b>Describing the energy profiles in the platform</b>
+ @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
This example shows how to retrieve the amount of energy consumed
by the CPU during computations, and the impact of the pstate.
+ - <b>Consumption due to the network</b>
+ @ref examples/s4u/energy-link/s4u-energy-link.cpp
+ This example shows how to retrieve and display the energy consumed
+ by the network during communications.
+
+ - <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
+ Simple example of model of model for the energy consumption during
+ the host boot and shutdown periods.
+
@section s4u_ex_tracing Tracing and visualization features
Tracing can be activated by various configuration options which
@verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes
@endverbatim
-@section s4u_ex_examplars Larger SimGrid examplars
+@section s4u_ex_app Larger SimGrid examplars
This section contains application examples that are somewhat larger
than the previous examples.
- <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
+ Classical protocol for Peer-to-Peer data diffusion.
+
+ - <b>Chained send</b>
+ @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
+ One of the most famous DHT protocol.
*/
@example examples/s4u/async-wait/s4u-async-wait.cpp
@example examples/s4u/async-waitall/s4u-async-waitall.cpp
@example examples/s4u/async-waitany/s4u-async-waitany.cpp
+@example examples/s4u/app-bittorrent/s4u-bittorrent.cpp
+@example examples/s4u/app-chainsend/s4u-app-chainsend.cpp
+@example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
+@example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
+@example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
+@example examples/s4u/dht-chord/s4u-dht-chord.cpp
+@example examples/s4u/energy-boot/platform_boot.xml
+@example examples/s4u/energy-boot/s4u-energy-boot.cpp
+@example examples/s4u/energy-exec/s4u-energy-exec.cpp
+@example examples/s4u/energy-link/s4u-energy-link.cpp
@example examples/s4u/exec-basic/s4u-exec-basic.cpp
@example examples/s4u/exec-async/s4u-exec-async.cpp
@example examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
@example examples/s4u/exec-monitor/s4u-exec-monitor.cpp
+@example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
@example examples/s4u/exec-remote/s4u-exec-remote.cpp
-@example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
-@example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
-@example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
-@example examples/s4u/energy-exec/s4u-energy-exec.cpp
@example examples/s4u/io-file-system/s4u-io-file-system.cpp
@example examples/s4u/io-file-remote/s4u-io-file-remote.cpp
@example examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp
@example examples/platforms/energy_platform.xml
@example examples/platforms/prop.xml
-*/
\ No newline at end of file
+*/
