summaryrefslogtreecommitdiff
path: root/qpid/cpp/src/qpid/sys/BlockingQueue.h
blob: dd709c6bfff3aa12bd724153e168da0ddad5ba33 (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
#ifndef QPID_SYS_BLOCKINGQUEUE_H
#define QPID_SYS_BLOCKINGQUEUE_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 "Waitable.h"

#include <queue>

namespace qpid {
namespace sys {

/**
 * A simple blocking queue template
 */
template <class T>
class BlockingQueue
{
    mutable sys::Waitable lock;
    std::queue<T> queue;
    bool closed;

public:
    BlockingQueue() : closed(false) {}
    ~BlockingQueue() { close(); }

    /** Block until there is a value to pop */
    T pop()
    {
        Waitable::ScopedLock l(lock);
        if (!queueWait()) throw ClosedException();
        return popInternal();
    }

    /** Non-blocking pop. If there is a value set outValue and return
     * true, else return false;
     */
    bool tryPop(T& outValue) {
        Waitable::ScopedLock l(lock);
        if (queue.empty()) return false;
        outValue = popInternal();
        return true;
    }

    /** Non-blocking pop. If there is a value return it, else return
     * valueIfEmpty.
     */
    T tryPop(const T& valueIfEmpty=T()) {
        T result=valueIfEmpty;
        tryPop(result);
        return result;
    }

    /** Push a value onto the queue */
    void push(const T& t)
    {
        Waitable::ScopedLock l(lock);
        queue.push(t);
        queueNotify(0);
    }

    /**
     * Close the queue. Throws ClosedException in threads waiting in pop().
     * Blocks till all waiting threads have been notified.
     */ 
    void close()
    {
        Waitable::ScopedLock l(lock);
        if (!closed) {
            closed = true;
            lock.notifyAll();
            lock.waitWaiters(); // Ensure no threads are still waiting.
        }
    }

    /** Open a closed queue. */
    void open() {
        Waitable::ScopedLock l(lock);
        closed=false;
    }

    bool isClosed() const { 
        Waitable::ScopedLock l(lock);
        return closed;
    }

    bool empty() const {
        Waitable::ScopedLock l(lock);
        return queue.empty();
    }    
    size_t size() const {
        Waitable::ScopedLock l(lock);
        return queue.size();
    }    

  private:

    void queueNotify(size_t ignore) {
        if (!queue.empty() && lock.hasWaiters()>ignore)
            lock.notify();      // Notify another waiter.
    }

    bool queueWait() {
        Waitable::ScopedWait w(lock);
        while (!closed && queue.empty())
            lock.wait();
        return !queue.empty();
    }

    T popInternal() {
        T t=queue.front();
        queue.pop();
        queueNotify(1);
        return t;
    }
    
};

}}



#endif  /*!QPID_SYS_BLOCKINGQUEUE_H*/