Base-class for all loops/threads.

Definition at line 29 of file StoppableThread.h.

Public Member Functions
	StoppableThread (std::string name)

virtual	~StoppableThread ()

virtual void	ClearQueue ()

virtual std::string	EndStatus ()

virtual size_t	GetItemsCurrent ()=0

virtual size_t	GetItemsPopped ()=0

virtual size_t	GetItemsPushed ()=0

virtual size_t	GetRate ()=0

bool	IsPaused ()

bool	IsRunning ()

virtual bool	Iteration ()=0

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 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 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
	StoppableThread (const StoppableThread &)

	ClassDef (StoppableThread, 0)

void	Loop ()

StoppableThread &	operator= (const StoppableThread &)

Private Attributes
std::atomic_bool	fForceStop {false}

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 size_t	fStatusWidth = 80

#include <StoppableThread.h>

Inheritance diagram for StoppableThread:

Collaboration diagram for StoppableThread:

Constructor & Destructor Documentation

◆ StoppableThread() [1/2]

StoppableThread::StoppableThread ( std::string name )

Definition at line 26 of file StoppableThread.cxx.

References fName, fStatusThreadOn, fThread, fThreadMap, Loop(), and start_status_thread().

◆ ~StoppableThread()

StoppableThread::~StoppableThread ( )

virtual

Definition at line 182 of file StoppableThread.cxx.

References fName, fStatusThread, fStatusThreadOn, and fThreadMap.

◆ StoppableThread() [2/2]

StoppableThread::StoppableThread ( const StoppableThread & )

inlineprivate

Definition at line 101 of file StoppableThread.h.

Member Function Documentation

◆ AllThreadHeader()

std::string StoppableThread::AllThreadHeader ( )

static

Definition at line 73 of file StoppableThread.cxx.

References fColumnWidth, fStatusWidth, and fThreadMap.

Referenced by TGRSIint::ApplyOptions().

◆ AllThreadProgress()

std::string StoppableThread::AllThreadProgress ( )

static

Definition at line 59 of file StoppableThread.cxx.

References fColumnWidth, fStatusWidth, and fThreadMap.

Referenced by TGRSIint::LoopUntilDone().

◆ AllThreadStatus()

std::string StoppableThread::AllThreadStatus ( )

static

Definition at line 83 of file StoppableThread.cxx.

References fColumnWidth, fStatusWidth, and fThreadMap.

Referenced by TGRSIint::LoopUntilDone().

◆ AnyThreadRunning()

bool StoppableThread::AnyThreadRunning ( )

static

Definition at line 37 of file StoppableThread.cxx.

References fThreadMap.

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

◆ AnyThreadStatus()

std::string StoppableThread::AnyThreadStatus ( )

static

Definition at line 47 of file StoppableThread.cxx.

References fThreadMap.

◆ ClassDef()

StoppableThread::ClassDef	(	StoppableThread	,
		0
	)

private

◆ ClearAllQueues()

void StoppableThread::ClearAllQueues ( )

static

Definition at line 166 of file StoppableThread.cxx.

References fThreadMap.

Referenced by TGRSIInterruptHandler::Notify().

◆ ClearQueue()

virtual void StoppableThread::ClearQueue ( )

inlinevirtual

Reimplemented in TUnpackingLoop, TDetBuildingLoop, TFragmentChainLoop, TAnalysisHistLoop, TAnalysisWriteLoopClient, TFragHistLoop, TEventBuildingLoop, TDataLoop, TTerminalLoop< T >, TFragWriteLoop, and TAnalysisWriteLoop.

Definition at line 60 of file StoppableThread.h.

◆ ColumnWidth() [1/2]

static void StoppableThread::ColumnWidth ( size_t val )

inlinestatic

Definition at line 75 of file StoppableThread.h.

References fColumnWidth.

◆ ColumnWidth() [2/2]

static size_t StoppableThread::ColumnWidth ( )

inlinestatic

Definition at line 77 of file StoppableThread.h.

References fColumnWidth.

Referenced by TGRSIint::SetupPipeline().

◆ EndStatus()

virtual std::string StoppableThread::EndStatus ( )

inlinevirtual

Reimplemented in TUnpackingLoop, TEventBuildingLoop, TFragWriteLoop, and TAnalysisWriteLoop.

Definition at line 57 of file StoppableThread.h.

Referenced by Join(), and Stop().

◆ Get()

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

static

Definition at line 173 of file StoppableThread.cxx.

References 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 ( )

static

Definition at line 315 of file StoppableThread.cxx.

References fThreadMap.

◆ GetItemsCurrent()

virtual size_t StoppableThread::GetItemsCurrent ( )

pure virtual

Implemented in TDetBuildingLoop, TUnpackingLoop, TAnalysisHistLoop, TFragHistLoop, TTerminalLoop< T >, TAnalysisWriteLoopClient, TDataLoop, TEventBuildingLoop, TFragWriteLoop, TFragmentChainLoop, and TAnalysisWriteLoop.

Referenced by status_out().

◆ GetItemsPopped()

virtual size_t StoppableThread::GetItemsPopped ( )

pure virtual

Implemented in TDetBuildingLoop, TUnpackingLoop, TAnalysisHistLoop, TFragHistLoop, TAnalysisWriteLoopClient, TTerminalLoop< T >, TDataLoop, TEventBuildingLoop, TFragWriteLoop, TFragmentChainLoop, and TAnalysisWriteLoop.

Referenced by status_out().

◆ GetItemsPushed()

virtual size_t StoppableThread::GetItemsPushed ( )

pure virtual

Implemented in TUnpackingLoop, TAnalysisHistLoop, TFragHistLoop, TDetBuildingLoop, TTerminalLoop< T >, TAnalysisWriteLoopClient, TDataLoop, TEventBuildingLoop, TFragWriteLoop, TFragmentChainLoop, and TAnalysisWriteLoop.

Referenced by status_out().

◆ GetNThreads()

int StoppableThread::GetNThreads ( )

static

Definition at line 21 of file StoppableThread.cxx.

References fThreadMap.

Referenced by Print().

◆ GetRate()

virtual size_t StoppableThread::GetRate ( )

pure virtual

Implemented in TDetBuildingLoop, TUnpackingLoop, TAnalysisHistLoop, TFragHistLoop, TTerminalLoop< T >, TAnalysisWriteLoopClient, TDataLoop, TEventBuildingLoop, TFragWriteLoop, TFragmentChainLoop, and TAnalysisWriteLoop.

Referenced by status_out().

◆ IsPaused()

bool StoppableThread::IsPaused ( )

Definition at line 224 of file StoppableThread.cxx.

References fPaused.

◆ IsRunning()

bool StoppableThread::IsRunning ( )

Definition at line 219 of file StoppableThread.cxx.

References fRunning.

Referenced by status_out().

◆ Iteration()

virtual bool StoppableThread::Iteration ( )

pure virtual

Implemented in TAnalysisHistLoop, TAnalysisWriteLoopClient, TFragmentChainLoop, TFragHistLoop, TTerminalLoop< T >, TFragWriteLoop, TUnpackingLoop, TAnalysisWriteLoop, TDetBuildingLoop, TDataLoop, and TEventBuildingLoop.

Referenced by Loop().

◆ Join()

void StoppableThread::Join ( )

Definition at line 229 of file StoppableThread.cxx.

References EndStatus(), and fThread.

Referenced by StopAll().

◆ join_status_thread()

void StoppableThread::join_status_thread ( )

static

Definition at line 280 of file StoppableThread.cxx.

References fStatusThread, and stop_status_thread().

◆ Loop()

void StoppableThread::Loop ( )

private

Definition at line 237 of file StoppableThread.cxx.

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

Referenced by StoppableThread().

◆ Name()

std::string StoppableThread::Name ( ) const

inline

Definition at line 58 of file StoppableThread.h.

References fName.

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

◆ OnEnd()

virtual void StoppableThread::OnEnd ( )

inlinevirtual

Reimplemented in TAnalysisWriteLoopClient, TFragmentChainLoop, TAnalysisWriteLoop, and TDataLoop.

Definition at line 54 of file StoppableThread.h.

Referenced by Loop().

◆ operator=()

StoppableThread& StoppableThread::operator= ( const StoppableThread & )

inlineprivate

Definition at line 102 of file StoppableThread.h.

◆ Pause()

void StoppableThread::Pause ( )

Definition at line 202 of file StoppableThread.cxx.

References fPaused, and fRunning.

◆ PauseAll()

void StoppableThread::PauseAll ( )

static

Definition at line 97 of file StoppableThread.cxx.

References fThreadMap.

◆ Print()

void StoppableThread::Print ( )

static

Definition at line 254 of file StoppableThread.cxx.

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

◆ Progress()

std::string StoppableThread::Progress ( )

virtual

Definition at line 119 of file StoppableThread.cxx.

References fColumnWidth, fInputSize, and fItemsPopped.

◆ Resume()

void StoppableThread::Resume ( )

Definition at line 193 of file StoppableThread.cxx.

References fPaused, fPausedWait, fPauseMutex, and fRunning.

◆ ResumeAll()

void StoppableThread::ResumeAll ( )

static

Definition at line 104 of file StoppableThread.cxx.

References fThreadMap.

Referenced by TGRSIint::SetupPipeline().

◆ SendStop()

void StoppableThread::SendStop ( )

static

Definition at line 135 of file StoppableThread.cxx.

References fThreadMap, and Stop().

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

◆ start_status_thread()

void StoppableThread::start_status_thread ( )

static

Definition at line 265 of file StoppableThread.cxx.

References fStatusThread, fStatusThreadOn, and status_out_loop().

Referenced by StoppableThread().

◆ Status()

std::string StoppableThread::Status ( )

virtual

Definition at line 111 of file StoppableThread.cxx.

References fColumnWidth, fInputSize, and fItemsPopped.

◆ status_out()

void StoppableThread::status_out ( )

static

Definition at line 297 of file StoppableThread.cxx.

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

Referenced by status_out_loop(), and StopAll().

◆ status_out_loop()

void StoppableThread::status_out_loop ( )

static

Definition at line 286 of file StoppableThread.cxx.

References fStatusThreadOn, and status_out().

Referenced by start_status_thread().

◆ StatusWidth() [1/2]

static void StoppableThread::StatusWidth ( size_t val )

inlinestatic

Definition at line 76 of file StoppableThread.h.

References fStatusWidth.

◆ StatusWidth() [2/2]

static size_t StoppableThread::StatusWidth ( )

inlinestatic

Definition at line 78 of file StoppableThread.h.

References fStatusWidth.

Referenced by TGRSIint::SetupPipeline().

◆ Stop()

void StoppableThread::Stop ( )

Definition at line 209 of file StoppableThread.cxx.

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

Referenced by SendStop().

◆ stop_status_thread()

void StoppableThread::stop_status_thread ( )

static

Definition at line 273 of file StoppableThread.cxx.

References fStatusThreadOn.

Referenced by join_status_thread().

◆ StopAll()

void StoppableThread::StopAll ( )

static

Definition at line 147 of file StoppableThread.cxx.

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

Referenced by TGRSIint::Terminate().

Member Data Documentation

◆ fColumnWidth

size_t StoppableThread::fColumnWidth = 20

staticprivate

Definition at line 104 of file StoppableThread.h.

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

◆ fForceStop

std::atomic_bool StoppableThread::fForceStop {false}

private

Definition at line 112 of file StoppableThread.h.

◆ fInputSize

std::atomic_long StoppableThread::fInputSize {0}

protected

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(), Progress(), and Status().

◆ fItemsPopped

std::atomic_size_t StoppableThread::fItemsPopped {0}

protected

◆ fName

std::string StoppableThread::fName

protected

Definition at line 99 of file StoppableThread.h.

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

◆ fPaused

std::atomic_bool StoppableThread::fPaused {false}

private

Definition at line 113 of file StoppableThread.h.

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

◆ fPausedWait

std::condition_variable StoppableThread::fPausedWait

private

Definition at line 114 of file StoppableThread.h.

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

◆ fPauseMutex

std::mutex StoppableThread::fPauseMutex

private

Definition at line 115 of file StoppableThread.h.

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

◆ fRunning

std::atomic_bool StoppableThread::fRunning {false}

private

Definition at line 111 of file StoppableThread.h.

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

◆ fStatusThread

std::thread StoppableThread::fStatusThread

static

Definition at line 81 of file StoppableThread.h.

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

◆ fStatusThreadOn

bool StoppableThread::fStatusThreadOn = false

static

Definition at line 83 of file StoppableThread.h.

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

◆ fStatusWidth

size_t StoppableThread::fStatusWidth = 80

staticprivate

Definition at line 105 of file StoppableThread.h.

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

◆ fThread

std::thread StoppableThread::fThread

private

Definition at line 110 of file StoppableThread.h.

Referenced by Join(), and StoppableThread().

◆ fThreadMap

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

staticprotected

Definition at line 91 of file StoppableThread.h.

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

◆ StoppableThread() [1/2]

◆ ~StoppableThread()

◆ StoppableThread() [2/2]

Member Function Documentation

◆ AllThreadHeader()

◆ AllThreadProgress()

◆ AllThreadStatus()

◆ AnyThreadRunning()

◆ AnyThreadStatus()

◆ ClassDef()

◆ ClearAllQueues()

◆ ClearQueue()

◆ ColumnWidth() [1/2]

◆ ColumnWidth() [2/2]

◆ EndStatus()

◆ Get()

◆ GetAll()

◆ GetItemsCurrent()

◆ GetItemsPopped()

◆ GetItemsPushed()

◆ GetNThreads()

◆ GetRate()

◆ IsPaused()

◆ IsRunning()

◆ Iteration()

◆ Join()

◆ join_status_thread()

◆ Loop()

◆ Name()

◆ OnEnd()

◆ operator=()

◆ 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

◆ fColumnWidth

◆ fForceStop

◆ fInputSize

◆ fItemsPopped

◆ fName

◆ fPaused

◆ fPausedWait

◆ fPauseMutex

◆ fRunning

◆ fStatusThread

◆ fStatusThreadOn

◆ fStatusWidth

◆ fThread

◆ fThreadMap