1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
#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 QPID_CLIENT_CLASS_EXTERN 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*/
|
