summaryrefslogtreecommitdiff
path: root/src/common/Threading/LockedQueue.h
blob: 247f68bf5e3bac1612f299546be4216bebcfe2fc (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
/*
 * Copyright (C) 2016+     AzerothCore <www.azerothcore.org>, released under GNU GPL v2 license, you may redistribute it and/or modify it under version 2 of the License, or (at your option), any later version.
 * Copyright (C) 2008-2016 TrinityCore <http://www.trinitycore.org/>
 * Copyright (C) 2005-2009 MaNGOS <http://getmangos.com/>
 */

#ifndef LOCKEDQUEUE_H
#define LOCKEDQUEUE_H

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

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

        //! Storage backing the queue.
        StorageType _queue;

        //! Cancellation flag.
        volatile bool _canceled{false};

    public:
        //! Create a LockedQueue.
        LockedQueue()

        {
        }

        //! Destroy a LockedQueue.
        virtual ~LockedQueue() = default;

        //! Adds an item to the queue.
        void add(const T& item)
        {
            lock();

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

            _queue.push_back(item);

            unlock();
        }

        //! Gets the next result in the queue, if any.
        bool next(T& result)
        {
            // ACE_Guard<LockType> g(this->_lock);
            ACE_GUARD_RETURN (LockType, g, this->_lock, false);

            if (_queue.empty())
                return false;

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

            return true;
        }

        template<class Checker>
        bool next(T& result, Checker& check)
        {
            ACE_Guard<LockType> g(this->_lock);

            if (_queue.empty())
                return false;

            result = _queue.front();
            if (!check.Process(result))
                return false;

            _queue.pop_front();
            return true;
        }

        //! Peeks at the top of the queue. Check if the queue is empty before calling! Remember to unlock after use if autoUnlock == false.
        T& peek(bool autoUnlock = false)
        {
            lock();

            T& result = _queue.front();

            if (autoUnlock)
                unlock();

            return result;
        }

        //! Cancels the queue.
        void cancel()
        {
            lock();

            _canceled = true;

            unlock();
        }

        //! Checks if the queue is cancelled.
        bool cancelled()
        {
            ACE_Guard<LockType> g(this->_lock);
            return _canceled;
        }

        //! Locks the queue for access.
        void lock()
        {
            this->_lock.acquire();
        }

        //! Unlocks the queue.
        void unlock()
        {
            this->_lock.release();
        }

        ///! Calls pop_front of the queue
        void pop_front()
        {
            ACE_GUARD (LockType, g, this->_lock);
            _queue.pop_front();
        }

        ///! Checks if we're empty or not with locks held
        bool empty()
        {
            ACE_GUARD_RETURN (LockType, g, this->_lock, false);
            return _queue.empty();
        }
    };
}
#endif