Slic3r::Channel< T > Class Template Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/Channel.hpp>

Inheritance diagram for Slic3r::Channel< T >:

Collaboration diagram for Slic3r::Channel< T >:

Classes
class	Unlocker

Public Types
using	UniqueLock = std::unique_lock<std::mutex>
using	Queue = std::deque<T>
using	LockedConstPtr = std::unique_ptr<const Queue, Unlocker<const Queue>>
using	LockedPtr = std::unique_ptr<Queue, Unlocker<Queue>>

Public Member Functions
	Channel ()
	~Channel ()
void	push (const T &item, bool silent=false)
void	push (T &&item, bool silent=false)
T	pop ()
boost::optional< T >	try_pop ()
size_t	size_hint () const noexcept
LockedConstPtr	lock_read () const
LockedPtr	lock_rw ()

Private Attributes
Queue	m_queue
std::mutex	m_mutex
std::condition_variable	m_condition

Detailed Description

template<class T>
class Slic3r::Channel< T >

Member Typedef Documentation

LockedConstPtr

template<class T>

using Slic3r::Channel< T >::LockedConstPtr = std::unique_ptr<const Queue, Unlocker<const Queue>>

LockedPtr

template<class T>

using Slic3r::Channel< T >::LockedPtr = std::unique_ptr<Queue, Unlocker<Queue>>

Queue

template<class T>

using Slic3r::Channel< T >::Queue = std::deque<T>

UniqueLock

template<class T>

using Slic3r::Channel< T >::UniqueLock = std::unique_lock<std::mutex>

Constructor & Destructor Documentation

Channel()

template<class T>

Slic3r::Channel< T >::Channel ( )

inline

{}

~Channel()

template<class T>

Slic3r::Channel< T >::~Channel ( )

inline

{}

Member Function Documentation

lock_read()

template<class T>

LockedConstPtr Slic3r::Channel< T >::lock_read ( ) const

inline

    {
        return LockedConstPtr(&m_queue, Unlocker<const Queue>(UniqueLock(m_mutex)));
    }

References m_mutex, and m_queue.

lock_rw()

template<class T>

LockedPtr Slic3r::Channel< T >::lock_rw ( )

inline

    {
        return LockedPtr(&m_queue, Unlocker<Queue>(UniqueLock(m_mutex)));
    }

References m_mutex, and m_queue.

pop()

template<class T>

T Slic3r::Channel< T >::pop ( )

inline

    {
        UniqueLock lock(m_mutex);
        m_condition.wait(lock, [this]() { return !m_queue.empty(); });
        auto item = std::move(m_queue.front());
        m_queue.pop_front();
        return item;
    }

References m_condition, m_mutex, and m_queue.

push() [1/2]

template<class T>

void Slic3r::Channel< T >::push ( const T & item, bool silent = false )

inline

    {
        {
            UniqueLock lock(m_mutex);
            m_queue.push_back(item);
        }
        if (! silent) { m_condition.notify_one(); }
    }

References m_condition, m_mutex, and m_queue.

push() [2/2]

template<class T>

void Slic3r::Channel< T >::push ( T && item, bool silent = false )

inline

    {
        {
            UniqueLock lock(m_mutex);
            m_queue.push_back(std::forward<T>(item));
        }
        if (! silent) { m_condition.notify_one(); }
    }

References m_condition, m_mutex, and m_queue.

size_hint()

template<class T>

size_t Slic3r::Channel< T >::size_hint ( ) const

inlinenoexcept

{ return m_queue.size(); }

References m_queue.

try_pop()

template<class T>

boost::optional< T > Slic3r::Channel< T >::try_pop ( )

inline

    {
        UniqueLock lock(m_mutex);
        if (m_queue.empty()) {
            return boost::none;
        } else {
            auto item = std::move(m_queue.front());
            m_queue.pop();
            return item;
        }
    }

References m_mutex, and m_queue.

Member Data Documentation

m_condition

template<class T>

std::condition_variable Slic3r::Channel< T >::m_condition

private

Referenced by pop(), push(), and push().

m_mutex

template<class T>

std::mutex Slic3r::Channel< T >::m_mutex

mutableprivate

Referenced by lock_read(), lock_rw(), pop(), push(), push(), and try_pop().

m_queue

template<class T>

Queue Slic3r::Channel< T >::m_queue

private

Referenced by lock_read(), lock_rw(), pop(), push(), push(), size_hint(), and try_pop().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/Channel.hpp