docs/charm++: Update completion detection to reflect added doneProducing callback
authorPhil Miller <mille121@illinois.edu>
Tue, 2 Apr 2013 21:21:52 +0000 (16:21 -0500)
committerPhil Miller <mille121@illinois.edu>
Tue, 2 Apr 2013 21:21:52 +0000 (16:21 -0500)
doc/charm++/quiesce.tex

index 57b8289bf08d2bb8186c38e5d90b42c0bd24be7a..b761632c66be50a6b7f4de985b1ddeee5e340009 100644 (file)
@@ -27,7 +27,7 @@ When it is time to start completion detection, invoke the following method of th
 library on {\em all} branches of the completion detection group:
 
 \begin{alltt}
-void start_detection(int num_producers, CkCallback start, CkCallback finish, int prio_);
+void start_detection(int num_producers, CkCallback start, CkCallback allProduced, CkCallback finish, int prio_);
 \end{alltt}
 
 The \verb|num_producers| parameter is the number of objects (chares)
@@ -38,6 +38,9 @@ The \verb|start| callback notifies your program that it is safe to
 begin producing and consuming (this state is reached when the module
 has finished its internal initialization).
 
+The \verb|allProduced| callback notifies your program when the client has
+called \verb|done| with arguments summing to \verb|num_producers|.
+
 The \verb|finish| callback is invoked when completion has been
 detected (all objects participating have produced and consumed an
 equal number of elements globally).