#include <FollyQueue.hpp>

Inheritance diagram for dunedaq::iomanager::FollyQueue< T, FollyQueueType >:

Collaboration diagram for dunedaq::iomanager::FollyQueue< T, FollyQueueType >:

Public Types
using	value_t = T

using	duration_t = typename Queue<T>::duration_t

Public Types inherited from dunedaq::iomanager::Queue< T >
using	value_t = T
	Type stored in the Queue.

using	duration_t = std::chrono::milliseconds
	Base duration type for timeouts.

Public Types inherited from dunedaq::opmonlib::MonitorableObject
using	NodePtr = std::weak_ptr<MonitorableObject>

using	NewNodePtr = std::shared_ptr<MonitorableObject>

using	ElementId = std::string

Public Member Functions
	FollyQueue (const std::string &name, size_t capacity)

size_t	get_capacity () const noexcept override
	Get the capacity (max size) of the queue.

size_t	get_num_elements () const noexcept override

bool	can_pop () const noexcept override
	Determine whether the Queue may be popped from.

void	pop (value_t &val, const duration_t &dur) override
	Pop the first value off of the queue.

bool	try_pop (value_t &val, const duration_t &dur) override

bool	can_push () const noexcept override
	Determine whether the Queue may be pushed onto.

void	push (value_t &&t, const duration_t &dur) override
	Push a value onto the Queue.

bool	try_push (value_t &&t, const duration_t &dur) override

	FollyQueue (const FollyQueue &)=delete

FollyQueue &	operator= (const FollyQueue &)=delete

	FollyQueue (FollyQueue &&)=delete

FollyQueue &	operator= (FollyQueue &&)=delete

Public Member Functions inherited from dunedaq::iomanager::Queue< T >
	Queue (const std::string &name)
	Queue Constructor.

Public Member Functions inherited from dunedaq::iomanager::QueueBase
	QueueBase (const std::string &name)
	QueueBase Constructor.

Public Member Functions inherited from dunedaq::utilities::NamedObject
	NamedObject (const std::string &name)
	NamedObject Constructor.

	NamedObject (NamedObject const &)=delete
	NamedObject is not copy-constructible.

	NamedObject (NamedObject &&)=default
	NamedObject is move-constructible.

NamedObject &	operator= (NamedObject const &)=delete
	NamedObject is not copy-assignable.

NamedObject &	operator= (NamedObject &&)=default
	NamedObject is move-assignable.

virtual	~NamedObject ()=default
	Default virtual destructor.

const std::string &	get_name () const final
	Get the name of this NamedObejct.

Public Member Functions inherited from dunedaq::utilities::Named
	Named ()=default
	Named Constructor.

	Named (Named const &)=delete
	Named is not copy-constructible.

	Named (Named &&)=default
	Named is move-constructible.

Named &	operator= (Named const &)=delete
	Named is not copy-assignable.

Named &	operator= (Named &&)=default
	Named is move-assignable.

virtual	~Named ()=default
	Default virtual destructor.

Public Member Functions inherited from dunedaq::opmonlib::MonitorableObject
	MonitorableObject (const MonitorableObject &)=delete

MonitorableObject &	operator= (const MonitorableObject &)=delete

	MonitorableObject (MonitorableObject &&)=delete

MonitorableObject &	operator= (MonitorableObject &&)=delete

virtual	~MonitorableObject ()=default

auto	get_opmon_id () const noexcept

auto	get_opmon_level () const noexcept

Private Attributes
FollyQueueType< T, true >	m_queue

size_t	m_capacity

Additional Inherited Members
Static Public Member Functions inherited from dunedaq::opmonlib::MonitorableObject
static bool	publishable_metric (OpMonLevel entry, OpMonLevel system) noexcept

Protected Member Functions inherited from dunedaq::iomanager::QueueBase
void	generate_opmon_data () override
	Method to retrieve information (occupancy) from queues.

Protected Member Functions inherited from dunedaq::opmonlib::MonitorableObject
	MonitorableObject ()=default

void	register_node (ElementId name, NewNodePtr)

void	publish (google::protobuf::Message &&, CustomOrigin &&co={}, OpMonLevel l=to_level(EntryOpMonLevel::kDefault)) const noexcept

Detailed Description

template<class T, template< typename, bool > class FollyQueueType>
class dunedaq::iomanager::FollyQueue< T, FollyQueueType >

Definition at line 29 of file FollyQueue.hpp.

Member Typedef Documentation

◆ duration_t

template<class T , template< typename, bool > class FollyQueueType>

using dunedaq::iomanager::FollyQueue< T, FollyQueueType >::duration_t = typename Queue<T>::duration_t

Definition at line 33 of file FollyQueue.hpp.

◆ value_t

template<class T , template< typename, bool > class FollyQueueType>

using dunedaq::iomanager::FollyQueue< T, FollyQueueType >::value_t = T

Definition at line 32 of file FollyQueue.hpp.

Constructor & Destructor Documentation

◆ FollyQueue() [1/3]

template<class T , template< typename, bool > class FollyQueueType>

dunedaq::iomanager::FollyQueue< T, FollyQueueType >::FollyQueue	(	const std::string &	name,
		size_t	capacity )

inlineexplicit

Definition at line 35 of file FollyQueue.hpp.

    : Queue<T>(name)
    , m_queue(capacity)
    , m_capacity(capacity)
  {}

◆ FollyQueue() [2/3]

template<class T , template< typename, bool > class FollyQueueType>

dunedaq::iomanager::FollyQueue< T, FollyQueueType >::FollyQueue ( const FollyQueue< T, FollyQueueType > & )

delete

◆ FollyQueue() [3/3]

template<class T , template< typename, bool > class FollyQueueType>

dunedaq::iomanager::FollyQueue< T, FollyQueueType >::FollyQueue ( FollyQueue< T, FollyQueueType > && )

delete

Member Function Documentation

◆ can_pop()

template<class T , template< typename, bool > class FollyQueueType>

bool dunedaq::iomanager::FollyQueue< T, FollyQueueType >::can_pop ( ) const

inlineoverridevirtualnoexcept

Determine whether the Queue may be popped from.

Returns: True if the queue is not empty, false if it is

Reimplemented from dunedaq::iomanager::Queue< T >.

Definition at line 45 of file FollyQueue.hpp.

45{ return !m_queue.empty(); }

◆ can_push()

template<class T , template< typename, bool > class FollyQueueType>

bool dunedaq::iomanager::FollyQueue< T, FollyQueueType >::can_push ( ) const

inlineoverridevirtualnoexcept

Determine whether the Queue may be pushed onto.

Returns: True if the queue is not full, false if it is

Reimplemented from dunedaq::iomanager::Queue< T >.

Definition at line 62 of file FollyQueue.hpp.

62{ return m_queue.size() < this->get_capacity(); }

dunedaq::iomanager::FollyQueue::get_capacity

size_t get_capacity() const noexcept override

Get the capacity (max size) of the queue.

Definition FollyQueue.hpp:41

◆ get_capacity()

template<class T , template< typename, bool > class FollyQueueType>

size_t dunedaq::iomanager::FollyQueue< T, FollyQueueType >::get_capacity ( ) const

inlineoverridevirtualnoexcept

Get the capacity (max size) of the queue.

Returns: size_t capacity

Implements dunedaq::iomanager::QueueBase.

Definition at line 41 of file FollyQueue.hpp.

41{ return m_capacity; }

◆ get_num_elements()

template<class T , template< typename, bool > class FollyQueueType>

size_t dunedaq::iomanager::FollyQueue< T, FollyQueueType >::get_num_elements ( ) const

inlineoverridevirtualnoexcept

Implements dunedaq::iomanager::QueueBase.

Definition at line 43 of file FollyQueue.hpp.

43{ return m_queue.size(); }

◆ operator=() [1/2]

template<class T , template< typename, bool > class FollyQueueType>

FollyQueue & dunedaq::iomanager::FollyQueue< T, FollyQueueType >::operator= ( const FollyQueue< T, FollyQueueType > & )

delete

◆ operator=() [2/2]

template<class T , template< typename, bool > class FollyQueueType>

FollyQueue & dunedaq::iomanager::FollyQueue< T, FollyQueueType >::operator= ( FollyQueue< T, FollyQueueType > && )

delete

◆ pop()

template<class T , template< typename, bool > class FollyQueueType>

void dunedaq::iomanager::FollyQueue< T, FollyQueueType >::pop	(	value_t &	val,
		const duration_t &	timeout )

inlineoverridevirtual

Pop the first value off of the queue.

Parameters

val	Reference to the value that is popped from the queue
timeout	Timeout for the pop operation

This is a pure virtual function If pop takes longer than the timeout, implementations should throw an exception

Implements dunedaq::iomanager::Queue< T >.

Definition at line 47 of file FollyQueue.hpp.

  {
    if (!m_queue.try_dequeue_for(val, dur)) {
      throw QueueTimeoutExpired(
        ERS_HERE, this->get_name(), "pop", std::chrono::duration_cast<std::chrono::milliseconds>(dur).count());
    }
  }

◆ push()

template<class T , template< typename, bool > class FollyQueueType>

void dunedaq::iomanager::FollyQueue< T, FollyQueueType >::push	(	value_t &&	val,
		const duration_t &	timeout )

inlineoverridevirtual

Push a value onto the Queue.

Parameters

val	Value to push (rvalue)
timeout	Timeout for the push operation.

This is a pure virtual function. If push takes longer than the timeout, implementations should throw an exception.

Implements dunedaq::iomanager::Queue< T >.

Definition at line 64 of file FollyQueue.hpp.

  {
    if (!m_queue.try_enqueue_for(std::move(t), dur)) {
      throw QueueTimeoutExpired(
        ERS_HERE, this->get_name(), "push", std::chrono::duration_cast<std::chrono::milliseconds>(dur).count());
    }
  }

◆ try_pop()

template<class T , template< typename, bool > class FollyQueueType>

bool dunedaq::iomanager::FollyQueue< T, FollyQueueType >::try_pop	(	value_t &	val,
		const duration_t &	dur )

inlineoverridevirtual

Implements dunedaq::iomanager::Queue< T >.

Definition at line 54 of file FollyQueue.hpp.

  {
    if (!m_queue.try_dequeue_for(val, dur)) {
      return false;
    }
    return true;
  }

◆ try_push()

template<class T , template< typename, bool > class FollyQueueType>

bool dunedaq::iomanager::FollyQueue< T, FollyQueueType >::try_push	(	value_t &&	t,
		const duration_t &	dur )

inlineoverridevirtual

Implements dunedaq::iomanager::Queue< T >.

Definition at line 71 of file FollyQueue.hpp.

  {
    if (!m_queue.try_enqueue_for(std::move(t), dur)) {
      ers::error(QueueTimeoutExpired(
        ERS_HERE, this->get_name(), "push", std::chrono::duration_cast<std::chrono::milliseconds>(dur).count()));
      return false;
    }
    return true;
  }

Member Data Documentation

◆ m_capacity

template<class T , template< typename, bool > class FollyQueueType>

size_t dunedaq::iomanager::FollyQueue< T, FollyQueueType >::m_capacity

private

Definition at line 92 of file FollyQueue.hpp.

◆ m_queue

template<class T , template< typename, bool > class FollyQueueType>

FollyQueueType<T, true> dunedaq::iomanager::FollyQueue< T, FollyQueueType >::m_queue

private

Definition at line 91 of file FollyQueue.hpp.

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

/github/workspace/dunedaq/sourcecode/iomanager/include/iomanager/queue/FollyQueue.hpp

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ duration_t

◆ value_t

Constructor & Destructor Documentation

◆ FollyQueue() [1/3]

◆ FollyQueue() [2/3]

◆ FollyQueue() [3/3]

Member Function Documentation

◆ can_pop()

◆ can_push()

◆ get_capacity()

◆ get_num_elements()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ pop()

◆ push()

◆ try_pop()

◆ try_push()

Member Data Documentation

◆ m_capacity

◆ m_queue