Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET | Apache Qpid Documentation |
#include <qpid/messaging/Receiver.h>
Inherits qpid::messaging::Handle< ReceiverImpl >.
Public Member Functions | |
Receiver (ReceiverImpl *impl=0) | |
Receiver (const Receiver &) | |
~Receiver () | |
Receiver & | operator= (const Receiver &) |
bool | get (Message &message, Duration timeout=Duration::FOREVER) |
Retrieves a message from this receivers local queue, or waits for upto the specified timeout for a message to become available. | |
Message | get (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. | |
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. | |
Message | fetch (Duration timeout=Duration::FOREVER) |
Retrieves a message for this receivers subscription or waits for up to the specified timeout for one to become available. | |
void | setCapacity (uint32_t) |
Sets the capacity for the receiver. | |
uint32_t | getCapacity () |
uint32_t | getAvailable () |
uint32_t | getUnsettled () |
void | close () |
Cancels this receiver. | |
bool | isClosed () const |
Return true if the receiver was closed by a call to close(). | |
const std::string & | getName () const |
Returns the name of this receiver. | |
Session | getSession () const |
Returns a handle to the session associated with this receiver. | |
bool | isValid () const |
bool | isNull () const |
operator bool () const | |
Conversion to bool supports idiom if (handle) { handle->. | |
bool | operator! () const |
Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }. | |
void | swap (Handle< ReceiverImpl > &h) |
Protected Types | |
typedef ReceiverImpl | Impl |
Protected Attributes | |
Impl * | impl |
Definition at line 44 of file Receiver.h.
typedef ReceiverImpl qpid::messaging::Handle< ReceiverImpl >::Impl [protected, inherited] |
qpid::messaging::Receiver::Receiver | ( | ReceiverImpl * | impl = 0 |
) |
qpid::messaging::Receiver::Receiver | ( | const Receiver & | ) |
qpid::messaging::Receiver::~Receiver | ( | ) |
void qpid::messaging::Receiver::close | ( | ) |
Cancels this receiver.
Message qpid::messaging::Receiver::fetch | ( | 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.
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. |
bool qpid::messaging::Receiver::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 returning false.
Message qpid::messaging::Receiver::get | ( | 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.
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. |
bool qpid::messaging::Receiver::get | ( | Message & | message, | |
Duration | timeout = Duration::FOREVER | |||
) |
Retrieves a message from this receivers local queue, or waits for upto the specified timeout for a message to become available.
uint32_t qpid::messaging::Receiver::getAvailable | ( | ) |
uint32_t qpid::messaging::Receiver::getCapacity | ( | ) |
const std::string& qpid::messaging::Receiver::getName | ( | ) | const |
Returns the name of this receiver.
Session qpid::messaging::Receiver::getSession | ( | ) | const |
Returns a handle to the session associated with this receiver.
uint32_t qpid::messaging::Receiver::getUnsettled | ( | ) |
bool qpid::messaging::Receiver::isClosed | ( | ) | const |
Return true if the receiver was closed by a call to close().
bool qpid::messaging::Handle< ReceiverImpl >::isNull | ( | ) | const [inline, inherited] |
bool qpid::messaging::Handle< ReceiverImpl >::isValid | ( | ) | const [inline, inherited] |
qpid::messaging::Handle< ReceiverImpl >::operator bool | ( | ) | const [inline, inherited] |
bool qpid::messaging::Handle< ReceiverImpl >::operator! | ( | ) | const [inline, inherited] |
void qpid::messaging::Receiver::setCapacity | ( | uint32_t | ) |
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).
void qpid::messaging::Handle< ReceiverImpl >::swap | ( | Handle< ReceiverImpl > & | h | ) | [inline, inherited] |
Impl* qpid::messaging::Handle< ReceiverImpl >::impl [protected, inherited] |