Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
s4u is not that bad anymore
[simgrid.git] / examples / s4u / README.doc
index d905d18..a77c73e 100644 (file)
@@ -1,9 +1,9 @@
 S4U (Simgrid for you) is the next interface of SimGrid, expected to be released with SimGrid 4.0.
 
-Even if it's in a very preliminary state so far, you are welcome to
-try it and report any interface glitches that you see. Be however
-warned that the interface will be modified until its final release. 
-You will have to adapt your code on the way.
+Even if it is not completely rock stable yet, it may well already fit
+your needs. You are welcome to try it and report any interface
+glitches that you see. Be however warned that the interface may change
+until its final release.  You will have to adapt your code on the way.
 
 This file follows the Doxygen syntax to be included in the
 documentation, but it should remain readable directly.
@@ -24,6 +24,11 @@ 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
+   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,6 +43,11 @@ 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/s4u_actor-suspend.cpp \n
     Actors can be suspended and resumed during their executions
@@ -91,13 +101,14 @@ also the tesh files in the example directories for details.
 @example examples/s4u/actions-storage/s4u_actions-storage.cpp
 @example examples/s4u/actor-create/s4u_actor-create.cpp
 @example examples/s4u/actor-create/s4u_actor-create_d.xml
-@example examples/s4u/actor-kill/actor-kill.cpp
+@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-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