ModelView::threadsafe_stack< T > Class Template Reference

Thread-safe stack borrowed from Anthony Williams, C++ Concurrency in Action, Second edition. More...

Public Member Functions
	threadsafe_stack ()
	threadsafe_stack (const threadsafe_stack &other)
	~threadsafe_stack ()
bool	empty () const
threadsafe_stack &	operator= (const threadsafe_stack &other)=delete
void	push (T new_value)
void	stop ()
	Terminates waiting in wait_and_pop methods. More...
std::shared_ptr< T >	try_pop ()
bool	try_pop (T &value)
void	update_top (T new_value)
	Updates top value in a stack. More...
std::shared_ptr< T >	wait_and_pop ()
void	wait_and_pop (T &value)

Private Attributes
std::stack< T >	data
std::condition_variable	data_condition
std::atomic< bool >	in_waiting_state {true}
std::mutex	m

Detailed Description

template<typename T>
class ModelView::threadsafe_stack< T >

Thread-safe stack borrowed from Anthony Williams, C++ Concurrency in Action, Second edition.

Definition at line 41 of file threadsafestack.h.

Constructor & Destructor Documentation

threadsafe_stack() [1/2]

template<typename T >

ModelView::threadsafe_stack< T >::threadsafe_stack ( )

inline

Definition at line 49 of file threadsafestack.h.

{}

~threadsafe_stack()

template<typename T >

ModelView::threadsafe_stack< T >::~threadsafe_stack ( )

inline

Definition at line 50 of file threadsafestack.h.

{ stop(); }

References ModelView::threadsafe_stack< T >::stop().

Here is the call graph for this function:

threadsafe_stack() [2/2]

template<typename T >

ModelView::threadsafe_stack< T >::threadsafe_stack ( const threadsafe_stack< T > &  other )

inline

Definition at line 51 of file threadsafestack.h.

    {
        std::lock_guard<std::mutex> lock(m);
        data = other.data;
    }

References ModelView::threadsafe_stack< T >::data, and ModelView::threadsafe_stack< T >::m.

Member Function Documentation

empty()

template<typename T >

bool ModelView::threadsafe_stack< T >::empty ( ) const

inline

Definition at line 117 of file threadsafestack.h.

    {
        std::lock_guard<std::mutex> lock(m);
        return data.empty();
    }

References ModelView::threadsafe_stack< T >::data, and ModelView::threadsafe_stack< T >::m.

Referenced by TEST_F().

operator=()

template<typename T >

threadsafe_stack& ModelView::threadsafe_stack< T >::operator= ( const threadsafe_stack< T > &  other )

delete

push()

template<typename T >

void ModelView::threadsafe_stack< T >::push ( T  new_value )

inline

Definition at line 58 of file threadsafestack.h.

    {
        std::lock_guard<std::mutex> lock(m);
        data.push(std::move(new_value));
        data_condition.notify_one();
    }

References ModelView::threadsafe_stack< T >::data, ModelView::threadsafe_stack< T >::data_condition, and ModelView::threadsafe_stack< T >::m.

Referenced by TEST_F().

stop()

template<typename T >

void ModelView::threadsafe_stack< T >::stop ( )

inline

Terminates waiting in wait_and_pop methods.

Definition at line 125 of file threadsafestack.h.

    {
        std::lock_guard<std::mutex> lock(m);
        in_waiting_state = false;
        data_condition.notify_all();
    }

References ModelView::threadsafe_stack< T >::data_condition, ModelView::threadsafe_stack< T >::in_waiting_state, and ModelView::threadsafe_stack< T >::m.

Referenced by ModelView::threadsafe_stack< T >::~threadsafe_stack(), and TEST_F().

try_pop() [1/2]

template<typename T >

std::shared_ptr<T> ModelView::threadsafe_stack< T >::try_pop ( )

inline

Definition at line 107 of file threadsafestack.h.

    {
        std::lock_guard<std::mutex> lock(m);
        if (data.empty())
            return std::shared_ptr<T>();
        std::shared_ptr<T> res(std::make_shared<T>(std::move(data.top())));
        data.pop();
        return res;
    }

References ModelView::threadsafe_stack< T >::data, and ModelView::threadsafe_stack< T >::m.

try_pop() [2/2]

template<typename T >

bool ModelView::threadsafe_stack< T >::try_pop ( T &  value )

inline

Definition at line 97 of file threadsafestack.h.

    {
        std::lock_guard<std::mutex> lock(m);
        if (data.empty())
            return false;
        value = std::move(data.top());
        data.pop();
        return true;
    }

References ModelView::threadsafe_stack< T >::data, and ModelView::threadsafe_stack< T >::m.

Referenced by TEST_F().

update_top()

template<typename T >

void ModelView::threadsafe_stack< T >::update_top ( T  new_value )

inline

Updates top value in a stack.

Definition at line 67 of file threadsafestack.h.

    {
        std::lock_guard<std::mutex> lock(m);
        if (!data.empty())
            data.pop();
        data.push(std::move(new_value));
        data_condition.notify_one();
    }

References ModelView::threadsafe_stack< T >::data, ModelView::threadsafe_stack< T >::data_condition, and ModelView::threadsafe_stack< T >::m.

Referenced by TEST_F().

wait_and_pop() [1/2]

template<typename T >

std::shared_ptr<T> ModelView::threadsafe_stack< T >::wait_and_pop ( )

inline

Definition at line 86 of file threadsafestack.h.

    {
        std::unique_lock<std::mutex> lock(m);
        data_condition.wait(lock, [this] { return !data.empty() || !in_waiting_state; });
        if (data.empty())
            throw empty_stack();
        std::shared_ptr<T> const res(std::make_shared<T>(std::move(data.top())));
        data.pop();
        return res;
    }

References ModelView::threadsafe_stack< T >::data, ModelView::threadsafe_stack< T >::data_condition, ModelView::threadsafe_stack< T >::in_waiting_state, and ModelView::threadsafe_stack< T >::m.

wait_and_pop() [2/2]

template<typename T >

void ModelView::threadsafe_stack< T >::wait_and_pop ( T &  value )

inline

Definition at line 76 of file threadsafestack.h.

    {
        std::unique_lock<std::mutex> lock(m);
        data_condition.wait(lock, [this] { return !data.empty() || !in_waiting_state; });
        if (data.empty())
            throw empty_stack();
        value = std::move(data.top());
        data.pop();
    }

References ModelView::threadsafe_stack< T >::data, ModelView::threadsafe_stack< T >::data_condition, ModelView::threadsafe_stack< T >::in_waiting_state, and ModelView::threadsafe_stack< T >::m.

Referenced by TEST_F().

Member Data Documentation

data

template<typename T >

std::stack<T> ModelView::threadsafe_stack< T >::data

private

Definition at line 43 of file threadsafestack.h.

Referenced by ModelView::threadsafe_stack< T >::threadsafe_stack(), ModelView::threadsafe_stack< T >::empty(), ModelView::threadsafe_stack< T >::push(), ModelView::threadsafe_stack< T >::try_pop(), ModelView::threadsafe_stack< T >::update_top(), and ModelView::threadsafe_stack< T >::wait_and_pop().

data_condition

template<typename T >

std::condition_variable ModelView::threadsafe_stack< T >::data_condition

private

Definition at line 45 of file threadsafestack.h.

Referenced by ModelView::threadsafe_stack< T >::push(), ModelView::threadsafe_stack< T >::stop(), ModelView::threadsafe_stack< T >::update_top(), and ModelView::threadsafe_stack< T >::wait_and_pop().

in_waiting_state

template<typename T >

std::atomic<bool> ModelView::threadsafe_stack< T >::in_waiting_state {true}

private

Definition at line 46 of file threadsafestack.h.

Referenced by ModelView::threadsafe_stack< T >::stop(), and ModelView::threadsafe_stack< T >::wait_and_pop().

m

template<typename T >

std::mutex ModelView::threadsafe_stack< T >::m

mutableprivate

Definition at line 44 of file threadsafestack.h.

Referenced by ModelView::threadsafe_stack< T >::threadsafe_stack(), ModelView::threadsafe_stack< T >::empty(), ModelView::threadsafe_stack< T >::push(), ModelView::threadsafe_stack< T >::stop(), ModelView::threadsafe_stack< T >::try_pop(), ModelView::threadsafe_stack< T >::update_top(), and ModelView::threadsafe_stack< T >::wait_and_pop().

---

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

• /home/www/ba/mvvm/model/mvvm/utils/threadsafestack.h