From ee72a3c9b1fc8095018178438c41e82b6f79815a Mon Sep 17 00:00:00 2001 From: FREDERIC SUTER Date: Wed, 5 Sep 2018 12:56:09 +0200 Subject: [PATCH] Update app_s4u.rst --- docs/source/app_s4u.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index f386d13bec..a5ae90e27f 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -17,8 +17,8 @@ The S4U Interface
The S4U interface (SimGrid for you) mixes the full power of SimGrid -with the full power of C++. This is the prefered interface to describe -abstract algorithms in the domains of Cloud, P2P, HPC, IoT and similar +with the full power of C++. This is the preferred interface to describe +abstract algorithms in the domains of Cloud, P2P, HPC, IoT, and similar settings. ------------- @@ -34,12 +34,12 @@ S4U interface to express their and other |Activities|_, so that they get reflected within the simulator. These activities take place on resources such as |Hosts|_, |Links|_ and |Storages|_. SimGrid predicts the time taken by each -activity and orchestrates accordingly the actors waiting for the +activity and orchestrates the actors accordingly, waiting for the completion of these activities. When **communicating**, data is not directly sent to other actors but -posted onto a |Mailbox|_ that serve as rendez-vous point between +posted onto a |Mailbox|_ that serves as a rendez-vous point between communicating actors. This means that you don't need to know who you are talking to, you just put your communication `Send` request in a mailbox, and it will be matched with a complementary `Receive` @@ -72,7 +72,7 @@ functions to simplify the code of actors. - :ref:`class s4u::Link ` Interconnecting hosts. - :ref:`class s4u::NetZone `: - Sub-region of the platform, containing resources (Hosts, Link, etc). + Sub-region of the platform, containing resources (Hosts, Links, etc). - :ref:`class s4u::Storage ` Resource on which actors can write and read data. - :ref:`class s4u::VirtualMachine `: @@ -136,7 +136,7 @@ functions to simplify the code of actors. Activities ---------- -Activities represent the actions that consumes a resource, such as +Activities represent the actions that consume a resource, such as a :ref:`s4u::Comm ` that consumes the *transmiting power* of :ref:`s4u::Link ` resources. @@ -152,11 +152,11 @@ create blocking communications: the actor is blocked until the completion of that communication. Asynchronous communications do not block the actor during their execution but progress on their own. -Once your asynchronous activity is started, you can test for +Once your asynchronous activity is started, you can test for its completion using :cpp:func:`s4u::Activity::test() `. This function returns ``true`` if the activity completed already. You can also use :cpp:func:`s4u::Activity::wait() ` -to block until the completion of the activity. To wait at most for a given period, +to block until the completion of the activity. To wait for at most a given amount of time, use :cpp:func:`s4u::Activity::wait_for() `. Finally, to wait at most until a specified time limit, use :cpp:func:`s4u::Activity::wait_until() `. @@ -189,7 +189,7 @@ vector of mailboxes. :end-before: init-end :dedent: 4 -You then start all communications that should occur concurrently with +Then, you start all the communications that should occur concurrently with :cpp:func:`s4u::Mailbox::put_async() `. Finally, the actor waits for the completion of all of them at once with -- 2.20.1