DtVrfCallbackQueue Class Reference

Simple asynchronous callback queue.

Inheritance diagram for DtVrfCallbackQueue:

Classes
class	CallbackInterface
struct	Record
struct	ThreadInfo

Public Types
typedef boost::function< void()>	Callback

Public Member Functions
	DtVrfCallbackQueue (const std::string &label, unsigned maxTasks)
virtual	~DtVrfCallbackQueue ()
virtual std::string	label () const
virtual void	setWarnTime (double seconds)
virtual void	setWarnTime (double seconds, std::ostream &output)
virtual void	printInfo (std::ostream &, size_t width=0) const
virtual size_t	totalNumberOfCallbacks () const
virtual unsigned	size () const
virtual size_t	numExecuting () const
virtual unsigned	maxTasks () const
virtual void	setMaxTasks (unsigned tasks, bool wait=true)
void	shutdown (bool wait=true)
virtual void	clear (bool wait=true)
virtual void	add_back (const Callback &, const std::string &label="")
virtual void	add_front (const Callback &, const std::string &label="")
virtual void	add_back (CallbackInterface *)
virtual void	add_front (CallbackInterface *)
virtual void	add_back (const CallbackInterface::Ptr &)
virtual void	add_front (const CallbackInterface::Ptr &)
virtual void	add_back (CallbackInterface &)
virtual void	add_front (CallbackInterface &)
virtual bool	runOne (bool block=false, ThreadInfo *info=0)
virtual void	runAll (bool useThisThread=false)

Static Public Member Functions
static void	cleanup ()

Private Types
typedef std::mutex	Mutex
typedef std::condition_variable	Condition
typedef std::unique_lock< Mutex >	Lock
typedef std::multimap< double, std::ostream *, std::greater < double > >	StreamMap

Private Member Functions
virtual bool	pop (CallbackInterface::Ptr &, bool block=true, ThreadInfo *info=0)
void	execute (ThreadInfo *)

Private Attributes
Mutex	myMutex
Condition	myCondition
Condition	myDoneCondition
ThreadInfo::List	myThreads
Record::List	myCallbacks
bool	myShutdownFlag
size_t	myTotalNumCallbacks
std::atomic< size_t >	myNumExecuting
DtConsoleCommandManager *	myConsoleManager
std::string	myLabel
StreamMap	myWarnTimes

Friends
struct	ThreadInfo

Member Typedef Documentation

typedef boost::function<void ()> DtVrfCallbackQueue::Callback

typedef std::mutex DtVrfCallbackQueue::Mutex

private

typedef std::condition_variable DtVrfCallbackQueue::Condition

private

typedef std::unique_lock<Mutex> DtVrfCallbackQueue::Lock

private

typedef std::multimap<double, std::ostream*, std::greater<double> > DtVrfCallbackQueue::StreamMap

private

Constructor & Destructor Documentation

DtVrfCallbackQueue::DtVrfCallbackQueue ( const std::string &  label, unsigned  maxTasks  )

explicit

Constructor.

Parameters

maxTasks

max number of threads.

virtual DtVrfCallbackQueue::~DtVrfCallbackQueue ( )

virtual

Virtual destructor.

Member Function Documentation

virtual std::string DtVrfCallbackQueue::label ( ) const

virtual

Get label of callback queue.

static void DtVrfCallbackQueue::cleanup ( )

static

Cleans up global memory.

virtual void DtVrfCallbackQueue::setWarnTime ( double  seconds )

virtual

Queue will print warns when jobs are queued for longer than this.

virtual void DtVrfCallbackQueue::setWarnTime ( double  seconds, std::ostream &  output  )

virtual

virtual void DtVrfCallbackQueue::printInfo ( std::ostream &  , size_t  width = 0  ) const

virtual

Print detailed info to stream.

virtual size_t DtVrfCallbackQueue::totalNumberOfCallbacks ( ) const

virtual

Total number of callbacks added to the queue that have not finished executing.

virtual unsigned DtVrfCallbackQueue::size ( ) const

virtual

Number of jobs currently on the queue waiting to be executed.

virtual size_t DtVrfCallbackQueue::numExecuting ( ) const

virtual

Current number of callbacks executing their callbacks right now.

virtual unsigned DtVrfCallbackQueue::maxTasks ( ) const

virtual

Current max number concurrent of tasks.

virtual void DtVrfCallbackQueue::setMaxTasks ( unsigned  tasks, bool  wait = true  )

virtual

Set max number of tasks.

Parameters

wait	if true will wait for threads to exit.

void DtVrfCallbackQueue::shutdown

(

bool

wait = true

)

Notify all threads to shutdown. Not virtual because it is called in the destructor.

Parameters

wait	If true function will wait for all threads to end.

virtual void DtVrfCallbackQueue::clear ( bool  wait = true )

virtual

Remove all tasks.

virtual void DtVrfCallbackQueue::add_back ( const Callback &  , const std::string &  label = ""  )

virtual

Add a job to the back of the queue.

virtual void DtVrfCallbackQueue::add_front ( const Callback &  , const std::string &  label = ""  )

virtual

Add a job to the front of the queue.

virtual void DtVrfCallbackQueue::add_back ( CallbackInterface *  )

virtual

Add a job to the back of the queue.

Note

This function takes ownership of the callback object.

virtual void DtVrfCallbackQueue::add_front ( CallbackInterface *  )

virtual

Add a job to the front of the queue.

Note

This function takes ownership of the callback object.

virtual void DtVrfCallbackQueue::add_back ( const CallbackInterface::Ptr &  )

virtual

Add a job to the back of the queue.

virtual void DtVrfCallbackQueue::add_front ( const CallbackInterface::Ptr &  )

virtual

Add a job to the front of the queue.

virtual void DtVrfCallbackQueue::add_back ( CallbackInterface &  )

virtual

Add a job to the back of the queue. Caller is responsible for lifetime of callback.

virtual void DtVrfCallbackQueue::add_front ( CallbackInterface &  )

virtual

Add a job to the front of the queue Caller is responsible for lifetime of callback.

virtual bool DtVrfCallbackQueue::runOne ( bool  block = false, ThreadInfo *  info = 0  )

virtual

Pop and run one job from front of queue.

Parameters

block	if true this function will wait for a job if the queue is empty.
info	ThreadInfo data structure for this thread if it's managed by this object.

Returns

true if there was a job to run.

virtual void DtVrfCallbackQueue::runAll ( bool  useThisThread = false )

virtual

Will not return until the queue has empty.

Parameters

useThisThread

if true will run callbacks with this thread, otherwise will wait. If there are no threads this parameter is ignored.

virtual bool DtVrfCallbackQueue::pop ( CallbackInterface::Ptr &  , bool  block = true, ThreadInfo *  info = 0  )

privatevirtual

Pop a job from the queue, if it's empty block.

Parameters

block	if true this function will wait for a job if the queue is empty.
info	ThreadInfo data structure for this thread if it's managed by this object.

Returns

bool false if the thread is shutting down.

void DtVrfCallbackQueue::execute ( ThreadInfo *  )

private

Thread main.

Friends And Related Function Documentation

friend struct ThreadInfo

friend

Member Data Documentation

Mutex DtVrfCallbackQueue::myMutex

mutableprivate

Condition DtVrfCallbackQueue::myCondition

mutableprivate

Condition DtVrfCallbackQueue::myDoneCondition

mutableprivate

ThreadInfo::List DtVrfCallbackQueue::myThreads

private

Record::List DtVrfCallbackQueue::myCallbacks

private

bool DtVrfCallbackQueue::myShutdownFlag

private

size_t DtVrfCallbackQueue::myTotalNumCallbacks

private

std::atomic<size_t> DtVrfCallbackQueue::myNumExecuting

private

DtConsoleCommandManager* DtVrfCallbackQueue::myConsoleManager

private

std::string DtVrfCallbackQueue::myLabel

private

StreamMap DtVrfCallbackQueue::myWarnTimes

private

---

The documentation for this class was generated from the following file:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/vrfCallbackQueue.h