From eb06cc6409cdd8e1e9955e4455d104ca0cf437b3 Mon Sep 17 00:00:00 2001 From: Takishipp Date: Wed, 6 Sep 2017 16:06:55 +0200 Subject: [PATCH 1/1] add a description to s4u for the treated examples --- examples/s4u/README.doc | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc index c875b412e5..228552eb29 100644 --- a/examples/s4u/README.doc +++ b/examples/s4u/README.doc @@ -14,6 +14,7 @@ documentation, but it should remain readable directly. @brief Find the S4U example fitting your needs in the archive. - @ref s4u_ex_basics + - @ref s4u_ex_async - @ref s4u_ex_actors - @ref s4u_ex_synchro - @ref s4u_ex_actions @@ -36,6 +37,19 @@ documentation, but it should remain readable directly. - Master Workers: @ref examples/s4u/app-masterworker/s4u_app-masterworker.cpp \n 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 + + - Waiting for all communications in a set. + @ref examples/s4u/async-waitall/s4u_async-waitall.cpp\n + The @ref S4U_comm_waitall function is useful when you want to block + until all activities in a given set have completed. + + - Waiting for the first completed communication in a set. + @ref examples/s4u/async-waitany/s4u_async-waitany.cpp\n + The @ref S4U_comm_waitany function is useful when you want to block + until one activity of the set completes, no matter which terminates + first. @section s4u_ex_actors Acting on Actors -- 2.20.1