From d8b7c68e680779249d9b06a00537b2a68485a14d Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sun, 14 Aug 2016 23:05:55 +0200 Subject: [PATCH] further improve the doc of s4u::Mailbox --- include/simgrid/s4u/Mailbox.hpp | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp index 78354d4936..37dceac1ad 100644 --- a/include/simgrid/s4u/Mailbox.hpp +++ b/include/simgrid/s4u/Mailbox.hpp @@ -67,8 +67,8 @@ namespace s4u { * cumbersome for your simulations anyway. You probably want something * simpler, that turns our to be easy to build with the mailboxes. * - * Many examples in the archive use a sort of yellow page system where - * the mailbox names are the name of the service (such as "worker", + * Many SimGrid examples use a sort of yellow page system where the + * mailbox names are the name of the service (such as "worker", * "master" or "reducer"). That way, you don't have to know where your * peer is located to contact it. You don't even need its name. Its * function is enough for that. This also gives you some sort of load @@ -76,6 +76,15 @@ namespace s4u { * the first relevant actor that can deal with the request will handle * it. * + * @section s4u_mb_matching How are sends and receives matched? + * + * The matching algorithm is as simple as a first come, first + * serve. When a new send arrives, it matches the oldest enqueued + * receive. If no receive is currently enqueued, then the incomming + * send is enqueued. As you can see, the mailbox cannot contain both + * send and receive requests: all enqueued requests must be of the + * same sort. + * * @section s4u_mb_receiver Declaring a receiving actor * * The last twist is that by default in the simulator, the data starts -- 2.20.1