Term::Private::BlockingQueue Class Reference

#include <cpp-terminal/private/blocking_queue.hpp>

Public Member Functions
	~BlockingQueue ()=default
	BlockingQueue ()=default
	BlockingQueue (const BlockingQueue &other)=delete
	BlockingQueue (BlockingQueue &&other)=delete
BlockingQueue &	operator= (const BlockingQueue &other)=delete
BlockingQueue &	operator= (BlockingQueue &&other)=delete
Term::Event	pop ()
void	push (const Term::Event &value, const std::size_t &occurrence=1)
void	push (const Term::Event &&value, const std::size_t &occurrence=1)
bool	empty ()
std::size_t	size ()
void	wait_for_events (std::unique_lock< std::mutex > &lock)

Private Attributes
std::mutex	m_mutex
std::queue< Term::Event >	m_queue
std::condition_variable	m_cv

Detailed Description

Definition at line 24 of file blocking_queue.hpp.

Constructor & Destructor Documentation

~BlockingQueue()

Term::Private::BlockingQueue::~BlockingQueue ( )

default

BlockingQueue() [1/3]

Term::Private::BlockingQueue::BlockingQueue ( )

default

BlockingQueue() [2/3]

Term::Private::BlockingQueue::BlockingQueue ( const BlockingQueue & other )

delete

BlockingQueue() [3/3]

Term::Private::BlockingQueue::BlockingQueue ( BlockingQueue && other )

delete

Member Function Documentation

empty()

bool Term::Private::BlockingQueue::empty

(

)

Definition at line 40 of file blocking_queue.cpp.

{
  const std::lock_guard<std::mutex> lock(m_mutex);
  return m_queue.empty();
}

operator=() [1/2]

BlockingQueue & Term::Private::BlockingQueue::operator= ( BlockingQueue && other )

delete

operator=() [2/2]

BlockingQueue & Term::Private::BlockingQueue::operator= ( const BlockingQueue & other )

delete

pop()

Term::Event Term::Private::BlockingQueue::pop

(

)

Definition at line 12 of file blocking_queue.cpp.

{
  const std::lock_guard<std::mutex> lock(m_mutex);
  Term::Event                       value = this->m_queue.front();
  m_queue.pop();
  return value;
}

push() [1/2]

void Term::Private::BlockingQueue::push	(	const Term::Event &&	value,
		const std::size_t &	occurrence = 1 )

Definition at line 30 of file blocking_queue.cpp.

{
  for(std::size_t i = 0; i != occurrence; ++i)
  {
    const std::lock_guard<std::mutex> lock(m_mutex);
    m_queue.push(value);
    m_cv.notify_all();
  }
}

push() [2/2]

void Term::Private::BlockingQueue::push	(	const Term::Event &	value,
		const std::size_t &	occurrence = 1 )

Definition at line 20 of file blocking_queue.cpp.

{
  for(std::size_t i = 0; i != occurrence; ++i)
  {
    const std::lock_guard<std::mutex> lock(m_mutex);
    m_queue.push(value);
    m_cv.notify_all();
  }
}

size()

std::size_t Term::Private::BlockingQueue::size

(

)

Definition at line 46 of file blocking_queue.cpp.

{
  const std::lock_guard<std::mutex> lock(m_mutex);
  return m_queue.size();
}

wait_for_events()

void Term::Private::BlockingQueue::wait_for_events

(

std::unique_lock< std::mutex > &

lock

)

Definition at line 52 of file blocking_queue.cpp.

{ m_cv.wait(lock); }

Member Data Documentation

m_cv

std::condition_variable Term::Private::BlockingQueue::m_cv

private

Definition at line 43 of file blocking_queue.hpp.

m_mutex

std::mutex Term::Private::BlockingQueue::m_mutex

private

Definition at line 41 of file blocking_queue.hpp.

m_queue

std::queue<Term::Event> Term::Private::BlockingQueue::m_queue

private

Definition at line 42 of file blocking_queue.hpp.

---

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

• cpp-terminal/private/blocking_queue.hpp
• cpp-terminal/private/blocking_queue.cpp