utils::CallbackGuard Class Reference

Callback guard. More...

#include <callback-guard.hpp>

Classes
class	SharedState

Public Types
typedef std::shared_ptr< void >	Tracker

Public Member Functions
	CallbackGuard ()
	Creates a guard. More...
	~CallbackGuard ()
	Waits for all trackers. More...
Tracker	spawn () const
	Creates a tracker. More...
long	getTrackersCount () const
	Gets trackers count. More...
bool	waitForTrackers (const unsigned int timeoutMs)
	Wait for all trackers. More...

Private Member Functions
	CallbackGuard (const CallbackGuard &)=delete
CallbackGuard &	operator= (const CallbackGuard &)=delete

Private Attributes
std::shared_ptr< SharedState >	mSharedState

Detailed Description

Callback guard.

An utility class to control and/or monitor callback lifecycle.

Member Typedef Documentation

typedef std::shared_ptr<void> utils::CallbackGuard::Tracker

Constructor & Destructor Documentation

utils::CallbackGuard::CallbackGuard

(

)

Creates a guard.

utils::CallbackGuard::~CallbackGuard

(

)

Waits for all trackers.

utils::CallbackGuard::CallbackGuard ( const CallbackGuard &  )

privatedelete

Member Function Documentation

long utils::CallbackGuard::getTrackersCount

(

)

const

Gets trackers count.

CallbackGuard& utils::CallbackGuard::operator= ( const CallbackGuard &  )

privatedelete

CallbackGuard::Tracker utils::CallbackGuard::spawn

(

)

const

Creates a tracker.

bool utils::CallbackGuard::waitForTrackers

(

const unsigned int

timeoutMs

)

Wait for all trackers.

Member Data Documentation

std::shared_ptr<SharedState> utils::CallbackGuard::mSharedState

private

---

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

• common/utils/callback-guard.hpp
• common/utils/callback-guard.cpp