spdlog::details::mpmc_blocking_queue< T > Class Template Reference

#include <mpmc_blocking_q.h>

Public Types
using	item_type = T

Public Member Functions
	mpmc_blocking_queue (size_t max_items)
void	enqueue (T &&item)
void	enqueue_nowait (T &&item)
bool	dequeue_for (T &popped_item, std::chrono::milliseconds wait_duration)
size_t	overrun_counter ()

Private Attributes
std::mutex	queue_mutex_
std::condition_variable	push_cv_
std::condition_variable	pop_cv_
spdlog::details::circular_q< T >	q_

Detailed Description

template<typename T>
class spdlog::details::mpmc_blocking_queue< T >

Definition at line 24 of file mpmc_blocking_q.h.

Member Typedef Documentation

template<typename T>

using spdlog::details::mpmc_blocking_queue< T >::item_type = T

Definition at line 27 of file mpmc_blocking_q.h.

Constructor & Destructor Documentation

template<typename T>

spdlog::details::mpmc_blocking_queue< T >::mpmc_blocking_queue ( size_t  max_items )

inlineexplicit

Definition at line 28 of file mpmc_blocking_q.h.

        : q_(max_items)
    {
    }

Member Function Documentation

template<typename T>

bool spdlog::details::mpmc_blocking_queue< T >::dequeue_for ( T &  popped_item, std::chrono::milliseconds  wait_duration  )

inline

Definition at line 57 of file mpmc_blocking_q.h.

    {
        {
            std::unique_lock<std::mutex> lock(queue_mutex_);
            if (!push_cv_.wait_for(lock, wait_duration, [this] { return !this->q_.empty(); }))
            {
                return false;
            }
            q_.pop_front(popped_item);
        }
        pop_cv_.notify_one();
        return true;
    }

template<typename T>

void spdlog::details::mpmc_blocking_queue< T >::enqueue ( T &&  item )

inline

Definition at line 35 of file mpmc_blocking_q.h.

    {
        {
            std::unique_lock<std::mutex> lock(queue_mutex_);
            pop_cv_.wait(lock, [this] { return !this->q_.full(); });
            q_.push_back(std::move(item));
        }
        push_cv_.notify_one();
    }

template<typename T>

void spdlog::details::mpmc_blocking_queue< T >::enqueue_nowait ( T &&  item )

inline

Definition at line 46 of file mpmc_blocking_q.h.

    {
        {
            std::unique_lock<std::mutex> lock(queue_mutex_);
            q_.push_back(std::move(item));
        }
        push_cv_.notify_one();
    }

template<typename T>

size_t spdlog::details::mpmc_blocking_queue< T >::overrun_counter ( )

inline

Definition at line 108 of file mpmc_blocking_q.h.

    {
        std::unique_lock<std::mutex> lock(queue_mutex_);
        return q_.overrun_counter();
    }

Member Data Documentation

template<typename T>

std::condition_variable spdlog::details::mpmc_blocking_queue< T >::pop_cv_

private

Definition at line 117 of file mpmc_blocking_q.h.

template<typename T>

std::condition_variable spdlog::details::mpmc_blocking_queue< T >::push_cv_

private

Definition at line 116 of file mpmc_blocking_q.h.

template<typename T>

spdlog::details::circular_q<T> spdlog::details::mpmc_blocking_queue< T >::q_

private

Definition at line 118 of file mpmc_blocking_q.h.

template<typename T>

std::mutex spdlog::details::mpmc_blocking_queue< T >::queue_mutex_

private

Definition at line 115 of file mpmc_blocking_q.h.

---

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

• wire-cell-build/util/inc/spdlog/details/mpmc_blocking_q.h