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
|
#ifndef QPID_CLIENT_SUBSCRIPTIONSETTINGS_H
#define QPID_CLIENT_SUBSCRIPTIONSETTINGS_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/FlowControl.h"
#include "qpid/framing/enum.h"
namespace qpid {
namespace client {
/** Bring AMQP enum definitions for message class into this namespace. */
using qpid::framing::message::AcceptMode;
using qpid::framing::message::AcquireMode;
using qpid::framing::message::ACCEPT_MODE_EXPLICIT;
using qpid::framing::message::ACCEPT_MODE_NONE;
using qpid::framing::message::ACQUIRE_MODE_NOT_ACQUIRED;
using qpid::framing::message::ACQUIRE_MODE_PRE_ACQUIRED;
using qpid::framing::message::CREDIT_UNIT_BYTE;
using qpid::framing::message::CREDIT_UNIT_MESSAGE;
using qpid::framing::message::DELIVERY_MODE_NON_PERSISTENT;
using qpid::framing::message::DELIVERY_MODE_PERSISTENT;
using qpid::framing::message::FLOW_MODE_CREDIT;
using qpid::framing::message::FLOW_MODE_WINDOW;
enum CompletionMode {
MANUAL_COMPLETION = 0,
COMPLETE_ON_DELIVERY = 1,
COMPLETE_ON_ACCEPT = 2
};
/**
* Settings for a subscription.
*/
struct SubscriptionSettings
{
SubscriptionSettings(
FlowControl flow=FlowControl::unlimited(),
AcceptMode accept=ACCEPT_MODE_EXPLICIT,
AcquireMode acquire=ACQUIRE_MODE_PRE_ACQUIRED,
unsigned int autoAck_=1,
CompletionMode completion=COMPLETE_ON_DELIVERY
) : flowControl(flow), acceptMode(accept), acquireMode(acquire), autoAck(autoAck_), completionMode(completion), exclusive(false) {}
FlowControl flowControl; ///@< Flow control settings. @see FlowControl
/**
* The acceptMode determines whether the broker should expect
* delivery of messages to be acknowledged by the client
* indicating that it accepts them. A value of
* ACCEPT_MODE_EXPLICIT means that messages must be accepted
* (note: this may be done automatically by the library - see
* autoAck - or through an explicit call be the application - see
* Subscription::accept()) before they can be dequeued. A value of
* ACCEPT_MODE_NONE means that the broker can dequeue a message as
* soon as it is acquired.
*/
AcceptMode acceptMode; ///@< ACCEPT_MODE_EXPLICIT or ACCEPT_MODE_NONE
/**
* The acquireMode determines whether messages are locked for the
* subscriber when delivered, and thus are not delivered to any
* other subscriber unless this subscriber releases them.
*
* The default is ACQUIRE_MODE_PRE_ACQUIRED meaning that the
* subscriber expects to have been given that message exclusively
* (i.e. the message will not be given to any other subscriber
* unless released explicitly or by this subscribers session
* failing without having accepted the message).
*
* Delivery of message in ACQUIRE_MODE_NOT_ACQUIRED mode means the
* message will still be available for other subscribers to
* receive. The application can if desired acquire a (set of)
* messages through an explicit acquire call - see
* Subscription::acquire().
*/
AcquireMode acquireMode; ///@< ACQUIRE_MODE_PRE_ACQUIRED or ACQUIRE_MODE_NOT_ACQUIRED
/**
* Configures the frequency at which messages are automatically
* accepted (e.g. a value of 5 means that messages are accepted in
* batches of 5). A value of 0 means no automatic acknowledgement
* will occur and the application will itself be responsible for
* accepting messages.
*/
unsigned int autoAck;
/**
* In windowing mode, completion of a message will cause the
* credit used up by that message to be reallocated. The
* subscriptions completion mode controls how completion is
* managed.
*
* If set to COMPLETE_ON_DELIVERY (which is the default), messages
* will be marked as completed once they have been received. The
* server will be explicitly notified of all completed messages
* for the session when the next accept is sent through the
* subscription (either explictly or through autAck). However the
* server may also periodically request information on the
* completed messages.
*
* If set to COMPLETE_ON_ACCEPT, messages will be marked as
* completed once they are accepted (via the Subscription class)
* and the server will also be notified of all completed messages
* for the session.
*
* If set to MANUAL_COMPLETION the application is responsible for
* completing messages (@see Session::markCompleted()).
*/
CompletionMode completionMode;
/**
* If set, requests that no other subscriber be allowed to access
* the queue while this subscription is active.
*/
bool exclusive;
};
}} // namespace qpid::client
#endif /*!QPID_CLIENT_SUBSCRIPTIONSETTINGS_H*/
|
