edm::LimitedTaskQueue Class Reference

#include <LimitedTaskQueue.h>

Classes
class	Resumer

Public Member Functions
unsigned int	concurrencyLimit () const
	LimitedTaskQueue (unsigned int iLimit)
	LimitedTaskQueue (const LimitedTaskQueue &)=delete
const LimitedTaskQueue &	operator= (const LimitedTaskQueue &)=delete
template<typename T >
void	push (oneapi::tbb::task_group &iGroup, T &&iAction)
	asynchronously pushes functor iAction into queue More...
template<typename T >
void	pushAndPause (oneapi::tbb::task_group &iGroup, T &&iAction)
	asynchronously pushes functor iAction into queue then pause the queue and run iAction More...

Private Attributes
std::vector< SerialTaskQueue >	m_queues

Detailed Description

Definition at line 39 of file LimitedTaskQueue.h.

Constructor & Destructor Documentation

LimitedTaskQueue() [1/2]

edm::LimitedTaskQueue::LimitedTaskQueue ( unsigned int  iLimit )

inline

Definition at line 41 of file LimitedTaskQueue.h.

: m_queues{iLimit} {}

LimitedTaskQueue() [2/2]

edm::LimitedTaskQueue::LimitedTaskQueue ( const LimitedTaskQueue &  )

delete

Member Function Documentation

concurrencyLimit()

unsigned int edm::LimitedTaskQueue::concurrencyLimit ( ) const

inline

Definition at line 107 of file LimitedTaskQueue.h.

References m_queues.

Referenced by edm::limited::OutputModuleBase::concurrencyLimit(), edm::limited::EDFilterBase::concurrencyLimit(), edm::limited::EDAnalyzerBase::concurrencyLimit(), and edm::limited::EDProducerBase::concurrencyLimit().

{ return m_queues.size(); }

operator=()

const LimitedTaskQueue& edm::LimitedTaskQueue::operator= ( const LimitedTaskQueue &  )

delete

push()

template<typename T >

void LimitedTaskQueue::push	(	oneapi::tbb::task_group &	iGroup,
		T &&	iAction
	)

asynchronously pushes functor iAction into queue

The function will return immediately and iAction will either process concurrently with the calling thread or wait until the protected resource becomes available or until a CPU becomes available.

Parameters

[in]

iAction

Must be a functor that takes no arguments and return no values.

Definition at line 115 of file LimitedTaskQueue.h.

References m_queues, and submitPVResolutionJobs::q.

Referenced by edm::Worker::TaskQueueAdaptor::push().

                                                                      {
    auto set_to_run = std::make_shared<std::atomic<bool>>(false);
    for (auto& q : m_queues) {
      q.push(iGroup, [set_to_run, iAction]() mutable {
        bool expected = false;
        if (set_to_run->compare_exchange_strong(expected, true)) {
          iAction();
        }
      });
    }
  }

pushAndPause()

template<typename T >

void LimitedTaskQueue::pushAndPause	(	oneapi::tbb::task_group &	iGroup,
		T &&	iAction
	)

asynchronously pushes functor iAction into queue then pause the queue and run iAction

iAction must take as argument a copy of a LimitedTaskQueue::Resumer. To resume the queue let the last copy of the Resumer go out of scope, or call Resumer::resume(). Using this function will decrease the allowed concurrency limit by 1.

Definition at line 128 of file LimitedTaskQueue.h.

References m_queues, and submitPVResolutionJobs::q.

Referenced by edm::eventsetup::EventSetupRecordIOVQueue::startNewIOVAsync().

                                                                              {
    auto set_to_run = std::make_shared<std::atomic<bool>>(false);
    for (auto& q : m_queues) {
      q.push(iGroup, [&q, set_to_run, iAction]() mutable {
        bool expected = false;
        if (set_to_run->compare_exchange_strong(expected, true)) {
          q.pause();
          iAction(Resumer(&q));
        }
      });
    }
  }

Member Data Documentation

m_queues

std::vector<SerialTaskQueue> edm::LimitedTaskQueue::m_queues

private

Definition at line 111 of file LimitedTaskQueue.h.

Referenced by concurrencyLimit(), push(), and pushAndPause().