BlockingReaderWriterQueue Class Reference

#include <readerwriterqueue.h>

Collaboration diagram for BlockingReaderWriterQueue:

Public Member Functions
	BlockingReaderWriterQueue (size_t maxSize=15) AE_NO_TSAN
	BlockingReaderWriterQueue (BlockingReaderWriterQueue &&other) AE_NO_TSAN
BlockingReaderWriterQueue &	operator= (BlockingReaderWriterQueue &&other) AE_NO_TSAN
AE_FORCEINLINE bool	enqueue (UINT8 *const &element) AE_NO_TSAN
bool	try_dequeue (UINT8 *&result) AE_NO_TSAN
void	wait_dequeue (UINT8 *&result) AE_NO_TSAN
bool	wait_dequeue_timed (UINT8 *&result, std::int64_t timeout_usecs) AE_NO_TSAN
AE_FORCEINLINE UINT8 *	peek () AE_NO_TSAN
AE_FORCEINLINE bool	pop () AE_NO_TSAN
AE_FORCEINLINE size_t	size_approx () const AE_NO_TSAN

Private Attributes
ReaderWriterQueue	inner
std::unique_ptr< spsc_sema::LightweightSemaphore >	sema

Detailed Description

Definition at line 558 of file readerwriterqueue.h.

Constructor & Destructor Documentation

BlockingReaderWriterQueue() [1/2]

BlockingReaderWriterQueue::BlockingReaderWriterQueue ( size_t  maxSize = 15 )

inlineexplicit

Definition at line 562 of file readerwriterqueue.h.

    : inner(maxSize), sema(new spsc_sema::LightweightSemaphore())
  { }

BlockingReaderWriterQueue() [2/2]

BlockingReaderWriterQueue::BlockingReaderWriterQueue ( BlockingReaderWriterQueue &&  other )

inline

Definition at line 566 of file readerwriterqueue.h.

    : inner(std::move(other.inner)), sema(std::move(other.sema))
  { }

Member Function Documentation

enqueue()

AE_FORCEINLINE bool BlockingReaderWriterQueue::enqueue ( UINT8 *const &  element )

inline

Definition at line 580 of file readerwriterqueue.h.

  {
    if (inner.enqueue(element)) {
      sema->signal();
      return true;
    }
    return false;
  }

References ReaderWriterQueue::enqueue(), inner, and sema.

Here is the call graph for this function:

operator=()

BlockingReaderWriterQueue& BlockingReaderWriterQueue::operator= ( BlockingReaderWriterQueue &&  other )

inline

Definition at line 570 of file readerwriterqueue.h.

  {
    std::swap(sema, other.sema);
    std::swap(inner, other.inner);
    return *this;
  }

References inner, and sema.

peek()

AE_FORCEINLINE UINT8* BlockingReaderWriterQueue::peek ( )

inline

Definition at line 657 of file readerwriterqueue.h.

  {
    return inner.peek();
  }

References inner, and ReaderWriterQueue::peek().

Here is the call graph for this function:

pop()

AE_FORCEINLINE bool BlockingReaderWriterQueue::pop ( )

inline

Definition at line 665 of file readerwriterqueue.h.

  {
    if (sema->tryWait()) {
      bool result = inner.pop();
      assert(result);
      AE_UNUSED(result);
      return true;
    }
    return false;
  }

References AE_UNUSED, inner, ReaderWriterQueue::pop(), and sema.

Here is the call graph for this function:

size_approx()

AE_FORCEINLINE size_t BlockingReaderWriterQueue::size_approx ( ) const

inline

Definition at line 678 of file readerwriterqueue.h.

  {
    return sema->availableApprox();
  }

References sema.

try_dequeue()

bool BlockingReaderWriterQueue::try_dequeue ( UINT8 *&  result )

inline

Definition at line 594 of file readerwriterqueue.h.

  {
    if (sema->tryWait()) {
      bool success = inner.try_dequeue(result);
      assert(success);
      AE_UNUSED(success);
      return true;
    }
    return false;
  }

References AE_UNUSED, inner, sema, and ReaderWriterQueue::try_dequeue().

Here is the call graph for this function:

wait_dequeue()

void BlockingReaderWriterQueue::wait_dequeue ( UINT8 *&  result )

inline

Definition at line 608 of file readerwriterqueue.h.

  {
    sema->wait();
    bool success = inner.try_dequeue(result);
    AE_UNUSED(result);
    assert(success);
    AE_UNUSED(success);
  }

References AE_UNUSED, inner, sema, and ReaderWriterQueue::try_dequeue().

Here is the call graph for this function:

wait_dequeue_timed()

bool BlockingReaderWriterQueue::wait_dequeue_timed ( UINT8 *&  result, std::int64_t  timeout_usecs  )

inline

Definition at line 624 of file readerwriterqueue.h.

  {
    if (!sema->wait(timeout_usecs)) {
      return false;
    }
    bool success = inner.try_dequeue(result);
    AE_UNUSED(result);
    assert(success);
    AE_UNUSED(success);
    return true;
  }

References AE_UNUSED, inner, sema, and ReaderWriterQueue::try_dequeue().

Here is the call graph for this function:

Member Data Documentation

inner

ReaderWriterQueue BlockingReaderWriterQueue::inner

private

Definition at line 686 of file readerwriterqueue.h.

Referenced by enqueue(), operator=(), peek(), pop(), try_dequeue(), wait_dequeue(), and wait_dequeue_timed().

sema

std::unique_ptr<spsc_sema::LightweightSemaphore> BlockingReaderWriterQueue::sema

private

Definition at line 687 of file readerwriterqueue.h.

Referenced by enqueue(), operator=(), pop(), size_approx(), try_dequeue(), wait_dequeue(), and wait_dequeue_timed().

---

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

• readerwriterqueue.h