LockFreeQueue< T > Class Template Reference

#include <LockFreeQueue.h>

Inheritance diagram for LockFreeQueue< T >:

Collaboration diagram for LockFreeQueue< T >:

Public Member Functions
	LockFreeQueue (size_t maxLen)
	~LockFreeQueue ()
bool	Put (const T &msg)
bool	Get (T &msg)
void	Clear ()

Private Attributes
NonInterfering< std::atomic< size_t > >	mStart { 0 }
NonInterfering< std::atomic< size_t > >	mEnd { 0 }
const size_t	mBufferSize
ArrayOf< T >	mBuffer { mBufferSize }

Additional Inherited Members
Static Public Member Functions inherited from SharedNonInterfering< LockFreeQueue< T > >
static std::shared_ptr< LockFreeQueue< T > >	make_shared (Args &&...args)

Detailed Description

template<typename T>
class LockFreeQueue< T >

---

Audacity: A Digital Audio Editor

LockFreeQueue.h

Matthieu Hodgkinson Moved from MeterPanel.h

Definition at line 20 of file LockFreeQueue.h.

Constructor & Destructor Documentation

LockFreeQueue()

template<typename T >

LockFreeQueue< T >::LockFreeQueue ( size_t  maxLen )

explicit

Definition at line 41 of file LockFreeQueue.h.

    : mBufferSize(maxLen)
{
   Clear();
}

References LockFreeQueue< T >::Clear().

Here is the call graph for this function:

~LockFreeQueue()

template<typename T >

LockFreeQueue< T >::~LockFreeQueue

Definition at line 48 of file LockFreeQueue.h.

{
}

Member Function Documentation

Clear()

template<typename T >

void LockFreeQueue< T >::Clear

Definition at line 52 of file LockFreeQueue.h.

{
   mStart.store(0);
   mEnd.store(0);
}

Referenced by LockFreeQueue< T >::LockFreeQueue().

Here is the caller graph for this function:

Get()

template<typename T >

bool LockFreeQueue< T >::Get

(

T &

msg

)

Definition at line 83 of file LockFreeQueue.h.

{
   auto start = mStart.load(std::memory_order_relaxed);
   auto end = mEnd.load(std::memory_order_acquire);
   int len = (end + mBufferSize - start) % mBufferSize;
 
   if (len == 0)
      return false;
 
   msg = mBuffer[start];
   mStart.store((start + 1) % mBufferSize, std::memory_order_release);
 
   return true;
}

References details::end().

Here is the call graph for this function:

Put()

template<typename T >

bool LockFreeQueue< T >::Put

(

const T &

msg

)

Definition at line 60 of file LockFreeQueue.h.

{
   auto start = mStart.load(std::memory_order_acquire);
   auto end = mEnd.load(std::memory_order_relaxed);
   // mStart can be greater than mEnd because it is all mod mBufferSize
   assert((end + mBufferSize - start) >= 0);
   int len = (end + mBufferSize - start) % mBufferSize;
 
   // Never completely fill the queue, because then the
   // state is ambiguous (mStart==mEnd)
   if (len + 1 >= (int)(mBufferSize))
      return false;
 
   // wxLogDebug(wxT("Put: %s"), msg.toString());
 
   mBuffer[end] = msg;
   mEnd.store((end + 1) % mBufferSize, std::memory_order_release);
 
   return true;
}

References details::end().

Here is the call graph for this function:

Member Data Documentation

mBuffer

template<typename T >

ArrayOf<T> LockFreeQueue< T >::mBuffer { mBufferSize }

private

Definition at line 37 of file LockFreeQueue.h.

mBufferSize

template<typename T >

const size_t LockFreeQueue< T >::mBufferSize

private

Definition at line 36 of file LockFreeQueue.h.

mEnd

template<typename T >

NonInterfering<std::atomic<size_t> > LockFreeQueue< T >::mEnd { 0 }

private

Definition at line 34 of file LockFreeQueue.h.

mStart

template<typename T >

NonInterfering<std::atomic<size_t> > LockFreeQueue< T >::mStart { 0 }

private

Definition at line 34 of file LockFreeQueue.h.

---

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

• LockFreeQueue.h