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
|
/*
*
* 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/framing/FieldTable.h"
#ifndef _QueueOptions_
#define _QueueOptions_
namespace qpid {
namespace client {
enum QueueSizePolicy {NONE, REJECT, FLOW_TO_DISK, RING, RING_STRICT};
enum QueueOrderingPolicy {FIFO, LVQ, LVQ_NO_BROWSE};
/**
* A help class to set options on the Queue. Create a configured args while
* still allowing any custom configuration via the FieldTable base class
*/
class QPID_CLIENT_CLASS_EXTERN QueueOptions: public framing::FieldTable
{
public:
QPID_CLIENT_EXTERN QueueOptions();
QPID_CLIENT_EXTERN virtual ~QueueOptions();
/**
* Sets the queue sizing policy
*
* @param sp SizePolicy
* REJECT - reject if queue greater than size/count
* FLOW_TO_DISK - page messages to disk from this point is greater than size/count
* RING - limit the queue to size/count and over-write old messages round a ring
* RING_STRICT - limit the queue to size/count and reject is head == tail
* NONE - Use default broker sizing policy
* @param maxSize Set the max number of bytes for the sizing policies
* @param setMaxCount Set the max number of messages for the sizing policies
*/
QPID_CLIENT_EXTERN void setSizePolicy(QueueSizePolicy sp, uint64_t maxSize, uint32_t maxCount );
/**
* Enables the persisting of a queue to the store module when a cluster fails down to it's last
* node. Does so optimistically. Will start persisting when cluster count >1 again.
*/
QPID_CLIENT_EXTERN void setPersistLastNode();
/**
* Sets the odering policy on the Queue, default ordering is FIFO.
*/
QPID_CLIENT_EXTERN void setOrdering(QueueOrderingPolicy op);
/**
* Use broker defualt sizing ploicy
*/
QPID_CLIENT_EXTERN void clearSizePolicy();
/**
* Clear Persist Last Node Policy
*/
QPID_CLIENT_EXTERN void clearPersistLastNode();
/**
* get the key used match LVQ in args for message transfer
*/
QPID_CLIENT_EXTERN void getLVQKey(std::string& key);
/**
* Use default odering policy
*/
QPID_CLIENT_EXTERN void clearOrdering();
/**
* Turns on event generation for this queue (either enqueue only
* or for enqueue and dequeue events); the events can then be
* processed by a regsitered broker plugin.
*
* DEPRECATED
*
* This is confusing to anyone who sees only the function call
* and not the variable name / doxygen. Consider the following call:
*
* options.enableQueueEvents(false);
*
* It looks like it disables queue events, but what it really does is
* enable both enqueue and dequeue events.
*
* Use setInt() instead:
*
* options.setInt("qpid.queue_event_generation", 2);
*/
QPID_CLIENT_EXTERN void enableQueueEvents(bool enqueueOnly);
static QPID_CLIENT_EXTERN const std::string strMaxCountKey;
static QPID_CLIENT_EXTERN const std::string strMaxSizeKey;
static QPID_CLIENT_EXTERN const std::string strTypeKey;
static QPID_CLIENT_EXTERN const std::string strREJECT;
static QPID_CLIENT_EXTERN const std::string strFLOW_TO_DISK;
static QPID_CLIENT_EXTERN const std::string strRING;
static QPID_CLIENT_EXTERN const std::string strRING_STRICT;
static QPID_CLIENT_EXTERN const std::string strLastValueQueue;
static QPID_CLIENT_EXTERN const std::string strPersistLastNode;
static QPID_CLIENT_EXTERN const std::string strLVQMatchProperty;
static QPID_CLIENT_EXTERN const std::string strLastValueQueueNoBrowse;
static QPID_CLIENT_EXTERN const std::string strQueueEventMode;
};
}
}
#endif
|
