summaryrefslogtreecommitdiff
path: root/cpp/include/qpid/messaging/Receiver.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpp/include/qpid/messaging/Receiver.h')
-rw-r--r--cpp/include/qpid/messaging/Receiver.h144
1 files changed, 0 insertions, 144 deletions
diff --git a/cpp/include/qpid/messaging/Receiver.h b/cpp/include/qpid/messaging/Receiver.h
deleted file mode 100644
index 13317dfcbd..0000000000
--- a/cpp/include/qpid/messaging/Receiver.h
+++ /dev/null
@@ -1,144 +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/messaging/ImportExport.h"
-
-#include "qpid/messaging/exceptions.h"
-#include "qpid/messaging/Handle.h"
-#include "qpid/messaging/Duration.h"
-
-namespace qpid {
-namespace messaging {
-
-#ifndef SWIG
-template <class> class PrivateImplRef;
-#endif
-
-class Message;
-class ReceiverImpl;
-class Session;
-
-/** \ingroup messaging
- * Interface through which messages are received.
- */
-class QPID_MESSAGING_CLASS_EXTERN Receiver : public qpid::messaging::Handle<ReceiverImpl>
-{
- public:
- QPID_MESSAGING_EXTERN Receiver(ReceiverImpl* impl = 0);
- QPID_MESSAGING_EXTERN Receiver(const Receiver&);
- QPID_MESSAGING_EXTERN ~Receiver();
- QPID_MESSAGING_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.
- */
- QPID_MESSAGING_EXTERN bool get(Message& message, Duration timeout=Duration::FOREVER);
- /**
- * Retrieves a message from this receivers local queue, or waits
- * for up to the specified timeout for a message to become
- * available.
- *
- * @exception NoMessageAvailable if there is no message to give
- * after waiting for the specified timeout, or if the Receiver is
- * closed, in which case isClose() will be true.
- */
- QPID_MESSAGING_EXTERN Message get(Duration timeout=Duration::FOREVER);
- /**
- * 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 returning false.
- *
- * @return false if there is no message to give after
- * waiting for the specified timeout, or if the Receiver is
- * closed, in which case isClose() will be true.
- */
- QPID_MESSAGING_EXTERN bool fetch(Message& message, Duration timeout=Duration::FOREVER);
- /**
- * 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.
- *
- * @exception NoMessageAvailable if there is no message to give
- * after waiting for the specified timeout, or if the Receiver is
- * closed, in which case isClose() will be true.
- */
- QPID_MESSAGING_EXTERN Message fetch(Duration timeout=Duration::FOREVER);
- /**
- * 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_MESSAGING_EXTERN void setCapacity(uint32_t);
- /**
- * @return 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_MESSAGING_EXTERN uint32_t getCapacity();
- /**
- * @return the number of messages received and waiting to be
- * fetched.
- */
- QPID_MESSAGING_EXTERN uint32_t getAvailable();
- /**
- * @return 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_MESSAGING_EXTERN uint32_t getUnsettled();
-
- /**
- * Cancels this receiver.
- */
- QPID_MESSAGING_EXTERN void close();
-
- /**
- * Return true if the receiver was closed by a call to close()
- */
- QPID_MESSAGING_EXTERN bool isClosed() const;
-
- /**
- * Returns the name of this receiver.
- */
- QPID_MESSAGING_EXTERN const std::string& getName() const;
-
- /**
- * Returns a handle to the session associated with this receiver.
- */
- QPID_MESSAGING_EXTERN Session getSession() const;
-
-#ifndef SWIG
- private:
- friend class qpid::messaging::PrivateImplRef<Receiver>;
-#endif
-};
-}} // namespace qpid::messaging
-
-#endif /*!QPID_MESSAGING_RECEIVER_H*/