Documentation #2044: improve callback example 27/4927/6
authorSam White <white67@illinois.edu>
Mon, 28 Jan 2019 20:10:40 +0000 (14:10 -0600)
committerSam White <white67@illinois.edu>
Mon, 4 Feb 2019 23:08:25 +0000 (17:08 -0600)
Change-Id: I335410e9105a396c4f8c42b60bd3df0e402e7877

doc/charm++/callbacks.tex
doc/charm++/manual.rst

index 65999d2..71f8bb6 100644 (file)
@@ -56,6 +56,15 @@ through the choice of callback constructor used when creating the callback.
 Possible constructors are: 
 
 \begin{enumerate}
+\item \kw{CkCallback(int ep, const CkChareID \&id)} - When invoked, the
+callback will send its message to the given entry method (specified by the
+entry point index - \kw{ep}) of the given
+Chare (specified by the chare \kw{id}).  Note that a chare proxy will also work in place of a chare id:
+
+\begin{alltt}
+  CkCallback(CkIndex_Foo::bar(NULL), thisProxy[thisIndex])
+\end{alltt}
+
 \item \kw{CkCallback(void (*CallbackFn)(void *, void *), void *param)} - 
 When invoked, the callback will pass \uw{param} and the result message
 to the given C function, which should have a prototype
@@ -80,15 +89,6 @@ other way.
 \item \kw{CkCallback(CkCallback::ckExit)} - When invoked, the callback
 will call CkExit(), ending the Charm++ program.
 
-\item \kw{CkCallback(int ep, const CkChareID \&id)} - When invoked, the 
-callback will send its message to the given entry method (specified by the 
-entry point index - \kw{ep}) of the given
-Chare (specified by the chare \kw{id}).  Note that a chare proxy will also work in place of a chare id:
-
-\begin{alltt}
-       CkCallback myCB(CkIndex_myChare::myEntry(NULL), myChareProxy);
-\end{alltt}
-
 \item \kw{CkCallback(int ep, const CkArrayID \&id)} - 
 When invoked,
 the callback will broadcast its message to the given entry method
index b1a5ee4..c8993db 100644 (file)
@@ -4950,6 +4950,15 @@ The intended behavior upon a callback‚Äôs invocation is specified through
 the choice of callback constructor used when creating the callback.
 Possible constructors are:
 
+#. CkCallback(int ep, const CkChareID &id) - When invoked, the callback
+   will send its message to the given entry method (specified by the
+   entry point index - ep) of the given Chare (specified by the chare
+   id). Note that a chare proxy will also work in place of a chare id:
+
+   ::
+
+      CkCallback(CkIndex_Foo::bar(NULL), thisProxy[thisIndex])
+
 #. CkCallback(void (\*CallbackFn)(void \*, void \*), void \*param) - When
    invoked, the callback will pass param and the result message to the
    given C function, which should have a prototype like:
@@ -4973,15 +4982,6 @@ Possible constructors are:
 #. CkCallback(CkCallback::ckExit) - When invoked, the callback will call
    CkExit(), ending the Charm++ program.
 
-#. CkCallback(int ep, const CkChareID &id) - When invoked, the callback
-   will send its message to the given entry method (specified by the
-   entry point index - ep) of the given Chare (specified by the chare
-   id). Note that a chare proxy will also work in place of a chare id:
-
-   ::
-
-       CkCallback myCB(CkIndex_myChare::myEntry(NULL), myChareProxy);
-
 #. CkCallback(int ep, const CkArrayID &id) - When invoked, the callback
    will broadcast its message to the given entry method of the given
    array. An array proxy will work in the place of an array id.