LockedQueue< T, StorageType > Class Template Reference

#include "LockedQueue.h"

Public Member Functions
	LockedQueue ()=default
	Default constructor to create an empty LockedQueue.
virtual	~LockedQueue ()=default
	Destructor for LockedQueue.
void	add (const T &item)
	Adds an item to the back of the queue.
template<class Iterator >
void	readd (Iterator begin, Iterator end)
	Adds a range of items to the front of the queue.
bool	next (T &result)
	Gets the next item in the queue and removes it.
template<class Checker >
bool	next (T &result, Checker &check)
	Retrieves the next item from the queue if it satisfies the provided checker.
T &	peek ()
	Peeks at the top of the queue without removing it.
void	cancel ()
	Cancels the queue, preventing further processing of items.
bool	cancelled () const
	Checks if the queue has been canceled.
bool	empty () const
	Checks if the queue is empty.
void	pop_front ()
	Removes the item at the front of the queue.

Private Attributes
std::mutex	_lock
	Mutex to protect access to the queue.
std::atomic< bool >	_canceled {false}
	Flag indicating if the queue is canceled.
StorageType	_queue
	Storage container for the queue.

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

Default constructor to create an empty LockedQueue.

~LockedQueue()

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

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

virtualdefault

Destructor for 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 back of the queue.

Parameters

item	The item to be added to the queue.

    {
        std::lock_guard<std::mutex> lock(_lock);
        _queue.push_back(std::move(item));
    }

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

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

cancel()

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

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

inline

Cancels the queue, preventing further processing of items.

    {
        _canceled.store(true, std::memory_order_release);
    }

References LockedQueue< T, StorageType >::_canceled.

cancelled()

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

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

inline

Checks if the queue has been canceled.

Returns

true if the queue is canceled, false otherwise.

    {
        return _canceled.load(std::memory_order_acquire);
    }

References LockedQueue< T, StorageType >::_canceled.

empty()

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

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

inline

Checks if the queue is empty.

Returns

true if the queue is empty, false otherwise.

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

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

next() [1/2]

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

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

inline

Gets the next item in the queue and removes it.

Parameters

result

The variable where the next item will be stored.

Returns

true if an item was retrieved and removed, false if the queue is empty.

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

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

Referenced by World::ProcessCliCommands(), AuctionHouseWorkerThread::ProcessSearchUpdates(), WorldSession::Update(), WorldSessionMgr::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

Retrieves the next item from the queue if it satisfies the provided checker.

Parameters

result	The variable where the next item will be stored.
check	A checker object that will be used to validate the item.

Returns

true if an item was retrieved, checked, and removed; false otherwise.

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

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

peek()

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

T & LockedQueue< T, StorageType >::peek ( )

inline

Peeks at the top of the queue without removing it.

Returns

A reference to the item at the front of the queue, assuming there's an item in the queue (as per previous implementation)

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

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

pop_front()

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

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

inline

Removes the item at the front of the queue.

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

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

readd()

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

template<class Iterator >

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

inline

Adds a range of items to the front of the queue.

Parameters

begin	Iterator pointing to the beginning of the range of items to be added.
end	Iterator pointing to the end of the range of items to be added.

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

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

Referenced by WorldSession::Update().

Member Data Documentation

_canceled

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

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

private

Flag indicating if the queue is canceled.

{false}; 

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

mutableprivate

Mutex to protect access to the queue.

Referenced by LockedQueue< T, StorageType >::add(), LockedQueue< T, StorageType >::empty(), LockedQueue< T, StorageType >::next(), LockedQueue< T, StorageType >::next(), LockedQueue< T, StorageType >::peek(), 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 container for the queue.

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

---

The documentation for this class was generated from the following file:

• azerothcore-wotlk/src/common/Threading/LockedQueue.h