summaryrefslogtreecommitdiff
path: root/cpp/lib/broker/BrokerQueue.h
blob: 41611bebe9217b8988e410c35615a19ea3c2d39f (plain)
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
142
143
144
145
146
/*
 *
 * 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.
 *
 */
#ifndef _Queue_
#define _Queue_

#include <vector>
#include <memory>
#include <queue>
#include <boost/shared_ptr.hpp>
#include <amqp_types.h>
#include <Binding.h>
#include <ConnectionToken.h>
#include <Consumer.h>
#include <BrokerMessage.h>
#include <FieldTable.h>
#include <sys/Monitor.h>
#include <QueuePolicy.h>

namespace qpid {
    namespace broker {
        class MessageStore;

        /**
         * Thrown when exclusive access would be violated.
         */
        struct ExclusiveAccessException{};

        using std::string;

        /**
         * The brokers representation of an amqp queue. Messages are
         * delivered to a queue from where they can be dispatched to
         * registered consumers or be stored until dequeued or until one
         * or more consumers registers.
         */
        class Queue{
            const string name;
            const u_int32_t autodelete;
            MessageStore* const store;
            const ConnectionToken* const owner;
            std::vector<Consumer*> consumers;
            std::queue<Binding*> bindings;
            std::queue<Message::shared_ptr> messages;
            bool queueing;
            bool dispatching;
            int next;
            mutable qpid::sys::Mutex lock;
            int64_t lastUsed;
            Consumer* exclusive;
            mutable u_int64_t persistenceId;
            std::auto_ptr<QueuePolicy> policy;            

            void pop();
            void push(Message::shared_ptr& msg);
            bool startDispatching();
            bool dispatch(Message::shared_ptr& msg);
            void setPolicy(std::auto_ptr<QueuePolicy> policy);

        public:
            
            typedef boost::shared_ptr<Queue> shared_ptr;

            typedef std::vector<shared_ptr> vector;
	    
            Queue(const string& name, u_int32_t autodelete = 0, 
                  MessageStore* const store = 0, 
                  const ConnectionToken* const owner = 0);
            ~Queue();

            void create(const qpid::framing::FieldTable& settings);
            void configure(const qpid::framing::FieldTable& settings);
            void destroy();
            /**
             * Informs the queue of a binding that should be cancelled on
             * destruction of the queue.
             */
            void bound(Binding* b);
            /**
             * Delivers a message to the queue. Will record it as
             * enqueued if persistent then process it.
             */
            void deliver(Message::shared_ptr& msg);
            /**
             * Dispatches the messages immediately to a consumer if
             * one is available or stores it for later if not.
             */
            void process(Message::shared_ptr& msg);
            /**
             * Used during recovery to add stored messages back to the queue
             */
            void recover(Message::shared_ptr& msg);
            /**
             * Dispatch any queued messages providing there are
             * consumers for them. Only one thread can be dispatching
             * at any time, but this method (rather than the caller)
             * is responsible for ensuring that.
             */
            void dispatch();
            void consume(Consumer* c, bool exclusive = false);
            void cancel(Consumer* c);
            u_int32_t purge();
            u_int32_t getMessageCount() const;
            u_int32_t getConsumerCount() const;
            inline const string& getName() const { return name; }
            inline const bool isExclusiveOwner(const ConnectionToken* const o) const { return o == owner; }
            inline bool hasExclusiveConsumer() const { return exclusive; }
            inline u_int64_t getPersistenceId() const { return persistenceId; }
            inline void setPersistenceId(u_int64_t _persistenceId) const { persistenceId = _persistenceId; }

            bool canAutoDelete() const;

            void enqueue(TransactionContext* ctxt, Message::shared_ptr& msg, const string * const xid);
            /**
             * dequeue from store (only done once messages is acknowledged)
             */
            void dequeue(TransactionContext* ctxt, Message::shared_ptr& msg, const string * const xid);
            /**
             * dequeues from memory only
             */
            Message::shared_ptr dequeue();

            const QueuePolicy* const getPolicy();
        };
    }
}


#endif