edm::WaitingTask Class Reference

#include <WaitingTask.h>

Inheritance diagram for edm::WaitingTask:

Public Member Functions
std::exception_ptr	exceptionPtr () const
	Returns exception thrown by dependent task. More...
	WaitingTask ()
	Constructor. More...
	~WaitingTask () override
Public Member Functions inherited from edm::TaskBase
unsigned int	decrement_ref_count ()
virtual void	execute ()=0
void	increment_ref_count ()
	TaskBase ()
	Constructor. More...
virtual	~TaskBase ()=default

Protected Member Functions
std::exception_ptr const &	uncheckedExceptionPtr () const

Private Types
enum	State : unsigned char { State::kUnset = 0, State::kSetting = 1, State::kSet = 2 }

Private Member Functions
void	dependentTaskFailed (std::exception_ptr iPtr)
	Called if waited for task failed. More...

Private Attributes
std::exception_ptr	m_ptr
std::atomic< unsigned char >	m_ptrSet = static_cast<unsigned char>(State::kUnset)

Friends
class	WaitingTaskHolder
class	WaitingTaskList
class	WaitingTaskWithArenaHolder

Detailed Description

Definition at line 36 of file WaitingTask.h.

Member Enumeration Documentation

State

enum edm::WaitingTask::State : unsigned char

strongprivate

Enumerator
kUnset
kSetting
kSet

Definition at line 62 of file WaitingTask.h.

: unsigned char { kUnset = 0, kSetting = 1, kSet = 2 };

Constructor & Destructor Documentation

WaitingTask()

edm::WaitingTask::WaitingTask ( )

inline

Constructor.

Definition at line 43 of file WaitingTask.h.

: m_ptr{} {}

~WaitingTask()

edm::WaitingTask::~WaitingTask ( )

inlineoverride

Definition at line 44 of file WaitingTask.h.

{};

Member Function Documentation

dependentTaskFailed()

void edm::WaitingTask::dependentTaskFailed ( std::exception_ptr  iPtr )

inlineprivate

Called if waited for task failed.

Allows transfer of the exception caused by the dependent task to be moved to another thread. This method should only be called by WaitingTaskList

Definition at line 68 of file WaitingTask.h.

References kSet, kSetting, kUnset, m_ptr, and m_ptrSet.

Referenced by edm::WaitingTaskList::add(), edm::WaitingTaskWithArenaHolder::doneWaiting(), edm::WaitingTaskHolder::doneWaiting(), edm::WaitingTaskHolder::presetTaskAsFailed(), and edm::WaitingTaskList::presetTaskAsFailed().

                                                    {
      unsigned char isSet = static_cast<unsigned char>(State::kUnset);
      if (iPtr and m_ptrSet.compare_exchange_strong(isSet, static_cast<unsigned char>(State::kSetting))) {
        m_ptr = iPtr;
        m_ptrSet = static_cast<unsigned char>(State::kSet);
      }
    }

exceptionPtr()

std::exception_ptr edm::WaitingTask::exceptionPtr ( ) const

inline

Returns exception thrown by dependent task.

If the value evalutes to true then the dependent task failed.

Definition at line 51 of file WaitingTask.h.

References kSet, m_ptr, and m_ptrSet.

Referenced by edm::Worker::RunModuleTask< T >::execute(), edm::Worker::AcquireTask< OccurrenceTraits< EventPrincipal, BranchActionStreamBegin >, DUMMY >::execute(), edm::WaitingTaskHolder::taskHasFailed(), edm::WaitingTaskWithArenaHolder::taskHasFailed(), edm::FinalWaitingTask::wait(), and edm::FinalWaitingTask::waitNoThrow().

                                          {
      if (m_ptrSet == static_cast<unsigned char>(State::kSet)) {
        return m_ptr;
      }
      return std::exception_ptr{};
    }

uncheckedExceptionPtr()

std::exception_ptr const& edm::WaitingTask::uncheckedExceptionPtr ( ) const

inlineprotected

Definition at line 59 of file WaitingTask.h.

References m_ptr.

{ return m_ptr; }

Friends And Related Function Documentation

WaitingTaskHolder

friend class WaitingTaskHolder

friend

Definition at line 39 of file WaitingTask.h.

WaitingTaskList

friend class WaitingTaskList

friend

Definition at line 38 of file WaitingTask.h.

WaitingTaskWithArenaHolder

friend class WaitingTaskWithArenaHolder

friend

Definition at line 40 of file WaitingTask.h.

Member Data Documentation

m_ptr

std::exception_ptr edm::WaitingTask::m_ptr

private

Definition at line 76 of file WaitingTask.h.

Referenced by dependentTaskFailed(), exceptionPtr(), and uncheckedExceptionPtr().

m_ptrSet

std::atomic<unsigned char> edm::WaitingTask::m_ptrSet = static_cast<unsigned char>(State::kUnset)

private

Definition at line 77 of file WaitingTask.h.

Referenced by dependentTaskFailed(), and exceptionPtr().