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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
#ifndef QPID_CLIENT_SUBSCRIPTIONMANAGER_H
#define QPID_CLIENT_SUBSCRIPTIONMANAGER_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/sys/Mutex.h"
#include <qpid/client/Dispatcher.h>
#include <qpid/client/Completion.h>
#include <qpid/client/Session.h>
#include <qpid/client/MessageListener.h>
#include <qpid/client/LocalQueue.h>
#include <qpid/sys/Runnable.h>
#include <set>
#include <sstream>
namespace qpid {
namespace client {
/**
* Utility to assist with creating subscriptions.
*
* \ingroup clientapi
*/
class SubscriptionManager : public sys::Runnable
{
typedef sys::Mutex::ScopedLock Lock;
typedef sys::Mutex::ScopedUnlock Unlock;
Completion subscribeInternal(const std::string& q, const std::string& dest);
qpid::client::Dispatcher dispatcher;
qpid::client::Session& session;
uint32_t messages;
uint32_t bytes;
bool window;
AckPolicy autoAck;
bool confirmMode;
bool acquireMode;
bool autoStop;
public:
SubscriptionManager(Session& session);
/**
* Subscribe a MessagesListener to receive messages from queue.
*
*@param listener Listener object to receive messages.
*@param queue Name of the queue to subscribe to.
*@param tag Unique destination tag for the listener.
* If not specified, the queue name is used.
*/
Completion subscribe(MessageListener& listener,
const std::string& queue,
const std::string& tag=std::string());
/**
* Subscribe a LocalQueue to receive messages from queue.
*
*@param queue Name of the queue to subscribe to.
*@param tag Unique destination tag for the listener.
* If not specified, the queue name is used.
*/
Completion subscribe(LocalQueue& localQueue,
const std::string& queue,
const std::string& tag=std::string());
/** Cancel a subscription. */
void cancel(const std::string tag);
/** Deliver messages until stop() is called. */
void run();
/** If set true, run() will stop when all subscriptions
* are cancelled. If false, run will only stop when stop()
* is called. True by default.
*/
void setAutoStop(bool set=true);
/** Cause run() to return */
void stop();
static const uint32_t UNLIMITED=0xFFFFFFFF;
/** Set the flow control for destination tag.
*@param tag: name of the destination.
*@param messages: message credit.
*@param bytes: byte credit.
*@param window: if true use window-based flow control.
*/
void setFlowControl(const std::string& tag, uint32_t messages, uint32_t bytes, bool window=true);
/** Set the initial flow control settings to be applied to each new subscribtion.
*@param messages: message credit.
*@param bytes: byte credit.
*@param window: if true use window-based flow control.
*/
void setFlowControl(uint32_t messages, uint32_t bytes, bool window=true);
/** Set the confirm-mode for new subscriptions. Defaults to true.
*@param confirm: if true messages must be confirmed by calling
*Message::acknowledge() or automatically, see setAckPolicy()
*/
void setConfirmMode(bool confirm);
/** Set the acquire-mode for new subscriptions. Defaults to false.
*@param acquire: if false messages pre-acquired, if true
* messages are dequed on acknowledgement or on transfer
* depending on confirmMode.
*/
void setAcquireMode(bool acquire);
/** Set the acknowledgement policy for new subscriptions.
* Default is to acknowledge every message automatically.
*/
void setAckPolicy(const AckPolicy& autoAck);
};
}} // namespace qpid::client
#endif /*!QPID_CLIENT_SUBSCRIPTIONMANAGER_H*/
|
