template<typename T>
class TTerminalLoop< T >

Template for loops to terminate queues.

Definition at line 20 of file TTerminalLoop.h.

Public Member Functions
	~TTerminalLoop () override=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 ()

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 void	ColumnWidth (size_t val)

static size_t	ColumnWidth ()

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

static StoppableThread *	Get (const 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 void	StatusWidth (size_t val)

static size_t	StatusWidth ()

static void	stop_status_thread ()

static void	StopAll ()

Static Public Attributes
static std::thread	fStatusThread

static bool	fStatusThreadOn = false

Protected Member Functions
bool	Iteration () override

Protected Attributes
std::atomic_long	fInputSize {0}

std::atomic_size_t	fItemsPopped {0}

std::string	fName

Static Protected Attributes
static std::map< std::string, StoppableThread * >	fThreadMap

Private Member Functions
	TTerminalLoop (std::string name)

Private Attributes
std::shared_ptr< ThreadsafeQueue< std::shared_ptr< T > > >	fInputQueue

#include <TTerminalLoop.h>

Inheritance diagram for TTerminalLoop< T >:

Collaboration diagram for TTerminalLoop< T >:

Constructor & Destructor Documentation

◆ ~TTerminalLoop()

template<typename T >

TTerminalLoop< T >::~TTerminalLoop ( )

overridedefault

◆ TTerminalLoop()

template<typename T >

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

inlineprivate

Definition at line 74 of file TTerminalLoop.h.

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

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 41 of file TTerminalLoop.h.

References TTerminalLoop< T >::fInputQueue.

◆ ColumnWidth() [1/2]

static void StoppableThread::ColumnWidth ( size_t val )

inlinestaticinherited

Definition at line 75 of file StoppableThread.h.

References StoppableThread::fColumnWidth.

◆ ColumnWidth() [2/2]

static size_t StoppableThread::ColumnWidth ( )

inlinestaticinherited

Definition at line 77 of file StoppableThread.h.

References StoppableThread::fColumnWidth.

Referenced by TGRSIint::SetupPipeline().

◆ EndStatus()

virtual std::string StoppableThread::EndStatus ( )

inlinevirtualinherited

Reimplemented in TUnpackingLoop, TEventBuildingLoop, TFragWriteLoop, and TAnalysisWriteLoop.

Definition at line 57 of file StoppableThread.h.

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

◆ Get() [1/2]

template<typename T >

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

inlinestatic

Definition at line 22 of file TTerminalLoop.h.

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

◆ Get() [2/2]

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

staticinherited

Definition at line 173 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by ClassImp(), TTerminalLoop< T >::Get(), TFragHistLoop::Get(), TAnalysisHistLoop::Get(), TAnalysisWriteLoop::Get(), TFragWriteLoop::Get(), TUnpackingLoop::Get(), TFragmentChainLoop::Get(), and TDataLoop::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 52 of file TTerminalLoop.h.

◆ GetItemsPopped()

template<typename T >

size_t TTerminalLoop< T >::GetItemsPopped ( )

inlineoverridevirtual

Implements StoppableThread.

Definition at line 50 of file TTerminalLoop.h.

◆ GetItemsPushed()

template<typename T >

size_t TTerminalLoop< T >::GetItemsPushed ( )

inlineoverridevirtual

Implements StoppableThread.

Definition at line 51 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 53 of file TTerminalLoop.h.

◆ InputQueue()

template<typename T >

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

inline

Definition at line 39 of file TTerminalLoop.h.

References TTerminalLoop< T >::fInputQueue.

◆ 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().

◆ Iteration()

template<typename T >

bool TTerminalLoop< T >::Iteration ( )

inlineoverrideprotectedvirtual

Implements StoppableThread.

Definition at line 57 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().

◆ Name()

std::string StoppableThread::Name ( ) const

inlineinherited

Definition at line 58 of file StoppableThread.h.

References StoppableThread::fName.

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

◆ OnEnd()

virtual void StoppableThread::OnEnd ( )

inlinevirtualinherited

Reimplemented in TAnalysisWriteLoopClient, TFragmentChainLoop, TAnalysisWriteLoop, and TDataLoop.

Definition at line 54 of file StoppableThread.h.

Referenced by StoppableThread::Loop().

◆ 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, and StoppableThread::Stop().

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 void StoppableThread::StatusWidth ( size_t val )

inlinestaticinherited

Definition at line 76 of file StoppableThread.h.

References StoppableThread::fStatusWidth.

◆ StatusWidth() [2/2]

static size_t StoppableThread::StatusWidth ( )

inlinestaticinherited

Definition at line 78 of file StoppableThread.h.

References StoppableThread::fStatusWidth.

Referenced by TGRSIint::SetupPipeline().

◆ 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.

Referenced by StoppableThread::SendStop().

◆ 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

◆ fInputQueue

template<typename T >

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

private

Definition at line 80 of file TTerminalLoop.h.

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

◆ fInputSize

std::atomic_long StoppableThread::fInputSize {0}

protectedinherited

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 95 of file StoppableThread.h.

Referenced by TAnalysisWriteLoop::EndStatus(), TFragWriteLoop::EndStatus(), TAnalysisWriteLoopClient::GetInputSize(), TEventBuildingLoop::Iteration(), TDataLoop::Iteration(), TDetBuildingLoop::Iteration(), TAnalysisWriteLoop::Iteration(), TUnpackingLoop::Iteration(), TFragWriteLoop::Iteration(), TFragHistLoop::Iteration(), TFragmentChainLoop::Iteration(), TAnalysisHistLoop::Iteration(), TAnalysisWriteLoopClient::Iteration(), StoppableThread::Progress(), and StoppableThread::Status().

◆ fItemsPopped

std::atomic_size_t StoppableThread::fItemsPopped {0}

protectedinherited

◆ fName

std::string StoppableThread::fName

protectedinherited

Definition at line 99 of file StoppableThread.h.

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

◆ fStatusThread

std::thread StoppableThread::fStatusThread

staticinherited

Definition at line 81 of file StoppableThread.h.

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

◆ fStatusThreadOn

bool StoppableThread::fStatusThreadOn = false

staticinherited

Definition at line 83 of file StoppableThread.h.

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

◆ fThreadMap

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

staticprotectedinherited

Definition at line 91 of file StoppableThread.h.

template<typename T> class TTerminalLoop< T >

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ ~TTerminalLoop()

◆ TTerminalLoop()

Member Function Documentation

◆ AllThreadHeader()

◆ AllThreadProgress()

◆ AllThreadStatus()

◆ AnyThreadRunning()

◆ AnyThreadStatus()

◆ ClearAllQueues()

◆ ClearQueue()

◆ ColumnWidth() [1/2]

◆ ColumnWidth() [2/2]

◆ EndStatus()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAll()

◆ GetItemsCurrent()

◆ GetItemsPopped()

◆ GetItemsPushed()

◆ GetNThreads()

◆ GetRate()

◆ InputQueue()

◆ IsPaused()

◆ IsRunning()

◆ Iteration()

◆ Join()

◆ join_status_thread()

◆ Name()

◆ OnEnd()

◆ Pause()

◆ PauseAll()

◆ Print()

◆ Progress()

◆ Resume()

◆ ResumeAll()

◆ SendStop()

◆ start_status_thread()

◆ Status()

◆ status_out()

◆ status_out_loop()

◆ StatusWidth() [1/2]

◆ StatusWidth() [2/2]

◆ Stop()

◆ stop_status_thread()

◆ StopAll()

Member Data Documentation

◆ fInputQueue

◆ fInputSize

◆ fItemsPopped

◆ fName

◆ fStatusThread

◆ fStatusThreadOn

◆ fThreadMap

template<typename T>
class TTerminalLoop< T >