X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/786f43e47b82994eed8e04d98192896dfec0fc43..fa70aa3d80a1580eae84757de1ff4c0cf067d279:/examples/s4u/README.rst diff --git a/examples/s4u/README.rst b/examples/s4u/README.rst index d7f8291f70..23a3e9c92b 100644 --- a/examples/s4u/README.rst +++ b/examples/s4u/README.rst @@ -155,24 +155,33 @@ Communications on the Network - **Basic asynchronous communications:** 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 :cpp:func:`simgrid::s4u::Mailbox::put_async()` and - :cpp:func:`simgrid::s4u::Comm::wait()`. - |br| `examples/s4u/async-wait/s4u-async-wait.cpp `_ + to do something else during their completion. + + - |cpp| `examples/s4u/async-wait/s4u-async-wait.cpp `_ + :cpp:func:`simgrid::s4u::Mailbox::put_async()` and :cpp:func:`simgrid::s4u::Comm::wait()` + - |py| `examples/python/async-wait/async-wait.py `_ + :py:func:`simgrid.Mailbox.put_async()` :py:func:`simgrid.Comm.wait()` - **Waiting for all communications in a set:** - The :cpp:func:`simgrid::s4u::Comm::wait_all()` function is useful - when you want to block until all activities in a given set have - completed. - |br| `examples/s4u/async-waitall/s4u-async-waitall.cpp `_ + The `wait_all()` function is useful when you want to block until + all activities in a given set have completed. + + - |cpp| `examples/s4u/async-waitall/s4u-async-waitall.cpp `_ + :cpp:func:`simgrid::s4u::Comm::wait_all()` + - |py| `examples/python/async-waitall/async-waitall.py `_ + :py:func:`simgrid.Comm.wait_all()` - **Waiting for the first completed communication in a set:** - The :cpp:func:`simgrid::s4u::Comm::wait_any()` function is useful + The `wait_any()` function is useful when you want to block until one activity of the set completes, no - matter which terminates first. - |br| `examples/s4u/async-waitany/s4u-async-waitany.cpp `_ - -.. todo:: add the `ready` example here + matter which terminates first. + + - |cpp| `examples/s4u/async-waitany/s4u-async-waitany.cpp `_ + :cpp:func:`simgrid::s4u::Comm::wait_any()` + - |py| `examples/python/async-waitany/async-waitany.py `_ + :py:func:`simgrid.Comm.wait_any()` + +.. todo:: review the `ready` and `waituntil` examples and add them here. .. _s4u_ex_execution: