VW::ptr_queue< T > Class Template Reference

#include <queue.h>

Public Member Functions
	ptr_queue (size_t max_size)
T *	pop ()
void	push (T *item)
void	set_done ()
size_t	size () const

Private Attributes
size_t	max_size
std::queue< T * >	object_queue
std::mutex	mut
bool	done = false
std::condition_variable	is_not_full
std::condition_variable	is_not_empty

Detailed Description

template<typename T>
class VW::ptr_queue< T >

Definition at line 22 of file queue.h.

Constructor & Destructor Documentation

ptr_queue()

template<typename T>

VW::ptr_queue< T >::ptr_queue ( size_t  max_size )

inline

Definition at line 25 of file queue.h.

: max_size(max_size) {}

Member Function Documentation

pop()

template<typename T>

T* VW::ptr_queue< T >::pop ( )

inline

Definition at line 27 of file queue.h.

Referenced by free_parser(), and VW::get_example().

  {
    std::unique_lock<std::mutex> lock(mut);
    while (!done && object_queue.size() == 0)
    {
      is_not_empty.wait(lock);
    }

    if (done && object_queue.size() == 0)
    {
      return nullptr;
    }

    auto item = object_queue.front();
    object_queue.pop();

    lock.unlock();
    is_not_full.notify_all();
    return item;
  }

push()

template<typename T>

void VW::ptr_queue< T >::push ( T *  item )

inline

Definition at line 48 of file queue.h.

Referenced by thread_dispatch().

  {
    std::unique_lock<std::mutex> lock(mut);
    while (object_queue.size() == max_size)
    {
      is_not_full.wait(lock);
    }

    object_queue.push(item);

    lock.unlock();
    is_not_empty.notify_all();
  }

set_done()

template<typename T>

void VW::ptr_queue< T >::set_done ( )

inline

Definition at line 62 of file queue.h.

Referenced by lock_done().

  {
    done = true;

    is_not_empty.notify_all();
    is_not_full.notify_all();
  }

size()

template<typename T>

size_t VW::ptr_queue< T >::size ( ) const

inline

Definition at line 70 of file queue.h.

Referenced by free_parser(), and reset_source().

{ return object_queue.size(); }

Member Data Documentation

done

template<typename T>

bool VW::ptr_queue< T >::done = false

private

Definition at line 77 of file queue.h.

Referenced by VW::ptr_queue< example >::pop(), and VW::ptr_queue< example >::set_done().

is_not_empty

template<typename T>

std::condition_variable VW::ptr_queue< T >::is_not_empty

private

Definition at line 80 of file queue.h.

Referenced by VW::ptr_queue< example >::pop(), VW::ptr_queue< example >::push(), and VW::ptr_queue< example >::set_done().

is_not_full

template<typename T>

std::condition_variable VW::ptr_queue< T >::is_not_full

private

Definition at line 79 of file queue.h.

Referenced by VW::ptr_queue< example >::pop(), VW::ptr_queue< example >::push(), and VW::ptr_queue< example >::set_done().

max_size

template<typename T>

size_t VW::ptr_queue< T >::max_size

private

Definition at line 73 of file queue.h.

Referenced by VW::ptr_queue< example >::push().

mut

template<typename T>

std::mutex VW::ptr_queue< T >::mut

private

Definition at line 75 of file queue.h.

Referenced by VW::ptr_queue< example >::pop(), and VW::ptr_queue< example >::push().

object_queue

template<typename T>

std::queue<T*> VW::ptr_queue< T >::object_queue

private

Definition at line 74 of file queue.h.

Referenced by VW::ptr_queue< example >::pop(), VW::ptr_queue< example >::push(), and VW::ptr_queue< example >::size().

---

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

• /mnt/c/w/linux/vowpal_wabbit/vowpalwabbit/queue.h