Vince's CSV Parser
Loading...
Searching...
No Matches
Public Member Functions | List of all members
csv::internals::ThreadSafeDeque< T > Class Template Reference

A std::deque wrapper which allows multiple read and write threads to concurrently access it along with providing read threads the ability to wait for the deque to become populated. More...

#include <thread_safe_deque.hpp>

Public Member Functions

 ThreadSafeDeque (size_t notify_size=100)
 
 ThreadSafeDeque (const ThreadSafeDeque &other)
 
 ThreadSafeDeque (const std::deque< T > &source)
 
bool empty () const noexcept
 
T & front () noexcept
 
T & operator[] (size_t n)
 NOTE: operator[] is not synchronized.
 
void push_back (T &&item)
 
T pop_front () noexcept
 
bool is_waitable () const noexcept
 Returns true if a thread is actively pushing items to this deque.
 
void wait ()
 
size_t size () const noexcept
 
std::deque< T >::iterator begin () noexcept
 
std::deque< T >::iterator end () noexcept
 
void notify_all ()
 Tell listeners that this deque is actively being pushed to.
 
void kill_all ()
 

Detailed Description

template<typename T>
class csv::internals::ThreadSafeDeque< T >

A std::deque wrapper which allows multiple read and write threads to concurrently access it along with providing read threads the ability to wait for the deque to become populated.

Concurrency strategy: writer-side mutations (push_back/pop_front) are locked; hot-path flags (empty/is_waitable) are atomic; operator[] and iterators are not synchronized and must not run concurrently with writers.

Definition at line 29 of file thread_safe_deque.hpp.

Constructor & Destructor Documentation

◆ ThreadSafeDeque() [1/3]

template<typename T >
csv::internals::ThreadSafeDeque< T >::ThreadSafeDeque ( size_t  notify_size = 100)
inline

Definition at line 31 of file thread_safe_deque.hpp.

◆ ThreadSafeDeque() [2/3]

template<typename T >
csv::internals::ThreadSafeDeque< T >::ThreadSafeDeque ( const ThreadSafeDeque< T > &  other)
inline

Definition at line 33 of file thread_safe_deque.hpp.

◆ ThreadSafeDeque() [3/3]

template<typename T >
csv::internals::ThreadSafeDeque< T >::ThreadSafeDeque ( const std::deque< T > &  source)
inline

Definition at line 39 of file thread_safe_deque.hpp.

Member Function Documentation

◆ begin()

template<typename T >
std::deque< T >::iterator csv::internals::ThreadSafeDeque< T >::begin ( )
inlinenoexcept

Definition at line 104 of file thread_safe_deque.hpp.

◆ empty()

template<typename T >
bool csv::internals::ThreadSafeDeque< T >::empty ( ) const
inlinenoexcept

Definition at line 44 of file thread_safe_deque.hpp.

◆ end()

template<typename T >
std::deque< T >::iterator csv::internals::ThreadSafeDeque< T >::end ( )
inlinenoexcept

Definition at line 108 of file thread_safe_deque.hpp.

◆ front()

template<typename T >
T & csv::internals::ThreadSafeDeque< T >::front ( )
inlinenoexcept

Definition at line 48 of file thread_safe_deque.hpp.

◆ is_waitable()

template<typename T >
bool csv::internals::ThreadSafeDeque< T >::is_waitable ( ) const
inlinenoexcept

Returns true if a thread is actively pushing items to this deque.

Definition at line 85 of file thread_safe_deque.hpp.

◆ kill_all()

template<typename T >
void csv::internals::ThreadSafeDeque< T >::kill_all ( )
inline

Definition at line 119 of file thread_safe_deque.hpp.

◆ notify_all()

template<typename T >
void csv::internals::ThreadSafeDeque< T >::notify_all ( )
inline

Tell listeners that this deque is actively being pushed to.

Definition at line 113 of file thread_safe_deque.hpp.

◆ operator[]()

template<typename T >
T & csv::internals::ThreadSafeDeque< T >::operator[] ( size_t  n)
inline

NOTE: operator[] is not synchronized.

Only call when no concurrent push_back/pop_front can occur. std::deque can reallocate its internal map on push_back, which makes concurrent operator[] access undefined behavior.

Definition at line 58 of file thread_safe_deque.hpp.

◆ pop_front()

template<typename T >
T csv::internals::ThreadSafeDeque< T >::pop_front ( )
inlinenoexcept

Definition at line 72 of file thread_safe_deque.hpp.

◆ push_back()

template<typename T >
void csv::internals::ThreadSafeDeque< T >::push_back ( T &&  item)
inline

Definition at line 62 of file thread_safe_deque.hpp.

◆ size()

template<typename T >
size_t csv::internals::ThreadSafeDeque< T >::size ( ) const
inlinenoexcept

Definition at line 99 of file thread_safe_deque.hpp.

◆ wait()

template<typename T >
void csv::internals::ThreadSafeDeque< T >::wait ( )
inline

Definition at line 89 of file thread_safe_deque.hpp.

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