X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/66fa1f8b56e161c3d46f91763a4edc82d9eb6cd1..17bac866a1ac98b2b9762acee5f4365b231cdb02:/examples/s4u/README.doc diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc index c581f801a2..78254fbd73 100644 --- a/examples/s4u/README.doc +++ b/examples/s4u/README.doc @@ -25,10 +25,10 @@ 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. - - Ping Pong: @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). + - Ping Pong: @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). - Token ring: @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 @@ -38,14 +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 - Basic asynchronous communications. @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 put_async and @ref get. + involved are @ref simgrid::s4u::Comm::put_async and + @ref simgrid::s4u::Comm::wait(). - Waiting for all communications in a set. @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n @@ -56,7 +57,7 @@ documentation, but it should remain readable directly. @ref examples/s4u/async-waitany/s4u-async-waitany.cpp\n The @ref simgrid::s4u::Comm::wait_any() function is useful when you want to block until one activity of the set completes, no matter which terminates - first. + first. @section s4u_ex_actors Acting on Actors @@ -64,6 +65,13 @@ 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. + - Actors using CPU time. + @ref examples/s4u/actor-execute/s4u-actor-execute.cpp \n + The computations done in your program are not reported to the + simulated world, unless you explicitely request the simulator to pause + the actor until a given amount of flops gets computed on its simulated + host. + - Daemonize actors @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 @@ -74,10 +82,21 @@ 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. + - Priority actors. + @ref examples/s4u/actor-priority/s4u-actor-priority.cpp \n + Actors can be launched according their priorities thanks to the @ref + execution method. + - Kill actors. @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n Actors can forcefully stop other actors with the @ref kill method. + - Controling the actor life cycle from the XML. + @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. + - Migrating Actors. @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. @@ -123,7 +142,10 @@ also the tesh files in the example directories for details. @example examples/s4u/actor-create/s4u-actor-create.cpp @example examples/s4u/actor-create/s4u-actor-create_d.xml @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