qi::ScopedFutureGroup Class Reference

#include <futuregroup.hpp>

Public Member Functions
	ScopedFutureGroup ()
	~ScopedFutureGroup ()
template<class T >
void	add (Future< T > future)
void	cancelAll ()
bool	empty () const
size_t	size () const
Public Member Functions inherited from qi::Trackable< ScopedFutureGroup >
	Trackable (ScopedFutureGroup *ptr)
	Default constructor. More...
	~Trackable ()
	Default destructor. More...
boost::shared_ptr < ScopedFutureGroup >	lock ()
boost::weak_ptr < ScopedFutureGroup >	weakPtr ()
void	wait ()

Additional Inherited Members
Protected Member Functions inherited from qi::Trackable< ScopedFutureGroup >
void	destroy ()

Detailed Description

Cancel a group of unfinished registered futures on destruction. Guarantees that the registered set of futures will be canceled whatever the reason of the destruction of the group.

Remarks

All public member functions are thread-safe unless specified.

Definition at line 19 of file futuregroup.hpp.

Constructor & Destructor Documentation

qi::ScopedFutureGroup::ScopedFutureGroup ( )

inline

Definition at line 24 of file futuregroup.hpp.

qi::ScopedFutureGroup::~ScopedFutureGroup ( )

inline

Destructor, cancel all unfinished futures registered.

Definition at line 30 of file futuregroup.hpp.

Member Function Documentation

template<class T >

void qi::ScopedFutureGroup::add ( Future< T >  future )

inline

Register a future to be canceled if not finished when this object is destroyed, or if cancelAll() is called. Futures finishing before cancelation will be automatically unregistered. Non-cancelable futures will be ignored.

Parameters

future

Future to register.

Definition at line 43 of file futuregroup.hpp.

void qi::ScopedFutureGroup::cancelAll ( )

inline

Cancel all registered futures and unregister them.

Definition at line 62 of file futuregroup.hpp.

bool qi::ScopedFutureGroup::empty ( ) const

inline

Returns

True if there is no future registered, false otherwise.

Definition at line 89 of file futuregroup.hpp.

size_t qi::ScopedFutureGroup::size ( ) const

inline

Returns

Count of registered futures.

Definition at line 96 of file futuregroup.hpp.

---

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

• /home/opennao/work/master/sdk/libqi/qi/futuregroup.hpp