convert actor-startkilltime to s4u API

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

diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc
index 78c9933..03a5508 100644 (file)
--- a/examples/s4u/README.doc
+++ b/examples/s4u/README.doc
@@ -38,7 +38,15 @@ documentation, but it should remain readable directly.
     Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker 
     processes. 
     
-@section msg_ex_async Asynchronous communications
+@section s4u_ex_async Asynchronous communications
+
+ - <b>Basic asynchronous communications</b>. 
+   @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
+   involved are @ref simgrid::s4u::Comm::put_async and 
+   @ref simgrid::s4u::Comm::wait().
 
  - <b>Waiting for all communications in a set</b>.
    @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n
@@ -71,6 +79,11 @@ documentation, but it should remain readable directly.
     @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>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.