8e80217e59
Former-commit-id:a02aeb236c[formerly9f19e3f712] [formerly06a8b51d6d[formerly 64fa9254b946eae7e61bbc3f513b7c3696c4f54f]] Former-commit-id:06a8b51d6dFormer-commit-id:3360eb6c5f
120 lines
3.8 KiB
C++
120 lines
3.8 KiB
C++
#ifndef QPID_CLIENT_LOCALQUEUE_H
|
|
#define QPID_CLIENT_LOCALQUEUE_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/client/ClientImportExport.h"
|
|
#include "qpid/client/Handle.h"
|
|
#include "qpid/client/Message.h"
|
|
#include "qpid/sys/Time.h"
|
|
|
|
namespace qpid {
|
|
namespace client {
|
|
|
|
class LocalQueueImpl;
|
|
template <class T> class PrivateImplRef;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* \ingroup clientapi
|
|
*
|
|
* \details Using a Local Queue
|
|
*
|
|
* <pre>
|
|
* 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;
|
|
* }
|
|
* </pre>
|
|
*
|
|
* <h2>Getting Messages</h2>
|
|
*
|
|
* <ul><li>
|
|
* <p>get()</p>
|
|
* <pre>Message message = local_queue.get();</pre>
|
|
* <pre>// Specifying timeouts (TIME_SEC, TIME_MSEC, TIME_USEC, TIME_NSEC)
|
|
*#include <qpid/sys/Time.h>
|
|
*Message message;
|
|
*local_queue.get(message, 5*sys::TIME_SEC);</pre></li></ul>
|
|
*
|
|
* <h2>Checking size</h2>
|
|
* <ul><li>
|
|
* <p>empty()</p>
|
|
* <pre>if (local_queue.empty()) { ... }</pre></li>
|
|
* <li><p>size()</p>
|
|
* <pre>std::cout << local_queue.size();</pre></li>
|
|
* </ul>
|
|
*/
|
|
|
|
class LocalQueue : public Handle<LocalQueueImpl> {
|
|
public:
|
|
/** 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_EXTERN LocalQueue();
|
|
QPID_CLIENT_EXTERN LocalQueue(const LocalQueue&);
|
|
QPID_CLIENT_EXTERN ~LocalQueue();
|
|
QPID_CLIENT_EXTERN LocalQueue& operator=(const LocalQueue&);
|
|
|
|
/** Wait up to timeout for the next message from the local queue.
|
|
*@param result Set to the message from the queue.
|
|
*@param timeout wait up this timeout for a message to appear.
|
|
*@return true if result was set, false if queue was empty after timeout.
|
|
*/
|
|
QPID_CLIENT_EXTERN bool get(Message& result, sys::Duration timeout=0);
|
|
|
|
/** Get the next message off the local queue, or wait up to the timeout
|
|
* for message from the broker queue.
|
|
*@param timeout wait up this timeout for a message to appear.
|
|
*@return message from the queue.
|
|
*@throw ClosedException if subscription is closed or timeout exceeded.
|
|
*/
|
|
QPID_CLIENT_EXTERN Message get(sys::Duration timeout=sys::TIME_INFINITE);
|
|
|
|
/** Synonym for get() */
|
|
QPID_CLIENT_EXTERN Message pop(sys::Duration timeout=sys::TIME_INFINITE);
|
|
|
|
/** Return true if local queue is empty. */
|
|
QPID_CLIENT_EXTERN bool empty() const;
|
|
|
|
/** Number of messages on the local queue */
|
|
QPID_CLIENT_EXTERN size_t size() const;
|
|
|
|
LocalQueue(LocalQueueImpl*); ///<@internal
|
|
|
|
|
|
private:
|
|
typedef LocalQueueImpl Impl;
|
|
friend class PrivateImplRef<LocalQueue>;
|
|
};
|
|
|
|
}} // namespace qpid::client
|
|
|
|
#endif /*!QPID_CLIENT_LOCALQUEUE_H*/
|