Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #200 from Takishipp/clear_fct
[simgrid.git] / examples / s4u / README.doc
index 32534ff..c875b41 100644 (file)
@@ -20,10 +20,15 @@ documentation, but it should remain readable directly.
 
 @section s4u_ex_basics Basics of SimGrid simulation
 
-  - <b>Launching actors:</b> @ref examples/s4u/launching/s4u_launching.cpp and 
-    @ref examples/s4u/launching/deployment.xml \n
+  - <b>Creating actors:</b> @ref examples/s4u/actor-create/s4u_actor-create.cpp and 
+    @ref examples/s4u/actor-create/s4u_actor-create_d.xml \n
     Shows how to start your actors to populate your simulation.
 
+  - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u_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/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.
@@ -38,13 +43,18 @@ documentation, but it should remain readable directly.
     @ref examples/s4u/actor-create/s4u_actor-create.cpp \n
     Most actors are started from the deployment XML file, but they exist other methods.
 
+  - <b>Daemonize actors</b>
+    @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. 
+
   - <b>Suspend and Resume actors</b>.
-    @ref examples/s4u/actor-suspend/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 suspend and @ref resume methods.
 
   - <b>Kill actors</b>.
-    @ref examples/s4u/actor-kill/actor-kill.cpp \n
+    @ref examples/s4u/actor-kill/s4u_actor-kill.cpp \n
     Actors can forcefully stop other actors with the @ref kill method.
 
   - <b>Migrating Actors</b>.
@@ -90,14 +100,15 @@ also the tesh files in the example directories for details.
 @example examples/s4u/actions-comm/s4u_actions-comm.cpp
 @example examples/s4u/actions-storage/s4u_actions-storage.cpp
 @example examples/s4u/actor-create/s4u_actor-create.cpp
-@example examples/s4u/actor-kill/actor-kill.cpp
+@example examples/s4u/actor-create/s4u_actor-create_d.xml
+@example examples/s4u/actor-daemon/s4u_actor-daemon.cpp
+@example examples/s4u/actor-kill/s4u_actor-kill.cpp
 @example examples/s4u/actor-migration/s4u_actor-migration.cpp
 @example examples/s4u/actor-suspend/s4u_actor-suspend.cpp
 @example examples/s4u/app-token-ring/s4u_app-token-ring.cpp
-@example examples/s4u/app-master-worker/s4u_app-master-worker.cpp
-@example examples/s4u/launching/deployment.xml
+@example examples/s4u/app-masterworker/s4u_app-masterworker.cpp
+@example examples/s4u/app-pingpong/s4u_app-pingpong.cpp
 
-@example examples/s4u/launching/s4u_launching.cpp
 @example examples/s4u/mutex/s4u_mutex.cpp
 
 */
\ No newline at end of file