Apache Qpid C++ API
Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation

qpid::client::LocalQueue Class Reference
[Qpid C++ Client API]

A local queue to collect messages retrieved from a remote broker queue. More...

#include <LocalQueue.h>

List of all members.

Public Member Functions

 LocalQueue ()
 Create a local queue.
 ~LocalQueue ()
bool get (Message &result, sys::Duration timeout=0)
 Wait up to timeout for the next message from the local queue.
Message get (sys::Duration timeout=sys::TIME_INFINITE)
 Get the next message off the local queue, or wait up to the timeout for message from the broker queue.
Message pop (sys::Duration timeout=sys::TIME_INFINITE)
 Synonym for get().
bool empty () const
 Return true if local queue is empty.
size_t size () const
 Number of messages on the local queue.


Detailed Description

A local queue to collect messages retrieved from a remote broker queue.

Create a queue and subscribe it using the SubscriptionManager. Messages from the remote queue on the broker will be stored in the local queue until you retrieve them.

Using a Local Queue

 LocalQueue local_queue;
 subscriptions.subscribe(local_queue, string("message_queue"));
 for (int i=0; i<10; i++) {
   Message message = local_queue.get();
   std::cout << message.getData() << std::endl;
 }
 

Getting Messages

Checking size

Definition at line 71 of file LocalQueue.h.


Constructor & Destructor Documentation

qpid::client::LocalQueue::LocalQueue (  ) 

Create a local queue.

Subscribe the local queue to a remote broker queue with a SubscriptionManager.

LocalQueue is an alternative to implementing a MessageListener.

qpid::client::LocalQueue::~LocalQueue (  ) 


Member Function Documentation

bool qpid::client::LocalQueue::empty (  )  const

Return true if local queue is empty.

Message qpid::client::LocalQueue::get ( sys::Duration  timeout = sys::TIME_INFINITE  ) 

Get the next message off the local queue, or wait up to the timeout for message from the broker queue.

Parameters:
timeout wait up this timeout for a message to appear.
Returns:
message from the queue.
Exceptions:
ClosedException if subscription is closed or timeout exceeded.

bool qpid::client::LocalQueue::get ( Message result,
sys::Duration  timeout = 0 
)

Wait up to timeout for the next message from the local queue.

Parameters:
result Set to the message from the queue.
timeout wait up this timeout for a message to appear.
Returns:
true if result was set, false if queue was empty after timeout.

Message qpid::client::LocalQueue::pop ( sys::Duration  timeout = sys::TIME_INFINITE  ) 

Synonym for get().

size_t qpid::client::LocalQueue::size (  )  const

Number of messages on the local queue.


The documentation for this class was generated from the following file:

Qpid C++ API Reference
Generated on Thu Mar 19 15:24:03 2009 for Qpid C++ Client API by doxygen 1.5.7.1