diff options
Diffstat (limited to 'trunk/qpid/cpp/include/qpid/messaging/Receiver.h')
-rw-r--r-- | trunk/qpid/cpp/include/qpid/messaging/Receiver.h | 130 |
1 files changed, 0 insertions, 130 deletions
diff --git a/trunk/qpid/cpp/include/qpid/messaging/Receiver.h b/trunk/qpid/cpp/include/qpid/messaging/Receiver.h deleted file mode 100644 index 51630b12a2..0000000000 --- a/trunk/qpid/cpp/include/qpid/messaging/Receiver.h +++ /dev/null @@ -1,130 +0,0 @@ -#ifndef QPID_MESSAGING_RECEIVER_H -#define QPID_MESSAGING_RECEIVER_H - -/* - * - * 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. - * - */ -#include "qpid/Exception.h" -#include "qpid/client/ClientImportExport.h" -#include "qpid/client/Handle.h" -#include "qpid/sys/Time.h" - -namespace qpid { -namespace client { - -template <class> class PrivateImplRef; - -} - -namespace messaging { - -class Message; -class ReceiverImpl; -class Session; - -/** - * Interface through which messages are received. - */ -class Receiver : public qpid::client::Handle<ReceiverImpl> -{ - public: - struct NoMessageAvailable : qpid::Exception {}; - - QPID_CLIENT_EXTERN Receiver(ReceiverImpl* impl = 0); - QPID_CLIENT_EXTERN Receiver(const Receiver&); - QPID_CLIENT_EXTERN ~Receiver(); - QPID_CLIENT_EXTERN Receiver& operator=(const Receiver&); - /** - * Retrieves a message from this receivers local queue, or waits - * for upto the specified timeout for a message to become - * available. Returns false if there is no message to give after - * waiting for the specified timeout. - */ - QPID_CLIENT_EXTERN bool get(Message& message, qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE); - /** - * Retrieves a message from this receivers local queue, or waits - * for upto the specified timeout for a message to become - * available. Throws NoMessageAvailable if there is no - * message to give after waiting for the specified timeout. - */ - QPID_CLIENT_EXTERN Message get(qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE); - /** - * Retrieves a message for this receivers subscription or waits - * for upto the specified timeout for one to become - * available. Unlike get() this method will check with the server - * that there is no message for the subscription this receiver is - * serving before returning false. - */ - QPID_CLIENT_EXTERN bool fetch(Message& message, qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE); - /** - * Retrieves a message for this receivers subscription or waits - * for up to the specified timeout for one to become - * available. Unlike get() this method will check with the server - * that there is no message for the subscription this receiver is - * serving before throwing an exception. - */ - QPID_CLIENT_EXTERN Message fetch(qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE); - /** - * Sets the capacity for the receiver. The capacity determines how - * many incoming messages can be held in the receiver before being - * requested by a client via fetch() (or pushed to a listener). - */ - QPID_CLIENT_EXTERN void setCapacity(uint32_t); - /** - * Returns the capacity of the receiver. The capacity determines - * how many incoming messages can be held in the receiver before - * being requested by a client via fetch() (or pushed to a - * listener). - */ - QPID_CLIENT_EXTERN uint32_t getCapacity(); - /** - * Returns the number of messages received and waiting to be - * fetched. - */ - QPID_CLIENT_EXTERN uint32_t available(); - /** - * Returns a count of the number of messages received on this - * receiver that have been acknowledged, but for which that - * acknowledgement has not yet been confirmed as processed by the - * server. - */ - QPID_CLIENT_EXTERN uint32_t pendingAck(); - - /** - * Cancels this receiver. - */ - QPID_CLIENT_EXTERN void cancel(); - - /** - * Returns the name of this receiver. - */ - QPID_CLIENT_EXTERN const std::string& getName() const; - - /** - * Returns a handle to the session associated with this receiver. - */ - QPID_CLIENT_EXTERN Session getSession() const; - - private: - friend class qpid::client::PrivateImplRef<Receiver>; -}; -}} // namespace qpid::messaging - -#endif /*!QPID_MESSAGING_RECEIVER_H*/ |