LockedQueue< T, StorageType > Class Template Reference

#include "LockedQueue.h"

Public Member Functions
	LockedQueue ()=default
	Create a LockedQueue. More...
virtual	~LockedQueue ()=default
	Destroy a LockedQueue. More...
void	add (const T &item)
	Adds an item to the queue. More...
template<class Iterator >
void	readd (Iterator begin, Iterator end)
	Adds items back to front of the queue. More...
bool	next (T &result)
	Gets the next result in the queue, if any. More...
template<class Checker >
bool	next (T &result, Checker &check)
T &	peek (bool autoUnlock=false)
	Peeks at the top of the queue. Check if the queue is empty before calling! Remember to unlock after use if autoUnlock == false. More...
void	cancel ()
	Cancels the queue. More...
bool	cancelled ()
	Checks if the queue is cancelled. More...
void	lock ()
	Locks the queue for access. More...
void	unlock ()
	Unlocks the queue. More...
void	pop_front ()
	! Calls pop_front of the queue More...
bool	empty ()
	! Checks if we're empty or not with locks held More...

Private Attributes
std::mutex	_lock
	Lock access to the queue. More...
StorageType	_queue
	Storage backing the queue. More...
volatile bool	_canceled {false}
	Cancellation flag. More...

Detailed Description

template<class T, typename StorageType = std::deque<T>>
class LockedQueue< T, StorageType >

Constructor & Destructor Documentation

LockedQueue()

template<class T , typename StorageType = std::deque<T>>

LockedQueue< T, StorageType >::LockedQueue ( )

default

Create a LockedQueue.

~LockedQueue()

template<class T , typename StorageType = std::deque<T>>

virtual LockedQueue< T, StorageType >::~LockedQueue ( )

virtualdefault

Destroy a LockedQueue.

Member Function Documentation

add()

template<class T , typename StorageType = std::deque<T>>

void LockedQueue< T, StorageType >::add ( const T &  item )

inline

Adds an item to the queue.

    {
        lock();
 
        _queue.push_back(item);
 
        unlock();
    }

References LockedQueue< T, StorageType >::_queue, LockedQueue< T, StorageType >::lock(), and LockedQueue< T, StorageType >::unlock().

Referenced by World::AddSession(), World::QueueCliCommand(), and WorldSession::QueuePacket().

cancel()

template<class T , typename StorageType = std::deque<T>>

void LockedQueue< T, StorageType >::cancel ( )

inline

Cancels the queue.

    {
        std::lock_guard<std::mutex> lock(_lock);
 
        _canceled = true;
    }

References LockedQueue< T, StorageType >::_canceled, LockedQueue< T, StorageType >::_lock, and LockedQueue< T, StorageType >::lock().

cancelled()

template<class T , typename StorageType = std::deque<T>>

bool LockedQueue< T, StorageType >::cancelled ( )

inline

Checks if the queue is cancelled.

    {
        std::lock_guard<std::mutex> lock(_lock);
        return _canceled;
    }

References LockedQueue< T, StorageType >::_canceled, LockedQueue< T, StorageType >::_lock, and LockedQueue< T, StorageType >::lock().

empty()

template<class T , typename StorageType = std::deque<T>>

bool LockedQueue< T, StorageType >::empty ( )

inline

! Checks if we're empty or not with locks held

    {
        std::lock_guard<std::mutex> lock(_lock);
        return _queue.empty();
    }

References LockedQueue< T, StorageType >::_lock, LockedQueue< T, StorageType >::_queue, and LockedQueue< T, StorageType >::lock().

lock()

template<class T , typename StorageType = std::deque<T>>

void LockedQueue< T, StorageType >::lock ( )

inline

Locks the queue for access.

    {
        this->_lock.lock();
    }

Referenced by LockedQueue< T, StorageType >::add(), LockedQueue< T, StorageType >::cancel(), LockedQueue< T, StorageType >::cancelled(), LockedQueue< T, StorageType >::empty(), LockedQueue< T, StorageType >::next(), LockedQueue< T, StorageType >::peek(), LockedQueue< T, StorageType >::pop_front(), and LockedQueue< T, StorageType >::readd().

next() [1/2]

template<class T , typename StorageType = std::deque<T>>

bool LockedQueue< T, StorageType >::next ( T &  result )

inline

Gets the next result in the queue, if any.

    {
        std::lock_guard<std::mutex> lock(_lock);
 
        if (_queue.empty())
        {
            return false;
        }
 
        result = _queue.front();
        _queue.pop_front();
 
        return true;
    }

References LockedQueue< T, StorageType >::_lock, LockedQueue< T, StorageType >::_queue, and LockedQueue< T, StorageType >::lock().

Referenced by World::ProcessCliCommands(), WorldSession::Update(), World::UpdateSessions(), World::~World(), and WorldSession::~WorldSession().

next() [2/2]

template<class T , typename StorageType = std::deque<T>>

template<class Checker >

bool LockedQueue< T, StorageType >::next ( T &  result, Checker &  check  )

inline

    {
        std::lock_guard<std::mutex> lock(_lock);
 
        if (_queue.empty())
        {
            return false;
        }
 
        result = _queue.front();
        if (!check.Process(result))
        {
            return false;
        }
 
        _queue.pop_front();
        return true;
    }

References LockedQueue< T, StorageType >::_lock, LockedQueue< T, StorageType >::_queue, and LockedQueue< T, StorageType >::lock().

peek()

template<class T , typename StorageType = std::deque<T>>

T & LockedQueue< T, StorageType >::peek ( bool  autoUnlock = false )

inline

Peeks at the top of the queue. Check if the queue is empty before calling! Remember to unlock after use if autoUnlock == false.

    {
        lock();
 
        T& result = _queue.front();
 
        if (autoUnlock)
        {
            unlock();
        }
 
        return result;
    }

References LockedQueue< T, StorageType >::_queue, LockedQueue< T, StorageType >::lock(), and LockedQueue< T, StorageType >::unlock().

pop_front()

template<class T , typename StorageType = std::deque<T>>

void LockedQueue< T, StorageType >::pop_front ( )

inline

! Calls pop_front of the queue

    {
        std::lock_guard<std::mutex> lock(_lock);
        _queue.pop_front();
    }

References LockedQueue< T, StorageType >::_lock, LockedQueue< T, StorageType >::_queue, and LockedQueue< T, StorageType >::lock().

readd()

template<class T , typename StorageType = std::deque<T>>

template<class Iterator >

void LockedQueue< T, StorageType >::readd ( Iterator  begin, Iterator  end  )

inline

Adds items back to front of the queue.

    {
        std::lock_guard<std::mutex> lock(_lock);
        _queue.insert(_queue.begin(), begin, end);
    }

References LockedQueue< T, StorageType >::_lock, LockedQueue< T, StorageType >::_queue, and LockedQueue< T, StorageType >::lock().

Referenced by WorldSession::Update().

unlock()

template<class T , typename StorageType = std::deque<T>>

void LockedQueue< T, StorageType >::unlock ( )

inline

Unlocks the queue.

    {
        this->_lock.unlock();
    }

Referenced by LockedQueue< T, StorageType >::add(), and LockedQueue< T, StorageType >::peek().

Member Data Documentation

_canceled

template<class T , typename StorageType = std::deque<T>>

volatile bool LockedQueue< T, StorageType >::_canceled {false}

private

Cancellation flag.

Referenced by LockedQueue< T, StorageType >::cancel(), and LockedQueue< T, StorageType >::cancelled().

_lock

template<class T , typename StorageType = std::deque<T>>

std::mutex LockedQueue< T, StorageType >::_lock

private

Lock access to the queue.

Referenced by LockedQueue< T, StorageType >::cancel(), LockedQueue< T, StorageType >::cancelled(), LockedQueue< T, StorageType >::empty(), LockedQueue< T, StorageType >::next(), LockedQueue< T, StorageType >::pop_front(), and LockedQueue< T, StorageType >::readd().

_queue

template<class T , typename StorageType = std::deque<T>>

StorageType LockedQueue< T, StorageType >::_queue

private

Storage backing the queue.

Referenced by LockedQueue< T, StorageType >::add(), LockedQueue< T, StorageType >::empty(), LockedQueue< T, StorageType >::next(), LockedQueue< T, StorageType >::peek(), LockedQueue< T, StorageType >::pop_front(), and LockedQueue< T, StorageType >::readd().