Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
boost::lockfree::detail::ringbuffer_base< T > Class Template Reference

#include <spsc_queue.hpp>

Inheritance diagram for boost::lockfree::detail::ringbuffer_base< T >:
Inheritance graph
[legend]

Public Member Functions

void reset (void)
 reset the ringbuffer More...
 
bool empty (void)
 Check if the ringbuffer is empty. More...
 
bool is_lock_free (void) const
 

Protected Member Functions

 ringbuffer_base (void)
 
size_t read_available (size_t max_size) const
 
size_t write_available (size_t max_size) const
 
bool push (T const &t, T *buffer, size_t max_size)
 
size_t push (const T *input_buffer, size_t input_count, T *internal_buffer, size_t max_size)
 
template<typename ConstIterator >
ConstIterator push (ConstIterator begin, ConstIterator end, T *internal_buffer, size_t max_size)
 
template<typename Functor >
bool consume_one (Functor &functor, T *buffer, size_t max_size)
 
template<typename Functor >
bool consume_one (Functor const &functor, T *buffer, size_t max_size)
 
template<typename Functor >
size_t consume_all (Functor const &functor, T *internal_buffer, size_t max_size)
 
template<typename Functor >
size_t consume_all (Functor &functor, T *internal_buffer, size_t max_size)
 
size_t pop (T *output_buffer, size_t output_count, T *internal_buffer, size_t max_size)
 
template<typename OutputIterator >
size_t pop_to_output_iterator (OutputIterator it, T *internal_buffer, size_t max_size)
 
const T & front (const T *internal_buffer) const
 
T & front (T *internal_buffer)
 

Static Protected Member Functions

static size_t next_index (size_t arg, size_t max_size)
 
static size_t read_available (size_t write_index, size_t read_index, size_t max_size)
 
static size_t write_available (size_t write_index, size_t read_index, size_t max_size)
 

Constructor & Destructor Documentation

template<typename T >
boost::lockfree::detail::ringbuffer_base< T >::ringbuffer_base ( void  )
inlineprotected

Member Function Documentation

template<typename T >
template<typename Functor >
size_t boost::lockfree::detail::ringbuffer_base< T >::consume_all ( Functor const &  functor,
T *  internal_buffer,
size_t  max_size 
)
inlineprotected

References boost::memory_order_acquire, boost::memory_order_relaxed, boost::memory_order_release, and boost::lockfree::detail::ringbuffer_base< T >::read_available().

Referenced by boost::lockfree::detail::compile_time_sized_ringbuffer< T, MaxSize >::consume_all(), and boost::lockfree::detail::runtime_sized_ringbuffer< T, Alloc >::consume_all().

template<typename T >
template<typename Functor >
size_t boost::lockfree::detail::ringbuffer_base< T >::consume_all ( Functor &  functor,
T *  internal_buffer,
size_t  max_size 
)
inlineprotected

References boost::memory_order_acquire, boost::memory_order_relaxed, boost::memory_order_release, and boost::lockfree::detail::ringbuffer_base< T >::read_available().

template<typename T >
template<typename Functor >
bool boost::lockfree::detail::ringbuffer_base< T >::consume_one ( Functor &  functor,
T *  buffer,
size_t  max_size 
)
inlineprotected

References boost::lockfree::detail::ringbuffer_base< T >::empty(), boost::memory_order_acquire, boost::memory_order_relaxed, boost::memory_order_release, boost::next(), boost::lockfree::detail::ringbuffer_base< T >::next_index(), and T.

Referenced by boost::lockfree::detail::compile_time_sized_ringbuffer< T, MaxSize >::consume_one(), and boost::lockfree::detail::runtime_sized_ringbuffer< T, Alloc >::consume_one().

template<typename T >
template<typename Functor >
bool boost::lockfree::detail::ringbuffer_base< T >::consume_one ( Functor const &  functor,
T *  buffer,
size_t  max_size 
)
inlineprotected

References boost::lockfree::detail::ringbuffer_base< T >::empty(), boost::memory_order_acquire, boost::memory_order_relaxed, boost::memory_order_release, boost::next(), boost::lockfree::detail::ringbuffer_base< T >::next_index(), and T.

template<typename T >
bool boost::lockfree::detail::ringbuffer_base< T >::empty ( void  )
inline

Check if the ringbuffer is empty.

Returns
true, if the ringbuffer is empty, false otherwise
Note
Due to the concurrent nature of the ringbuffer the result may be inaccurate.

References boost::memory_order_relaxed.

Referenced by boost::lockfree::detail::ringbuffer_base< T >::consume_one().

template<typename T >
const T& boost::lockfree::detail::ringbuffer_base< T >::front ( const T *  internal_buffer) const
inlineprotected

References boost::memory_order_relaxed.

Referenced by boost::lockfree::detail::compile_time_sized_ringbuffer< T, MaxSize >::front(), and boost::lockfree::detail::runtime_sized_ringbuffer< T, Alloc >::front().

template<typename T >
T& boost::lockfree::detail::ringbuffer_base< T >::front ( T *  internal_buffer)
inlineprotected

References boost::memory_order_relaxed.

template<typename T >
bool boost::lockfree::detail::ringbuffer_base< T >::is_lock_free ( void  ) const
inline
Returns
true, if implementation is lock-free.
template<typename T >
static size_t boost::lockfree::detail::ringbuffer_base< T >::next_index ( size_t  arg,
size_t  max_size 
)
inlinestaticprotected

Referenced by boost::lockfree::detail::ringbuffer_base< T >::consume_one(), and boost::lockfree::detail::ringbuffer_base< T >::push().

template<typename T >
size_t boost::lockfree::detail::ringbuffer_base< T >::pop ( T *  output_buffer,
size_t  output_count,
T *  internal_buffer,
size_t  max_size 
)
inlineprotected

References boost::memory_order_acquire, boost::memory_order_relaxed, boost::memory_order_release, boost::accumulators::extract::min, and boost::lockfree::detail::ringbuffer_base< T >::read_available().

Referenced by boost::lockfree::detail::compile_time_sized_ringbuffer< T, MaxSize >::pop(), boost::lockfree::detail::runtime_sized_ringbuffer< T, Alloc >::pop(), and boost::lockfree::detail::ringbuffer_base< T >::reset().

template<typename T >
template<typename OutputIterator >
size_t boost::lockfree::detail::ringbuffer_base< T >::pop_to_output_iterator ( OutputIterator  it,
T *  internal_buffer,
size_t  max_size 
)
inlineprotected

References boost::memory_order_acquire, boost::memory_order_relaxed, boost::memory_order_release, and boost::lockfree::detail::ringbuffer_base< T >::read_available().

Referenced by boost::lockfree::detail::compile_time_sized_ringbuffer< T, MaxSize >::pop_to_output_iterator(), and boost::lockfree::detail::runtime_sized_ringbuffer< T, Alloc >::pop_to_output_iterator().

template<typename T >
bool boost::lockfree::detail::ringbuffer_base< T >::push ( T const &  t,
T *  buffer,
size_t  max_size 
)
inlineprotected

References boost::memory_order_acquire, boost::memory_order_relaxed, boost::memory_order_release, boost::next(), boost::lockfree::detail::ringbuffer_base< T >::next_index(), and T.

Referenced by boost::lockfree::detail::ringbuffer_base< T >::push(), boost::lockfree::detail::compile_time_sized_ringbuffer< T, MaxSize >::push(), and boost::lockfree::detail::runtime_sized_ringbuffer< T, Alloc >::push().

template<typename T >
size_t boost::lockfree::detail::ringbuffer_base< T >::push ( const T *  input_buffer,
size_t  input_count,
T *  internal_buffer,
size_t  max_size 
)
inlineprotected

References boost::lockfree::detail::ringbuffer_base< T >::push().

template<typename T >
template<typename ConstIterator >
ConstIterator boost::lockfree::detail::ringbuffer_base< T >::push ( ConstIterator  begin,
ConstIterator  end,
T *  internal_buffer,
size_t  max_size 
)
inlineprotected

References boost::asio::begin, boost::fusion::distance(), boost::last, boost::memory_order_acquire, boost::memory_order_relaxed, boost::memory_order_release, boost::accumulators::extract::min, boost::next(), boost::cb_details::uninitialized_copy(), and boost::lockfree::detail::ringbuffer_base< T >::write_available().

template<typename T >
static size_t boost::lockfree::detail::ringbuffer_base< T >::read_available ( size_t  write_index,
size_t  read_index,
size_t  max_size 
)
inlinestaticprotected

Referenced by boost::lockfree::detail::ringbuffer_base< T >::consume_all(), boost::lockfree::detail::ringbuffer_base< T >::pop(), boost::lockfree::detail::ringbuffer_base< T >::pop_to_output_iterator(), and boost::lockfree::detail::ringbuffer_base< T >::read_available().

template<typename T >
size_t boost::lockfree::detail::ringbuffer_base< T >::read_available ( size_t  max_size) const
inlineprotected

References boost::memory_order_relaxed, and boost::lockfree::detail::ringbuffer_base< T >::read_available().

template<typename T >
void boost::lockfree::detail::ringbuffer_base< T >::reset ( void  )
inline

reset the ringbuffer

Note
Not thread-safe

References boost::memory_order_relaxed, boost::memory_order_release, boost::lockfree::detail::ringbuffer_base< T >::pop(), and T.

template<typename T >
static size_t boost::lockfree::detail::ringbuffer_base< T >::write_available ( size_t  write_index,
size_t  read_index,
size_t  max_size 
)
inlinestaticprotected

Referenced by boost::lockfree::detail::ringbuffer_base< T >::push(), and boost::lockfree::detail::ringbuffer_base< T >::write_available().

template<typename T >
size_t boost::lockfree::detail::ringbuffer_base< T >::write_available ( size_t  max_size) const
inlineprotected

References boost::memory_order_relaxed, and boost::lockfree::detail::ringbuffer_base< T >::write_available().

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