Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET | Apache Qpid Documentation |
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/Exception.h" 00025 #include "qpid/client/ClientImportExport.h" 00026 #include "qpid/client/Handle.h" 00027 #include "qpid/sys/Time.h" 00028 00029 namespace qpid { 00030 namespace client { 00031 00032 template <class> class PrivateImplRef; 00033 00034 } 00035 00036 namespace messaging { 00037 00038 class Message; 00039 class ReceiverImpl; 00040 class Session; 00041 00045 class Receiver : public qpid::client::Handle<ReceiverImpl> 00046 { 00047 public: 00048 struct NoMessageAvailable : qpid::Exception {}; 00049 00050 QPID_CLIENT_EXTERN Receiver(ReceiverImpl* impl = 0); 00051 QPID_CLIENT_EXTERN Receiver(const Receiver&); 00052 QPID_CLIENT_EXTERN ~Receiver(); 00053 QPID_CLIENT_EXTERN Receiver& operator=(const Receiver&); 00060 QPID_CLIENT_EXTERN bool get(Message& message, qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE); 00067 QPID_CLIENT_EXTERN Message get(qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE); 00075 QPID_CLIENT_EXTERN bool fetch(Message& message, qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE); 00083 QPID_CLIENT_EXTERN Message fetch(qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE); 00089 QPID_CLIENT_EXTERN void setCapacity(uint32_t); 00096 QPID_CLIENT_EXTERN uint32_t getCapacity(); 00101 QPID_CLIENT_EXTERN uint32_t available(); 00108 QPID_CLIENT_EXTERN uint32_t pendingAck(); 00109 00113 QPID_CLIENT_EXTERN void cancel(); 00114 00118 QPID_CLIENT_EXTERN const std::string& getName() const; 00119 00123 QPID_CLIENT_EXTERN Session getSession() const; 00124 00125 private: 00126 friend class qpid::client::PrivateImplRef<Receiver>; 00127 }; 00128 }} // namespace qpid::messaging 00129 00130 #endif