examples/s4u/README.doc

   1 S4U (Simgrid for you) is the next interface of SimGrid, expected to be released with SimGrid 4.0.
   2
   3 Even if it's in a very preliminary state so far, you are welcome to
   4 try it and report any interface glitches that you see. Be however
   5 warned that the interface will be modified until its final release.
   6 You will have to adapt your code on the way.
   7
   8 This file follows the Doxygen syntax to be included in the
   9 documentation, but it should remain readable directly.
  10
  11 /**
  12  @defgroup s4u_examples S4U examples
  13  @ingroup s4u_api
  14  @brief Find the S4U example fitting your needs in the archive.
  15
  16   - @ref s4u_ex_basics
  17   - @ref s4u_ex_synchro
  18
  19 @section s4u_ex_basics Basics of SimGrid simulation
  20
  21   - <b>Launching actors:</b> @ref examples/s4u/launching/s4u_launching.cpp and
  22     @ref examples/s4u/launching/deployment.xml \n
  23     Shows how to start your actors to populate your simulation.
  24
  25   - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n
  26     Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
  27     participant.
  28
  29   - <b>Master Workers:</b> @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n
  30     Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
  31     processes.
  32
  33 @section s4u_ex_synchro Inter-Actor Synchronization
  34
  35  - <b>Mutex: </b> @ref examples/s4u/mutex/s4u_mutex.cpp \n
  36    Shows how to use simgrid::s4u::Mutex synchronization objects.
  37
  38 */
  39
  40 /**
  41 @example examples/s4u/launching/s4u_launching.cpp
  42 @example examples/s4u/app-token-ring/s4u_app-token-ring.cpp
  43 @example examples/s4u/app-master-worker/s4u_app-master-worker.cpp
  44 @example examples/s4u/launching/deployment.xml
  45
  46 @example examples/s4u/mutex/s4u_mutex.cpp
  47
  48 */