DtVrfCallbackQueue::CallbackInterface Class Reference

API for writing callbacks. More...

Inheritance diagram for DtVrfCallbackQueue::CallbackInterface:

Classes
class	RefWrapper
class	Wrapper

Public Types
typedef boost::shared_ptr < CallbackInterface >	Ptr

Public Member Functions
virtual	~CallbackInterface ()
	Virtual destructor. More...
virtual std::string	label () const
	Name of callback, used only for logging and debugging. More...
virtual void	run ()=0
	Run callback. More...
virtual void	cancel ()
	Will be called if the callback will not be run before it's discarded. More...
virtual bool	valid () const
	Returns false the callback has become null. More...

Additional Inherited Members
Static Public Member Functions inherited from DtObjectDebugger< CallbackInterface >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()
Protected Member Functions inherited from DtObjectDebugger< CallbackInterface >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Detailed Description

API for writing callbacks.

Member Typedef Documentation

typedef boost::shared_ptr<CallbackInterface> DtVrfCallbackQueue::CallbackInterface::Ptr

Constructor & Destructor Documentation

virtual DtVrfCallbackQueue::CallbackInterface::~CallbackInterface ( )

virtual

Virtual destructor.

Reimplemented in DtParallelTickManager::CallbackInterface.

Member Function Documentation

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

virtual

Name of callback, used only for logging and debugging.

Reimplemented in DtVrfCallbackQueue::CallbackInterface::RefWrapper, and DtVrfCallbackQueue::CallbackInterface::Wrapper.

Referenced by DtVrfCallbackQueue::CallbackInterface::Wrapper::label(), and DtVrfCallbackQueue::CallbackInterface::RefWrapper::label().

virtual void DtVrfCallbackQueue::CallbackInterface::run ( )

pure virtual

Run callback.

Implemented in DtVrfCallbackQueue::CallbackInterface::RefWrapper, DtVrfCallbackQueue::CallbackInterface::Wrapper, DtSnapshotManager::DtWriteSnapshotJob, and DtParallelTickManager::CallbackInterface.

Referenced by DtVrfCallbackQueue::CallbackInterface::Wrapper::run(), and DtVrfCallbackQueue::CallbackInterface::RefWrapper::run().

virtual void DtVrfCallbackQueue::CallbackInterface::cancel ( )

virtual

Will be called if the callback will not be run before it's discarded.

Reimplemented in DtVrfCallbackQueue::CallbackInterface::RefWrapper, and DtVrfCallbackQueue::CallbackInterface::Wrapper.

Referenced by DtVrfCallbackQueue::CallbackInterface::Wrapper::cancel(), and DtVrfCallbackQueue::CallbackInterface::RefWrapper::cancel().

virtual bool DtVrfCallbackQueue::CallbackInterface::valid ( ) const

virtual

Returns false the callback has become null.

---

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

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