diff options
| author | Alan Conway <aconway@apache.org> | 2008-05-27 15:39:42 +0000 |
|---|---|---|
| committer | Alan Conway <aconway@apache.org> | 2008-05-27 15:39:42 +0000 |
| commit | 8b2a0de8689dffb697e436b4abf697d22bdf3caf (patch) | |
| tree | 08848f42d2958431fc4468d6215abce19527e998 /cpp/src/qpid/client/Completion.h | |
| parent | e208b1bc12c51857b24c7edf6f9270ab6d9e600c (diff) | |
| download | qpid-python-8b2a0de8689dffb697e436b4abf697d22bdf3caf.tar.gz | |
Additional API documentation around sync vs. async sessions.
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@660562 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'cpp/src/qpid/client/Completion.h')
| -rw-r--r-- | cpp/src/qpid/client/Completion.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/cpp/src/qpid/client/Completion.h b/cpp/src/qpid/client/Completion.h index 19d5b31777..22cc70607a 100644 --- a/cpp/src/qpid/client/Completion.h +++ b/cpp/src/qpid/client/Completion.h @@ -29,6 +29,11 @@ namespace qpid { namespace client { +/** + * Returned by asynchronous commands that do not return any result. + * You can use this to wait for an individual command to complete. + * \clientapi + */ class Completion { protected: @@ -40,6 +45,7 @@ public: Completion(Future f, shared_ptr<SessionImpl> s) : future(f), session(s) {} + /** Wait for the command to complete */ void wait() { future.wait(*session); |