Qpid C++ Messaging API  0.22
qpid/messaging/Receiver.h
Go to the documentation of this file.
00001 #ifndef QPID_MESSAGING_RECEIVER_H
00002 #define QPID_MESSAGING_RECEIVER_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 #include "qpid/messaging/ImportExport.h"
00025 
00026 #include "qpid/messaging/exceptions.h"
00027 #include "qpid/messaging/Handle.h"
00028 #include "qpid/messaging/Duration.h"
00029 
00030 namespace qpid {
00031 namespace messaging {
00032 
00033 #ifndef SWIG
00034 template <class> class PrivateImplRef;
00035 #endif
00036 
00037 class Address;
00038 class Message;
00039 class ReceiverImpl;
00040 class Session;
00041 
00045 class QPID_MESSAGING_CLASS_EXTERN Receiver : public qpid::messaging::Handle<ReceiverImpl>
00046 {
00047   public:
00048     QPID_MESSAGING_EXTERN Receiver(ReceiverImpl* impl = 0);
00049     QPID_MESSAGING_EXTERN Receiver(const Receiver&);
00050     QPID_MESSAGING_EXTERN ~Receiver();
00051     QPID_MESSAGING_EXTERN Receiver& operator=(const Receiver&);
00057     QPID_MESSAGING_EXTERN bool get(Message& message, Duration timeout=Duration::FOREVER);
00067     QPID_MESSAGING_EXTERN Message get(Duration timeout=Duration::FOREVER);
00079     QPID_MESSAGING_EXTERN bool fetch(Message& message, Duration timeout=Duration::FOREVER);
00091     QPID_MESSAGING_EXTERN Message fetch(Duration timeout=Duration::FOREVER);
00097     QPID_MESSAGING_EXTERN void setCapacity(uint32_t);
00104     QPID_MESSAGING_EXTERN uint32_t getCapacity();
00109     QPID_MESSAGING_EXTERN uint32_t getAvailable();
00116     QPID_MESSAGING_EXTERN uint32_t getUnsettled();
00117 
00121     QPID_MESSAGING_EXTERN void close();
00122 
00126     QPID_MESSAGING_EXTERN bool isClosed() const;
00127 
00131     QPID_MESSAGING_EXTERN const std::string& getName() const;
00132 
00136     QPID_MESSAGING_EXTERN Session getSession() const;
00137 
00141     QPID_MESSAGING_EXTERN Address getAddress() const;
00142 
00143 #ifndef SWIG
00144   private:
00145   friend class qpid::messaging::PrivateImplRef<Receiver>;
00146 #endif
00147 };
00148 }} // namespace qpid::messaging
00149 
00150 #endif