Docs: describe how to get the return value of a [sync] entry method
authorPhil Miller <mille121@illinois.edu>
Mon, 16 Apr 2012 19:52:01 +0000 (14:52 -0500)
committerPhil Miller <mille121@illinois.edu>
Mon, 16 Apr 2012 19:52:01 +0000 (14:52 -0500)
doc/charm++/entry.tex

index 5ad5f543ad435f0ec820420f39ce42274cc3fc98..45dfef88b1b7d5b17dec86e5b82359f1e555f656 100644 (file)
@@ -54,6 +54,11 @@ sync entry methods are blocking - they do not return control to the caller
 until the method is finished executing completely.  Sync methods may have
 return values; however, they may only return messages. Callers must run in a
 thread separate from the runtime scheduler, e.g. a \kw{threaded} entry methods.
+Calls expecting a return value will receive it as the return from the proxy invocation:
+\begin{alltt}
+ReturnMsg* m;
+m = A[i].foo(a, b, c);
+\end{alltt}
 
 \index{exclusive}\item[exclusive] entry methods, which exist only on node groups, are
 \index{entry method}entry methods that do not execute while other exclusive