Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET | Apache Qpid Documentation |
00001 #ifndef QPID_CLIENT_SUBSCRIPTION_H 00002 #define QPID_CLIENT_SUBSCRIPTION_H 00003 00004 /* 00005 * 00006 * Licensed to the Apache Software Foundation (ASF) under one 00007 * or more contributor license agreements. See the NOTICE file 00008 * distributed with this work for additional information 00009 * regarding copyright ownership. The ASF licenses this file 00010 * to you under the Apache License, Version 2.0 (the 00011 * "License"); you may not use this file except in compliance 00012 * with the License. You may obtain a copy of the License at 00013 * 00014 * http://www.apache.org/licenses/LICENSE-2.0 00015 * 00016 * Unless required by applicable law or agreed to in writing, 00017 * software distributed under the License is distributed on an 00018 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 00019 * KIND, either express or implied. See the License for the 00020 * specific language governing permissions and limitations 00021 * under the License. 00022 * 00023 */ 00024 00025 #include "qpid/client/Session.h" 00026 #include "qpid/client/SubscriptionSettings.h" 00027 #include "qpid/client/Handle.h" 00028 #include "qpid/client/Message.h" 00029 #include "qpid/client/ClientImportExport.h" 00030 00031 namespace qpid { 00032 namespace client { 00033 00034 class SubscriptionImpl; 00035 class SubscriptionManager; 00036 00041 class Subscription : public Handle<SubscriptionImpl> { 00042 public: 00043 QPID_CLIENT_EXTERN Subscription(SubscriptionImpl* si=0) : Handle<SubscriptionImpl>(si) {} 00044 00048 QPID_CLIENT_EXTERN std::string getName() const; 00049 00051 QPID_CLIENT_EXTERN std::string getQueue() const; 00052 00054 QPID_CLIENT_EXTERN const SubscriptionSettings& getSettings() const; 00055 00057 QPID_CLIENT_EXTERN void setFlowControl(const FlowControl&); 00058 00063 QPID_CLIENT_EXTERN void setAutoAck(unsigned int n); 00064 00068 QPID_CLIENT_EXTERN SequenceSet getUnacquired() const; 00069 00071 QPID_CLIENT_EXTERN SequenceSet getUnaccepted() const; 00072 00076 QPID_CLIENT_EXTERN void acquire(const SequenceSet& messageIds); 00077 00081 QPID_CLIENT_EXTERN void accept(const SequenceSet& messageIds); 00082 00086 QPID_CLIENT_EXTERN void release(const SequenceSet& messageIds); 00087 00088 /* Acquire a single message */ 00089 QPID_CLIENT_EXTERN void acquire(const Message& m) { acquire(SequenceSet(m.getId())); } 00090 00091 /* Accept a single message */ 00092 QPID_CLIENT_EXTERN void accept(const Message& m) { accept(SequenceSet(m.getId())); } 00093 00094 /* Release a single message */ 00095 QPID_CLIENT_EXTERN void release(const Message& m) { release(SequenceSet(m.getId())); } 00096 00098 QPID_CLIENT_EXTERN Session getSession() const; 00099 00101 QPID_CLIENT_EXTERN SubscriptionManager& getSubscriptionManager() const; 00102 00104 QPID_CLIENT_EXTERN void cancel(); 00105 00107 QPID_CLIENT_EXTERN void grantMessageCredit(uint32_t); 00108 00110 QPID_CLIENT_EXTERN void grantByteCredit(uint32_t); 00111 00112 friend class SubscriptionManager; 00113 }; 00114 }} // namespace qpid::client 00115 00116 #endif