Merge branch 'actor-yield' of github.com:Takishipp/simgrid into actor-yield

[simgrid.git] / examples / s4u / README.doc

diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc
index 58bcb14..f626d7e 100644 (file)
--- a/examples/s4u/README.doc
+++ b/examples/s4u/README.doc
@@ -25,7 +25,7 @@ documentation, but it should remain readable directly.
     @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
+  - <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). 
@@ -82,19 +82,31 @@ documentation, but it should remain readable directly.
     Actors can be suspended and resumed during their executions
     thanks to the @ref suspend and @ref resume methods.
 
+    - <b>Priority actors</b>.
+    @ref examples/s4u/actor-priority/s4u-actor-priority.cpp \n
+    Actors can be launched according their priorities thanks to the @ref
+     execution method.
+
   - <b>Kill actors</b>.
     @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
     Actors can forcefully stop other actors with the @ref kill method.
 
-  - <b>Controling the actor life cycle</b>.
-    @ref examples/s4u/actor-startkilltime/s4u-actor-startkilltime.cpp \n
-    You can specify a start time and a kill time in the deployment
-    file. See all *_d.xml files in this directory.    
+  - <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
+    You can specify a start time and a kill time in the deployment file.
 
   - <b>Migrating Actors</b>.
     @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
     Actors can move or be moved from a host to another with the @ref migrate method.
 
+  - <b>Yielding to other actor</b>.
+    @ref examples/s4u/actor-yield/s4u-actor-yield.c\n
+    The @ref yield function interrupts the execution of the
+    current actor, leaving a chance to run to the other actor
+    that are ready to run at the exact same timestamp
+
 @section s4u_ex_synchro Inter-Actor Synchronization 
 
  - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp \n
@@ -138,6 +150,8 @@ also the tesh files in the example directories for details.
 @example examples/s4u/actor-daemon/s4u-actor-daemon.cpp
 @example examples/s4u/actor-execute/s4u-actor-execute.cpp
 @example examples/s4u/actor-kill/s4u-actor-kill.cpp
+@example examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp 
+@example examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml 
 @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