TTerminalLoop< T > Class Template Reference

Detailed Description

template<typename T>
class TTerminalLoop< T >

Template for loops to terminate queues.

Definition at line 20 of file TTerminalLoop.h.

Public Member Functions
	TTerminalLoop (const TTerminalLoop &)=delete
	TTerminalLoop (TTerminalLoop &&) noexcept=delete
	~TTerminalLoop ()=default
void	ClearQueue () override
virtual std::string	EndStatus ()
size_t	GetItemsCurrent () override
size_t	GetItemsPopped () override
size_t	GetItemsPushed () override
size_t	GetRate () override
std::shared_ptr< ThreadsafeQueue< std::shared_ptr< T > > > &	InputQueue ()
bool	IsPaused ()
bool	IsRunning ()
void	Join ()
std::string	Name () const
virtual void	OnEnd ()
TTerminalLoop &	operator= (const TTerminalLoop &)=delete
TTerminalLoop &	operator= (TTerminalLoop &&) noexcept=delete
void	Pause ()
virtual std::string	Progress ()
void	Resume ()
virtual std::string	Status ()
void	Stop ()

Static Public Member Functions
static std::string	AllThreadHeader ()
static std::string	AllThreadProgress ()
static std::string	AllThreadStatus ()
static bool	AnyThreadRunning ()
static std::string	AnyThreadStatus ()
static void	ClearAllQueues ()
static size_t	ColumnWidth ()
static void	ColumnWidth (size_t val)
static StoppableThread *	Get (const std::string &name)
static TTerminalLoop *	Get (std::string name="")
static std::vector< StoppableThread * >	GetAll ()
static int	GetNThreads ()
static void	join_status_thread ()
static void	PauseAll ()
static void	Print ()
static void	ResumeAll ()
static void	SendStop ()
static void	start_status_thread ()
static void	status_out ()
static void	status_out_loop ()
static size_t	StatusWidth ()
static void	StatusWidth (size_t val)
static void	stop_status_thread ()
static void	StopAll ()

Protected Member Functions
void	IncrementItemsPopped ()
std::atomic_long &	InputSize ()
void	InputSize (int64_t val)
std::atomic_size_t &	ItemsPopped ()
void	ItemsPopped (size_t val)
bool	Iteration () override

Private Member Functions
	TTerminalLoop (std::string name)
void	Loop ()

Private Attributes
std::atomic_bool	fForceStop {false}
std::shared_ptr< ThreadsafeQueue< std::shared_ptr< T > > >	fInputQueue
std::atomic_long	fInputSize {0}
std::atomic_size_t	fItemsPopped {0}
std::string	fName
std::atomic_bool	fPaused {false}
std::condition_variable	fPausedWait
std::mutex	fPauseMutex
std::atomic_bool	fRunning {false}
std::thread	fThread

Static Private Attributes
static size_t	fColumnWidth = 20
static std::thread	fStatusThread
static bool	fStatusThreadOn = false
static size_t	fStatusWidth = 80
static std::map< std::string, StoppableThread * >	fThreadMap

Inheritance diagram for TTerminalLoop< T >:

Collaboration diagram for TTerminalLoop< T >:

Constructor & Destructor Documentation

TTerminalLoop() [1/3]

template<typename T >

TTerminalLoop< T >::TTerminalLoop ( const TTerminalLoop< T > & )

delete

Referenced by TTerminalLoop< T >::Get().

TTerminalLoop() [2/3]

template<typename T >

TTerminalLoop< T >::TTerminalLoop ( TTerminalLoop< T > && )

deletenoexcept

~TTerminalLoop()

template<typename T >

TTerminalLoop< T >::~TTerminalLoop ( )

default

TTerminalLoop() [3/3]

template<typename T >

TTerminalLoop< T >::TTerminalLoop ( std::string name )

inlineexplicitprivate

Definition at line 84 of file TTerminalLoop.h.

Member Function Documentation

AllThreadHeader()

std::string StoppableThread::AllThreadHeader ( )

staticinherited

Definition at line 73 of file StoppableThread.cxx.

References StoppableThread::fColumnWidth, StoppableThread::fStatusWidth, and StoppableThread::fThreadMap.

Referenced by TGRSIint::ApplyOptions().

AllThreadProgress()

std::string StoppableThread::AllThreadProgress ( )

staticinherited

Definition at line 59 of file StoppableThread.cxx.

References StoppableThread::fColumnWidth, StoppableThread::fStatusWidth, and StoppableThread::fThreadMap.

Referenced by TGRSIint::LoopUntilDone().

AllThreadStatus()

std::string StoppableThread::AllThreadStatus ( )

staticinherited

Definition at line 83 of file StoppableThread.cxx.

References StoppableThread::fColumnWidth, StoppableThread::fStatusWidth, and StoppableThread::fThreadMap.

Referenced by TGRSIint::LoopUntilDone().

AnyThreadRunning()

bool StoppableThread::AnyThreadRunning ( )

staticinherited

Definition at line 37 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by TChannel::GetChannel(), TGRSIint::LoopUntilDone(), and TGRSIInterruptHandler::Notify().

AnyThreadStatus()

std::string StoppableThread::AnyThreadStatus ( )

staticinherited

Definition at line 47 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

ClearAllQueues()

void StoppableThread::ClearAllQueues ( )

staticinherited

Definition at line 166 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by TGRSIInterruptHandler::Notify().

ClearQueue()

template<typename T >

void TTerminalLoop< T >::ClearQueue ( )

inlineoverridevirtual

Reimplemented from StoppableThread.

Definition at line 48 of file TTerminalLoop.h.

References TTerminalLoop< T >::fInputQueue.

ColumnWidth() [1/2]

static size_t StoppableThread::ColumnWidth ( )

inlinestaticinherited

Definition at line 82 of file StoppableThread.h.

References StoppableThread::fColumnWidth.

Referenced by TGRSIint::SetupPipeline().

ColumnWidth() [2/2]

static void StoppableThread::ColumnWidth ( size_t val )

inlinestaticinherited

Definition at line 80 of file StoppableThread.h.

References StoppableThread::fColumnWidth.

EndStatus()

virtual std::string StoppableThread::EndStatus ( )

inlinevirtualinherited

Reimplemented in TAnalysisWriteLoop, TEventBuildingLoop, TFragWriteLoop, and TUnpackingLoop.

Definition at line 62 of file StoppableThread.h.

Referenced by StoppableThread::Join(), and StoppableThread::Stop().

Get() [1/2]

StoppableThread * StoppableThread::Get ( const std::string & name )

staticinherited

Definition at line 173 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by TAnalysisHistLoop::Get(), TAnalysisWriteLoop::Get(), TDataLoop::Get(), TDetBuildingLoop::Get(), TEventBuildingLoop::Get(), TFragHistLoop::Get(), TFragmentChainLoop::Get(), TFragWriteLoop::Get(), TTerminalLoop< T >::Get(), and TUnpackingLoop::Get().

Get() [2/2]

template<typename T >

static TTerminalLoop * TTerminalLoop< T >::Get ( std::string name = "" )

inlinestatic

Definition at line 22 of file TTerminalLoop.h.

References TTerminalLoop< T >::TTerminalLoop(), and StoppableThread::Get().

GetAll()

std::vector< StoppableThread * > StoppableThread::GetAll ( )

staticinherited

Definition at line 315 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

GetItemsCurrent()

template<typename T >

size_t TTerminalLoop< T >::GetItemsCurrent ( )

inlineoverridevirtual

Implements StoppableThread.

Definition at line 62 of file TTerminalLoop.h.

GetItemsPopped()

template<typename T >

size_t TTerminalLoop< T >::GetItemsPopped ( )

inlineoverridevirtual

Implements StoppableThread.

Definition at line 57 of file TTerminalLoop.h.

GetItemsPushed()

template<typename T >

size_t TTerminalLoop< T >::GetItemsPushed ( )

inlineoverridevirtual

Implements StoppableThread.

Definition at line 61 of file TTerminalLoop.h.

GetNThreads()

int StoppableThread::GetNThreads ( )

staticinherited

Definition at line 21 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by StoppableThread::Print().

GetRate()

template<typename T >

size_t TTerminalLoop< T >::GetRate ( )

inlineoverridevirtual

Implements StoppableThread.

Definition at line 63 of file TTerminalLoop.h.

IncrementItemsPopped()

void StoppableThread::IncrementItemsPopped ( )

inlineprotectedinherited

Definition at line 97 of file StoppableThread.h.

References StoppableThread::fItemsPopped.

Referenced by TAnalysisHistLoop::Iteration(), TAnalysisWriteLoop::Iteration(), TDetBuildingLoop::Iteration(), TEventBuildingLoop::Iteration(), TFragHistLoop::Iteration(), TFragmentChainLoop::Iteration(), TFragWriteLoop::Iteration(), and TUnpackingLoop::Iteration().

InputQueue()

template<typename T >

std::shared_ptr< ThreadsafeQueue< std::shared_ptr< T > > > & TTerminalLoop< T >::InputQueue ( )

inline

Definition at line 43 of file TTerminalLoop.h.

References TTerminalLoop< T >::fInputQueue.

InputSize() [1/2]

std::atomic_long & StoppableThread::InputSize ( )

inlineprotectedinherited

Definition at line 96 of file StoppableThread.h.

References StoppableThread::fInputSize.

Referenced by TAnalysisWriteLoop::EndStatus(), TFragWriteLoop::EndStatus(), TAnalysisHistLoop::Iteration(), TAnalysisWriteLoop::Iteration(), TDataLoop::Iteration(), TDetBuildingLoop::Iteration(), TEventBuildingLoop::Iteration(), TFragHistLoop::Iteration(), TFragmentChainLoop::Iteration(), TFragWriteLoop::Iteration(), and TUnpackingLoop::Iteration().

InputSize() [2/2]

void StoppableThread::InputSize ( int64_t val )

inlineprotectedinherited

Definition at line 94 of file StoppableThread.h.

References StoppableThread::fInputSize.

IsPaused()

bool StoppableThread::IsPaused ( )

inherited

Definition at line 224 of file StoppableThread.cxx.

References StoppableThread::fPaused.

IsRunning()

bool StoppableThread::IsRunning ( )

inherited

Definition at line 219 of file StoppableThread.cxx.

References StoppableThread::fRunning.

Referenced by StoppableThread::status_out().

ItemsPopped() [1/2]

std::atomic_size_t & StoppableThread::ItemsPopped ( )

inlineprotectedinherited

Definition at line 95 of file StoppableThread.h.

References StoppableThread::fItemsPopped.

Referenced by TAnalysisWriteLoop::EndStatus(), TEventBuildingLoop::EndStatus(), TFragWriteLoop::EndStatus(), TFragmentChainLoop::GetItemsPopped(), TFragWriteLoop::GetItemsPopped(), TAnalysisWriteLoop::GetItemsPushed(), TFragmentChainLoop::GetItemsPushed(), TFragWriteLoop::GetItemsPushed(), TDataLoop::Iteration(), TFragmentChainLoop::Iteration(), TUnpackingLoop::Iteration(), and TFragmentChainLoop::Restart().

ItemsPopped() [2/2]

void StoppableThread::ItemsPopped ( size_t val )

inlineprotectedinherited

Definition at line 93 of file StoppableThread.h.

References StoppableThread::fItemsPopped.

Iteration()

template<typename T >

bool TTerminalLoop< T >::Iteration ( )

inlineoverrideprotectedvirtual

Implements StoppableThread.

Definition at line 67 of file TTerminalLoop.h.

References TTerminalLoop< T >::fInputQueue.

Join()

void StoppableThread::Join ( )

inherited

Definition at line 229 of file StoppableThread.cxx.

References StoppableThread::EndStatus(), and StoppableThread::fThread.

Referenced by StoppableThread::StopAll().

join_status_thread()

void StoppableThread::join_status_thread ( )

staticinherited

Definition at line 280 of file StoppableThread.cxx.

References StoppableThread::fStatusThread, and StoppableThread::stop_status_thread().

Loop()

void StoppableThread::Loop ( )

privateinherited

Definition at line 237 of file StoppableThread.cxx.

References StoppableThread::fPaused, StoppableThread::fPausedWait, StoppableThread::fPauseMutex, StoppableThread::fRunning, StoppableThread::Iteration(), and StoppableThread::OnEnd().

Referenced by StoppableThread::StoppableThread().

Name()

std::string StoppableThread::Name ( ) const

inlineinherited

Definition at line 63 of file StoppableThread.h.

References StoppableThread::fName.

Referenced by TAnalysisWriteLoop::AddBranch(), TAnalysisWriteLoop::EndStatus(), TFragWriteLoop::EndStatus(), TUnpackingLoop::EndStatus(), and StoppableThread::status_out().

OnEnd()

virtual void StoppableThread::OnEnd ( )

inlinevirtualinherited

Reimplemented in TAnalysisWriteLoop, TDataLoop, and TFragmentChainLoop.

Definition at line 59 of file StoppableThread.h.

Referenced by StoppableThread::Loop().

operator=() [1/2]

template<typename T >

TTerminalLoop & TTerminalLoop< T >::operator= ( const TTerminalLoop< T > & )

delete

operator=() [2/2]

template<typename T >

TTerminalLoop & TTerminalLoop< T >::operator= ( TTerminalLoop< T > && )

deletenoexcept

Pause()

void StoppableThread::Pause ( )

inherited

Definition at line 202 of file StoppableThread.cxx.

References StoppableThread::fPaused, and StoppableThread::fRunning.

PauseAll()

void StoppableThread::PauseAll ( )

staticinherited

Definition at line 97 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Print()

void StoppableThread::Print ( )

staticinherited

Definition at line 254 of file StoppableThread.cxx.

References StoppableThread::fColumnWidth, StoppableThread::fStatusWidth, StoppableThread::fThreadMap, StoppableThread::GetNThreads(), and hex().

Progress()

std::string StoppableThread::Progress ( )

virtualinherited

Definition at line 119 of file StoppableThread.cxx.

References StoppableThread::fColumnWidth, StoppableThread::fInputSize, and StoppableThread::fItemsPopped.

Resume()

void StoppableThread::Resume ( )

inherited

Definition at line 193 of file StoppableThread.cxx.

References StoppableThread::fPaused, StoppableThread::fPausedWait, StoppableThread::fPauseMutex, and StoppableThread::fRunning.

ResumeAll()

void StoppableThread::ResumeAll ( )

staticinherited

Definition at line 104 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by TGRSIint::SetupPipeline().

SendStop()

void StoppableThread::SendStop ( )

staticinherited

Definition at line 135 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by StoppableThread::StopAll(), and TGRSIint::Terminate().

start_status_thread()

void StoppableThread::start_status_thread ( )

staticinherited

Definition at line 265 of file StoppableThread.cxx.

References StoppableThread::fStatusThread, StoppableThread::fStatusThreadOn, and StoppableThread::status_out_loop().

Referenced by StoppableThread::StoppableThread().

Status()

std::string StoppableThread::Status ( )

virtualinherited

Definition at line 111 of file StoppableThread.cxx.

References StoppableThread::fColumnWidth, StoppableThread::fInputSize, and StoppableThread::fItemsPopped.

status_out()

void StoppableThread::status_out ( )

staticinherited

Definition at line 297 of file StoppableThread.cxx.

References StoppableThread::fThreadMap, StoppableThread::GetItemsCurrent(), StoppableThread::GetItemsPopped(), StoppableThread::GetItemsPushed(), StoppableThread::GetRate(), StoppableThread::IsRunning(), and StoppableThread::Name().

Referenced by StoppableThread::status_out_loop(), and StoppableThread::StopAll().

status_out_loop()

void StoppableThread::status_out_loop ( )

staticinherited

Definition at line 286 of file StoppableThread.cxx.

References StoppableThread::fStatusThreadOn, and StoppableThread::status_out().

Referenced by StoppableThread::start_status_thread().

StatusWidth() [1/2]

static size_t StoppableThread::StatusWidth ( )

inlinestaticinherited

Definition at line 83 of file StoppableThread.h.

References StoppableThread::fStatusWidth.

Referenced by TGRSIint::SetupPipeline().

StatusWidth() [2/2]

static void StoppableThread::StatusWidth ( size_t val )

inlinestaticinherited

Definition at line 81 of file StoppableThread.h.

References StoppableThread::fStatusWidth.

Stop()

void StoppableThread::Stop ( )

inherited

Definition at line 209 of file StoppableThread.cxx.

References StoppableThread::EndStatus(), StoppableThread::fPaused, StoppableThread::fPausedWait, StoppableThread::fPauseMutex, and StoppableThread::fRunning.

stop_status_thread()

void StoppableThread::stop_status_thread ( )

staticinherited

Definition at line 273 of file StoppableThread.cxx.

References StoppableThread::fStatusThreadOn.

Referenced by StoppableThread::join_status_thread().

StopAll()

void StoppableThread::StopAll ( )

staticinherited

Definition at line 147 of file StoppableThread.cxx.

References StoppableThread::fThreadMap, StoppableThread::Join(), StoppableThread::SendStop(), and StoppableThread::status_out().

Referenced by TGRSIint::Terminate().

Member Data Documentation

fColumnWidth

size_t StoppableThread::fColumnWidth = 20

staticprivateinherited

Definition at line 108 of file StoppableThread.h.

Referenced by StoppableThread::AllThreadHeader(), StoppableThread::AllThreadProgress(), StoppableThread::AllThreadStatus(), StoppableThread::ColumnWidth(), StoppableThread::ColumnWidth(), StoppableThread::Print(), StoppableThread::Progress(), and StoppableThread::Status().

fForceStop

std::atomic_bool StoppableThread::fForceStop {false}

privateinherited

Definition at line 120 of file StoppableThread.h.

fInputQueue

template<typename T >

std::shared_ptr<ThreadsafeQueue<std::shared_ptr<T> > > TTerminalLoop< T >::fInputQueue

private

Definition at line 90 of file TTerminalLoop.h.

Referenced by TTerminalLoop< T >::ClearQueue(), TTerminalLoop< T >::InputQueue(), and TTerminalLoop< T >::Iteration().

fInputSize

std::atomic_long StoppableThread::fInputSize {0}

privateinherited

number of items in the input (queue), only updated within Iteration(), so not always fully up-to-date (signed to hold error from queue::pop)

Definition at line 102 of file StoppableThread.h.

Referenced by StoppableThread::InputSize(), StoppableThread::InputSize(), StoppableThread::Progress(), and StoppableThread::Status().

fItemsPopped

std::atomic_size_t StoppableThread::fItemsPopped {0}

privateinherited

number of items popped from input queue

Definition at line 101 of file StoppableThread.h.

Referenced by StoppableThread::IncrementItemsPopped(), StoppableThread::ItemsPopped(), StoppableThread::ItemsPopped(), StoppableThread::Progress(), and StoppableThread::Status().

fName

std::string StoppableThread::fName

privateinherited

Definition at line 106 of file StoppableThread.h.

Referenced by StoppableThread::StoppableThread(), StoppableThread::~StoppableThread(), and StoppableThread::Name().

fPaused

std::atomic_bool StoppableThread::fPaused {false}

privateinherited

Definition at line 121 of file StoppableThread.h.

Referenced by StoppableThread::IsPaused(), StoppableThread::Loop(), StoppableThread::Pause(), StoppableThread::Resume(), and StoppableThread::Stop().

fPausedWait

std::condition_variable StoppableThread::fPausedWait

privateinherited

Definition at line 122 of file StoppableThread.h.

Referenced by StoppableThread::Loop(), StoppableThread::Resume(), and StoppableThread::Stop().

fPauseMutex

std::mutex StoppableThread::fPauseMutex

privateinherited

Definition at line 123 of file StoppableThread.h.

Referenced by StoppableThread::Loop(), StoppableThread::Resume(), and StoppableThread::Stop().

fRunning

std::atomic_bool StoppableThread::fRunning {false}

privateinherited

Definition at line 119 of file StoppableThread.h.

Referenced by StoppableThread::IsRunning(), StoppableThread::Loop(), StoppableThread::Pause(), StoppableThread::Resume(), and StoppableThread::Stop().

fStatusThread

std::thread StoppableThread::fStatusThread

staticprivateinherited

Definition at line 117 of file StoppableThread.h.

Referenced by StoppableThread::~StoppableThread(), StoppableThread::join_status_thread(), and StoppableThread::start_status_thread().

fStatusThreadOn

bool StoppableThread::fStatusThreadOn = false

staticprivateinherited

Definition at line 115 of file StoppableThread.h.

Referenced by StoppableThread::StoppableThread(), StoppableThread::~StoppableThread(), StoppableThread::start_status_thread(), StoppableThread::status_out_loop(), and StoppableThread::stop_status_thread().

fStatusWidth

size_t StoppableThread::fStatusWidth = 80

staticprivateinherited

Definition at line 109 of file StoppableThread.h.

Referenced by StoppableThread::AllThreadHeader(), StoppableThread::AllThreadProgress(), StoppableThread::AllThreadStatus(), StoppableThread::Print(), StoppableThread::StatusWidth(), and StoppableThread::StatusWidth().

fThread

std::thread StoppableThread::fThread

privateinherited

Definition at line 118 of file StoppableThread.h.

Referenced by StoppableThread::StoppableThread(), and StoppableThread::Join().

fThreadMap

std::map< std::string, StoppableThread * > StoppableThread::fThreadMap

staticprivateinherited

Definition at line 113 of file StoppableThread.h.

Referenced by StoppableThread::StoppableThread(), StoppableThread::~StoppableThread(), StoppableThread::AllThreadHeader(), StoppableThread::AllThreadProgress(), StoppableThread::AllThreadStatus(), StoppableThread::AnyThreadRunning(), StoppableThread::AnyThreadStatus(), StoppableThread::ClearAllQueues(), StoppableThread::Get(), StoppableThread::GetAll(), StoppableThread::GetNThreads(), StoppableThread::PauseAll(), StoppableThread::Print(), StoppableThread::ResumeAll(), StoppableThread::SendStop(), StoppableThread::status_out(), and StoppableThread::StopAll().