libjmmcg  release_579_6_g8cffd
A C++ library containing an eclectic mix of useful, advanced components.
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | List of all members
jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk > Class Template Reference

An adaptor to add thread-safety assistance, specifically for queues. More...

#include <thread_safe_adaptors.hpp>

Inherits QT.

Collaboration diagram for jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >:
[legend]

Public Types

typedef QT container_type
 The queue to be adapted, usually std::list or std::queue. More...
 
typedef Sig have_work_type
 Used to enable functionality to atomically signal if the container contains work or not. More...
 
typedef M atomic_t
 The underlying lock object to use. More...
 
typedef WL write_lock_type
 The type of write-lock to use. This allows the possibility of using a read-write lock. More...
 
typedef atomic_t::read_lock_type read_lock_type
 The type of read lock to use, by default the write lock. This allows the possibility of using a read-write lock. More...
 
typedef MLk lock_all_type
 The multi-lock type to use to ensured that operations on combined queues are thread-safe. Note that locking them in any order reduces the likelihood of deadlock at the cost of performance. More...
 
typedef write_lock_type::lock_traits lock_traits
 
template<class... T>
using scoped_lock = typename lock_traits::template scoped_lock< T... >
 
typedef api_threading_traits< lock_traits::api_type, typename lock_traits::model_type > thread_traits
 
typedef container_type::reference reference
 
typedef container_type::const_reference const_reference
 
typedef container_type::size_type size_type
 
typedef container_type::value_type value_type
 
typedef ValRet value_ret_type
 The type to return when removing items from the queue. More...
 
typedef lock_traits::exception_type exception_type
 

Public Member Functions

 BOOST_MPL_ASSERT ((std::is_same< typename write_lock_type::atomic_t, atomic_t >))
 
atomic_t &__fastcall pop_lock () noexcept(true) FORCE_INLINE
 The underlying locks, to assist in writing thread-safe code. More...
 
atomic_t &__fastcall pop_lock () const noexcept(true) FORCE_INLINE
 The underlying locks, to assist in writing thread-safe code. More...
 
atomic_t &__fastcall push_lock () noexcept(true) FORCE_INLINE
 The underlying locks, to assist in writing thread-safe code. More...
 
atomic_t &__fastcall push_lock () const noexcept(true) FORCE_INLINE
 The underlying locks, to assist in writing thread-safe code. More...
 
__stdcall funky_queue () noexcept(noexcept(container_type()) &&noexcept(have_work_type())) FORCE_INLINE
 
 funky_queue (typename have_work_type::atomic_t &) FORCE_INLINE
 
__stdcall funky_queue (funky_queue const &) noexcept(false) FORCE_INLINE
 
__stdcall ~funky_queue () FORCE_INLINE
 
funky_queue &__fastcall operator= (funky_queue const &) noexcept(false) FORCE_INLINE
 
bool __fastcall empty () const noexcept(true) FORCE_INLINE
 
size_type __fastcall sync_size () const noexcept(false) FORCE_INLINE
 
size_type __fastcall size () const noexcept(true) FORCE_INLINE
 
void __fastcall clear () noexcept(false) FORCE_INLINE
 
bool __fastcall erase (value_type const &) noexcept(false) FORCE_INLINE
 
value_type __fastcall front () const noexcept(false) FORCE_INLINE
 
value_type __fastcall back () const noexcept(false) FORCE_INLINE
 
void __fastcall push (value_type const &v) noexcept(false) FORCE_INLINE
 
void __fastcall push (value_type &&v) noexcept(false) FORCE_INLINE
 
void __fastcall push_back (value_type const &v) noexcept(false) FORCE_INLINE
 
void __fastcall push_back (value_type &&v) noexcept(false) FORCE_INLINE
 
value_ret_type __fastcall pop () noexcept(false) FORCE_INLINE
 
value_ret_type __fastcall pop_front () noexcept(false) FORCE_INLINE
 
void __fastcall remove (const value_type &e) noexcept(false) FORCE_INLINE
 
container_type const & colln () const noexcept(true) FORCE_INLINE
 
container_type & colln () noexcept(true) FORCE_INLINE
 
value_ret_type __fastcall pop_front_nolk () noexcept(false) FORCE_INLINE
 
value_type __fastcall pop_front_1_nochk_nolk () noexcept(noexcept(have_work.remove())) FORCE_INLINE
 
value_type __fastcall pop_front_1_nochk_nosig () noexcept(true) FORCE_INLINE
 

Public Attributes

have_work_type have_work
 A flag to atomically signal if the container contains work or not, and how much work. More...
 

Static Public Attributes

static constexpr size_type serialise_size =2
 The size of the queue, below which the push & pop operations serialise. More...
 
static constexpr generic_traits::memory_access_modes memory_access_mode
 

Protected Member Functions

value_type &__fastcall back_nolk () noexcept(true) FORCE_INLINE
 
virtual value_ret_type __fastcall pop_front_nochk_nolk () noexcept(false) FORCE_INLINE
 

Detailed Description

template<typename QT, typename M, typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
class jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >

An adaptor to add thread-safety assistance, specifically for queues.

Note that this adaptor relies on the standardised behaviour of a sequence (or an adaptor thereof) with respect to invalidating iterators when items are added to or removed from removed from the container. Basically only std::list is guaranteed to satisfy these requirements, but std::queue often does, but that is implementation-dependent. This queue operates two locks, a pop & a push lock, that operate independently as long as the queue is large enough. The operations push() and push_back() have a push lock and are thus serialised. The operations pop() and pop_front() have a pop lock and are thus serialised. When the queue is too short, these pairs of operations are also mutually serialised. By default the adapted queue does not use a read-write lock. The iterators are not exposed to assist with writing thread-safe code. Note that if the read_lock_type and write_lock_types are the same, i.e. an exclusive lock were used, then the adaptor will exhibit EREW semantics. If a read-writer lock is used for them, then it will exhibit CREW semantics.

See also
safe_colln, queue

Definition at line 448 of file thread_safe_adaptors.hpp.

Member Typedef Documentation

◆ atomic_t

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef M jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::atomic_t

The underlying lock object to use.

Definition at line 452 of file thread_safe_adaptors.hpp.

◆ const_reference

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef container_type::const_reference jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::const_reference

Definition at line 461 of file thread_safe_adaptors.hpp.

◆ container_type

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef QT jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::container_type

The queue to be adapted, usually std::list or std::queue.

Definition at line 450 of file thread_safe_adaptors.hpp.

◆ exception_type

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef lock_traits::exception_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::exception_type

Definition at line 465 of file thread_safe_adaptors.hpp.

◆ have_work_type

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef Sig jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work_type

Used to enable functionality to atomically signal if the container contains work or not.

Definition at line 451 of file thread_safe_adaptors.hpp.

◆ lock_all_type

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef MLk jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::lock_all_type

The multi-lock type to use to ensured that operations on combined queues are thread-safe. Note that locking them in any order reduces the likelihood of deadlock at the cost of performance.

Definition at line 455 of file thread_safe_adaptors.hpp.

◆ lock_traits

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef write_lock_type::lock_traits jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::lock_traits

Definition at line 456 of file thread_safe_adaptors.hpp.

◆ read_lock_type

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef atomic_t::read_lock_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::read_lock_type

The type of read lock to use, by default the write lock. This allows the possibility of using a read-write lock.

Definition at line 454 of file thread_safe_adaptors.hpp.

◆ reference

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef container_type::reference jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::reference

Definition at line 460 of file thread_safe_adaptors.hpp.

◆ scoped_lock

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
template<class... T>
using jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::scoped_lock = typename lock_traits::template scoped_lock<T...>

Definition at line 458 of file thread_safe_adaptors.hpp.

◆ size_type

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef container_type::size_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::size_type

Definition at line 462 of file thread_safe_adaptors.hpp.

◆ thread_traits

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef api_threading_traits<lock_traits::api_type, typename lock_traits::model_type> jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::thread_traits

Definition at line 459 of file thread_safe_adaptors.hpp.

◆ value_ret_type

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef ValRet jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_ret_type

The type to return when removing items from the queue.

Definition at line 464 of file thread_safe_adaptors.hpp.

◆ value_type

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef container_type::value_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_type

Definition at line 463 of file thread_safe_adaptors.hpp.

◆ write_lock_type

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
typedef WL jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::write_lock_type

The type of write-lock to use. This allows the possibility of using a read-write lock.

Definition at line 453 of file thread_safe_adaptors.hpp.

Constructor & Destructor Documentation

◆ funky_queue() [1/3]

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::funky_queue
inlinenoexcept

Definition at line 441 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work.

◆ funky_queue() [2/3]

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::funky_queue ( typename have_work_type::atomic_t &  ev)
inlineexplicit

Definition at line 445 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work.

◆ funky_queue() [3/3]

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::funky_queue ( funky_queue< QT, M, WL, Sig, ValRet, MLk > const &  t)
inlinenoexcept

Definition at line 449 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work.

◆ ~funky_queue()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::~funky_queue
inline

Definition at line 458 of file thread_safe_adaptors_impl.hpp.

Member Function Documentation

◆ back()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::back
inlinenoexcept

If the queue is long enough, then this function will not block the operation of pop() or pop_back().

Returns
A copy of the value that is on the back of the queue.

Definition at line 541 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::back(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::back().

◆ back_nolk()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_type & jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::back_nolk
inlineprotectednoexcept

Definition at line 613 of file thread_safe_adaptors_impl.hpp.

◆ BOOST_MPL_ASSERT()

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::BOOST_MPL_ASSERT ( (std::is_same< typename write_lock_type::atomic_t, atomic_t >)  )

◆ clear()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
void jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::clear
inlinenoexcept

Definition at line 494 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work.

◆ colln() [1/2]

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
container_type const& jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::colln ( ) const
inlinenoexcept

Definition at line 578 of file thread_safe_adaptors.hpp.

◆ colln() [2/2]

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
container_type& jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::colln ( )
inlinenoexcept

Definition at line 581 of file thread_safe_adaptors.hpp.

◆ empty()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
bool jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::empty
inlinenoexcept

Definition at line 471 of file thread_safe_adaptors_impl.hpp.

◆ erase()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
bool jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::erase ( value_type const &  v)
inlinenoexcept

This function is provided to assist with writing thread-safe code.

Returns
Returns true if a value was erased, otherwise false.

Definition at line 502 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work.

◆ front()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::front
inlinenoexcept

If the queue is long enough, then this function will not block the operation of push() or push_back().

Returns
A copy of the value that is on the front of the queue.

Definition at line 517 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size.

◆ operator=()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk > & jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::operator= ( funky_queue< QT, M, WL, Sig, ValRet, MLk > const &  t)
inlinenoexcept

Definition at line 462 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work.

◆ pop()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_ret_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop
inlinenoexcept

If the queue is long enough, then this function will not block the operation of push() or push_front().

Returns
The value popped off the queue.

Definition at line 715 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size.

◆ pop_front()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_ret_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front
inlinenoexcept

If the queue is long enough, then this function will not block the operation of push() or push_front().

Returns
The value popped off the queue.

Definition at line 726 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front().

◆ pop_front_1_nochk_nolk()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_1_nochk_nolk
inlinenoexcept

Definition at line 658 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_nochk_nolk().

◆ pop_front_1_nochk_nosig()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_1_nochk_nosig
inlinenoexcept

Definition at line 667 of file thread_safe_adaptors_impl.hpp.

◆ pop_front_nochk_nolk()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_ret_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_nochk_nolk
inlineprotectedvirtualnoexcept

Definition at line 676 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_1_nochk_nolk().

◆ pop_front_nolk()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::value_ret_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_nolk
inlinenoexcept

Definition at line 693 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_nolk(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_nolk().

◆ pop_lock() [1/2]

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
atomic_t& __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_lock ( ) const
inlinenoexcept

The underlying locks, to assist in writing thread-safe code.

Definition at line 492 of file thread_safe_adaptors.hpp.

◆ pop_lock() [2/2]

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
atomic_t& __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_lock ( )
inlinenoexcept

The underlying locks, to assist in writing thread-safe code.

Definition at line 488 of file thread_safe_adaptors.hpp.

◆ push() [1/2]

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
void jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push ( value_type &&  v)
inlinenoexcept

If the queue is long enough, then this function will not block the operation of pop() or pop_back().

Parameters
vThe value to be added.

Definition at line 577 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work, and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size.

◆ push() [2/2]

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
void jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push ( value_type const &  v)
inlinenoexcept

If the queue is long enough, then this function will not block the operation of pop() or pop_back().

Parameters
vThe value to be added.

Definition at line 565 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work, and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size.

◆ push_back() [1/2]

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
void jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push_back ( value_type &&  v)
inlinenoexcept

If the queue is long enough, then this function will not block the operation of pop() or pop_back().

Parameters
vThe value to be added.

Definition at line 601 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work, jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size, and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::size().

◆ push_back() [2/2]

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
void jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push_back ( value_type const &  v)
inlinenoexcept

If the queue is long enough, then this function will not block the operation of pop() or pop_back().

Parameters
vThe value to be added.

Definition at line 589 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work, jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size, and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::size().

◆ push_lock() [1/2]

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
atomic_t& __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push_lock ( ) const
inlinenoexcept

The underlying locks, to assist in writing thread-safe code.

Definition at line 500 of file thread_safe_adaptors.hpp.

◆ push_lock() [2/2]

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
atomic_t& __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push_lock ( )
inlinenoexcept

The underlying locks, to assist in writing thread-safe code.

Definition at line 496 of file thread_safe_adaptors.hpp.

◆ remove()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
void jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::remove ( const value_type &  e)
inlinenoexcept
Parameters
eThe item to be removed from the container_type.

Definition at line 750 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work.

◆ size()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::size_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::size ( void  ) const
inlinenoexcept

Definition at line 488 of file thread_safe_adaptors_impl.hpp.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push_back().

◆ sync_size()

template<typename QT , typename M , typename WL , class Sig , class ValRet , class MLk >
ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::size_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::sync_size
inlinenoexcept

Definition at line 478 of file thread_safe_adaptors_impl.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work.

Member Data Documentation

◆ have_work

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
have_work_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::have_work
mutable

A flag to atomically signal if the container contains work or not, and how much work.

Definition at line 485 of file thread_safe_adaptors.hpp.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::clear(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::erase(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::funky_queue(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::operator=(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_1_nochk_nolk(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push_back(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::remove(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::sync_size().

◆ memory_access_mode

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
constexpr generic_traits::memory_access_modes jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::memory_access_mode
staticconstexpr
Initial value:
=(
write_lock_type::memory_access_mode==generic_traits::memory_access_modes::crew_memory_access
&& read_lock_type::memory_access_mode==generic_traits::memory_access_modes::crew_memory_access
&& lock_all_type::memory_access_mode==generic_traits::memory_access_modes::crew_memory_access
&& value_type::memory_access_mode==generic_traits::memory_access_modes::crew_memory_access
&& have_work_type::memory_access_mode==generic_traits::memory_access_modes::crew_memory_access
? generic_traits::memory_access_modes::crew_memory_access
: generic_traits::memory_access_modes::erew_memory_access
)
jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::generic_traits::memory_access_modes::erew_memory_access
@ erew_memory_access
Exclusive-Read, Exclusive-Write memory access.
jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::generic_traits::memory_access_modes::crew_memory_access
@ crew_memory_access
Concurrent-Read, Exclusive-Write memory access.

To assist in allowing compile-time computation of the algorithmic order of the threading model.

Definition at line 472 of file thread_safe_adaptors.hpp.

◆ serialise_size

template<typename QT , typename M , typename WL = typename M::write_lock_type, class Sig = no_signalling<M>, class ValRet = typename QT::value_type, class MLk = typename lock::any_order::all<M::lock_traits::api_type, typename M::lock_traits::model_type, M, M>>
constexpr size_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::serialise_size =2
staticconstexpr

The size of the queue, below which the push & pop operations serialise.

Definition at line 467 of file thread_safe_adaptors.hpp.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::back(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::front(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::pop_front_nolk(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::funky_queue< QT, M, WL, Sig, ValRet, MLk >::push_back().

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