qpid::messaging::Receiver Class Reference
Interface through which messages are received.
More...
#include <qpid/messaging/Receiver.h>
List of all members.
Detailed Description
Interface through which messages are received.
Definition at line 45 of file Receiver.h.
Member Typedef Documentation
Constructor & Destructor Documentation
qpid::messaging::Receiver::Receiver |
( |
ReceiverImpl * |
impl = 0 |
) |
|
qpid::messaging::Receiver::Receiver |
( |
const Receiver & |
|
) |
|
qpid::messaging::Receiver::~Receiver |
( |
|
) |
|
Member Function Documentation
uint32_t qpid::messaging::Receiver::available |
( |
|
) |
|
Returns the number of messages received and waiting to be fetched.
void qpid::messaging::Receiver::cancel |
( |
|
) |
|
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.
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.
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.
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.
uint32_t qpid::messaging::Receiver::getCapacity |
( |
|
) |
|
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).
- Returns:
- true if handle is null. It is an error to call any function on a null handle.
Definition at line 46 of file Handle.h.
- Returns:
- true if handle is valid, i.e. not null.
Definition at line 43 of file Handle.h.
Conversion to bool supports idiom if (handle) { handle->.
.. }
Definition at line 49 of file Handle.h.
Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.
Definition at line 52 of file Handle.h.
uint32_t qpid::messaging::Receiver::pendingAck |
( |
|
) |
|
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.
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::Receiver::start |
( |
|
) |
|
Enables the message flow for this receiver.
void qpid::messaging::Receiver::stop |
( |
|
) |
|
Stops the message flow for this receiver (but does not cancel the subscription).
Member Data Documentation
The documentation for this class was generated from the following file: