summaryrefslogtreecommitdiff
path: root/RC9/qpid/cpp/src/qpid/client/Completion.h
diff options
context:
space:
mode:
Diffstat (limited to 'RC9/qpid/cpp/src/qpid/client/Completion.h')
-rw-r--r--RC9/qpid/cpp/src/qpid/client/Completion.h71
1 files changed, 71 insertions, 0 deletions
diff --git a/RC9/qpid/cpp/src/qpid/client/Completion.h b/RC9/qpid/cpp/src/qpid/client/Completion.h
new file mode 100644
index 0000000000..c4979d7934
--- /dev/null
+++ b/RC9/qpid/cpp/src/qpid/client/Completion.h
@@ -0,0 +1,71 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+
+#ifndef _Completion_
+#define _Completion_
+
+#include <boost/shared_ptr.hpp>
+#include "Future.h"
+#include "SessionImpl.h"
+
+namespace qpid {
+namespace client {
+
+/**
+ * Asynchronous commands that do not return a result will return a
+ * Completion. You can use the completion to wait for that specific
+ * command to complete.
+ *
+ *@see TypedResult
+ *
+ *\ingroup clientapi
+ */
+class Completion
+{
+protected:
+ Future future;
+ shared_ptr<SessionImpl> session;
+
+public:
+ ///@internal
+ Completion() {}
+
+ ///@internal
+ Completion(Future f, shared_ptr<SessionImpl> s) : future(f), session(s) {}
+
+ /** Wait for the asynchronous command that returned this
+ *Completion to complete.
+ *
+ *@exception If the command returns an error, get() throws an exception.
+ */
+ void wait()
+ {
+ future.wait(*session);
+ }
+
+ bool isComplete() {
+ return future.isComplete(*session);
+ }
+};
+
+}}
+
+#endif