aboutsummaryrefslogtreecommitdiff
path: root/src/shared/LockedQueue.h
blob: 4087ebff0cffc4560ffde5c95bec6014258b579e (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
/*
 * Copyright (C) 2009 MaNGOS <http://getmangos.com/>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef LOCKEDQUEUE_H
#define LOCKEDQUEUE_H

#include <ace/Guard_T.h>
#include <ace/Thread_Mutex.h>
#include <deque>
#include <assert.h>
#include "Errors.h"

namespace ACE_Based
{
    template <class T, class LockType, typename StorageType=std::deque<T> >
        class LockedQueue
    {
        //! Serialize access to the Queue
        LockType _lock;

        //! Storage backing the queue
        StorageType _queue;

        //! Cancellation flag
        volatile bool _canceled;

        public:

            //! Create a LockedQueue
            LockedQueue() : _canceled(false) {}

            //! Destroy a LockedQueue
            virtual ~LockedQueue() { }

            /**
             * @see Queue::add(const T& item)
             */
            void add(const T& item)
            {
                ACE_Guard<LockType> g(this->_lock);

                ASSERT(!this->_canceled);
                // throw Cancellation_Exception();

                this->_queue.push_back(item);
            }

            /**
             * @see Queue::next()
             */
            T next()
            {
                ACE_Guard<LockType> g(this->_lock);

                ASSERT (!_queue.empty() || !this->_canceled);
                // throw Cancellation_Exception();

                T item = this->_queue.front();
                this->_queue.pop_front();

                return item;
            }

            T front()
            {
                ACE_Guard<LockType> g(this->_lock);

                ASSERT (!this->_queue.empty());
                // throw NoSuchElement_Exception();

                return this->_queue.front();
            }

            /**
             * @see Queue::cancel()
             */
            void cancel()
            {
                ACE_Guard<LockType> g(this->_lock);

                this->_canceled = true;
            }

            /**
             * @see Queue::isCanceled()
             */
            bool isCanceled()
            {
                // Faster check since the queue will not become un-canceled
                if(this->_canceled)
                    return true;

                ACE_Guard<LockType> g(this->_lock);

                return this->_canceled;
            }

            /**
             * @see Queue::size()
             */
            size_t size()
            {
                ACE_Guard<LockType> g(this->_lock);
                return this->_queue.size();
            }

            bool empty()
            {
                ACE_Guard<LockType> g(this->_lock);
                return this->_queue.empty();
            }
    };
}
#endif