Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation
Subscription.h
Go to the documentation of this file.
1 #ifndef QMF_SUBSCRIPTION_H
2 #define QMF_SUBSCRIPTION_H
3 /*
4  *
5  * Licensed to the Apache Software Foundation (ASF) under one
6  * or more contributor license agreements. See the NOTICE file
7  * distributed with this work for additional information
8  * regarding copyright ownership. The ASF licenses this file
9  * to you under the Apache License, Version 2.0 (the
10  * "License"); you may not use this file except in compliance
11  * with the License. You may obtain a copy of the License at
12  *
13  * http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing,
16  * software distributed under the License is distributed on an
17  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18  * KIND, either express or implied. See the License for the
19  * specific language governing permissions and limitations
20  * under the License.
21  *
22  */
23 
24 #if !defined(QMF_USE_DEPRECATED_API) && !defined(qmf2_EXPORTS) && !defined(SWIG)
25 # error "The API defined in this file has been DEPRECATED and will be removed in the future."
26 # error "Define 'QMF_USE_DEPRECATED_API' to enable continued use of the API."
27 #endif
28 
29 #include <qmf/ImportExport.h>
30 #include "qmf/Handle.h"
31 #include "qpid/types/Variant.h"
32 #include <string>
33 
34 namespace qmf {
35 
36 #ifndef SWIG
37  template <class> class PrivateImplRef;
38 #endif
39 
40  class SubscriptionImpl;
41  class Data;
42 
43  class QMF_CLASS_EXTERN Subscription : public qmf::Handle<SubscriptionImpl> {
44  public:
45  QMF_EXTERN Subscription(SubscriptionImpl* impl = 0);
46  QMF_EXTERN Subscription(const Subscription&);
47  QMF_EXTERN Subscription& operator=(const Subscription&);
48  QMF_EXTERN ~Subscription();
49 
58  QMF_EXTERN void cancel();
59 
65  QMF_EXTERN bool isActive() const;
66 
73  QMF_EXTERN void lock();
74  QMF_EXTERN void unlock();
75  QMF_EXTERN uint32_t getDataCount() const;
76  QMF_EXTERN Data getData(uint32_t) const;
77 
78 #ifndef SWIG
79  private:
80  friend class qmf::PrivateImplRef<Subscription>;
81  friend struct SubscriptionImplAccess;
82 #endif
83  };
84 
85 }
86 
87 #endif
#define QMF_EXTERN
Definition: ImportExport.h:30
Definition: Data.h:47
unsigned int uint32_t
Definition: IntegerTypes.h:27
A handle is like a pointer: refers to an underlying implementation object.
Definition: Handle.h:43
#define QMF_CLASS_EXTERN
Definition: ImportExport.h:31

Qpid C++ API Reference
Generated on Tue Oct 28 2014 for Qpid C++ Client API by doxygen 1.8.5