Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix a java test
[simgrid.git] / examples / msg / README.doc
index baefe26..1687897 100644 (file)
@@ -2,7 +2,7 @@ This file follows the Doxygen syntax to be included in the
 documentation, but it should remain readable directly.
 
 /** 
- @defgroup MSG_examples MSG examples
+ @defgroup msg_examples MSG examples
  @ingroup MSG_API
  @brief Find the MSG example fitting your needs from the extensive set provided in the archive.
 
@@ -38,7 +38,7 @@ documentation, but it should remain readable directly.
    @ref examples/msg/app-masterworker/app-masterworker.c\n
    Another good old example, where one Master process has a bunch of
    task to dispatch to a set of several Worker processes. It is fully
-   commented in @ref MSG_ex_master_worker.
+   commented in @ref msg_ex_master_worker.
 
 @section msg_ex_async Asynchronous communications
 
@@ -64,6 +64,12 @@ shipped in the archive:
    The @ref MSG_comm_waitany function is useful when you want to block
    until one activity of the set completes, no matter which terminates
    first.
+   
+ - <b>Yielding to other processes</b>.
+   @ref examples/msg/async-yield/async-yield.c\n
+   The @ref MSG_process_yield function interrupts the execution of the
+   current process, leaving a chance to run to the other processes
+   that are ready to run at the exact same timestamp
 
 @section msg_ex_process Acting on Processes
 
@@ -276,6 +282,7 @@ top of the example file).
 @example examples/msg/async-wait/async-wait.c
 @example examples/msg/async-waitall/async-waitall.c
 @example examples/msg/async-waitany/async-waitany.c
+@example examples/msg/async-yield/async-yield.c
 
 @example examples/msg/process-create/process-create.c
 @example examples/msg/process-suspend/process-suspend.c