#include <future_fwd.hpp>

Public Types
typedef Future< T >::ValueType	ValueType

typedef Future< T >::ValueTypeCast	ValueTypeCast

typedef Future< T >::Connection	Connection

Public Member Functions
	FutureSync ()

	FutureSync (const Future< T > &b)

	FutureSync (const FutureSync< T > &b)

	FutureSync (const ValueType &v)

FutureSync< T > &	operator= (const FutureSync< T > &b)

FutureSync< T > &	operator= (const Future< T > &b)

	~FutureSync () QI_NOEXCEPT(false)

	operator Future< T > ()

bool	operator< (const FutureSync< T > &b) const

FutureUniqueId	uniqueId () const

const ValueType &	value (int msecs=FutureTimeout_Infinite) const

	operator const typename Future< T >::ValueTypeCast & () const

FutureState	wait (int msecs=FutureTimeout_Infinite) const

FutureState	wait (qi::Duration duration) const

FutureState	waitFor (qi::Duration duration) const

FutureState	wait (qi::SteadyClock::time_point timepoint) const

FutureState	waitUntil (qi::SteadyClock::time_point timepoint) const

bool	isRunning () const

bool	isFinished () const

bool	isCanceled () const

bool	hasError (int msecs=FutureTimeout_Infinite) const

bool	hasValue (int msecs=FutureTimeout_Infinite) const

const std::string &	error (int msecs=FutureTimeout_Infinite) const

void	cancel ()

bool	isCancelable () const

void	connect (const Connection &s)

void	_connect (const boost::function< void()> &s)

template<typename FUNCTYPE , typename ARG0 >
void	connect (FUNCTYPE fun, ARG0 tracked,...)

Future< T >	async ()

Protected Attributes
bool	_sync

Future< T >	_future

Friends
class	Future< T >

Detailed Description

template<typename T>
class qi::FutureSync< T >

This class allow throwing on error and being synchronous when the future is not handled by the client.

This class should only be used as return type. If you want to store it, use qi::Future.

Definition at line 62 of file future_fwd.hpp.

Member Typedef Documentation

template<typename T>

typedef Future<T>::Connection qi::FutureSync< T >::Connection

Definition at line 521 of file future_fwd.hpp.

template<typename T>

typedef Future<T>::ValueType qi::FutureSync< T >::ValueType

Definition at line 519 of file future_fwd.hpp.

template<typename T>

typedef Future<T>::ValueTypeCast qi::FutureSync< T >::ValueTypeCast

Definition at line 520 of file future_fwd.hpp.

Constructor & Destructor Documentation

template<typename T>

qi::FutureSync< T >::FutureSync ( )

inline

Definition at line 523 of file future_fwd.hpp.

template<typename T>

qi::FutureSync< T >::FutureSync ( const Future< T > & b )

inline

Definition at line 525 of file future_fwd.hpp.

template<typename T>

qi::FutureSync< T >::FutureSync ( const FutureSync< T > & b )

inline

Definition at line 531 of file future_fwd.hpp.

template<typename T>

qi::FutureSync< T >::FutureSync ( const ValueType & v )

inlineexplicit

Definition at line 538 of file future_fwd.hpp.

template<typename T>

qi::FutureSync< T >::~FutureSync ( )

inline

will block until the future returns if the future is kept synchronous

Warning: this will throw if the future returns an error

Definition at line 564 of file future_fwd.hpp.

Member Function Documentation

template<typename T>

void qi::FutureSync< T >::_connect ( const boost::function< void()> & s )

inline

Definition at line 601 of file future_fwd.hpp.

template<typename T>

Future<T> qi::FutureSync< T >::async ( )

inline

Definition at line 624 of file future_fwd.hpp.

template<typename T>

void qi::FutureSync< T >::cancel ( )

inline

Definition at line 598 of file future_fwd.hpp.

template<typename T>

void qi::FutureSync< T >::connect ( const Connection & s )

inline

Definition at line 600 of file future_fwd.hpp.

template<typename T>

template<typename FUNCTYPE , typename ARG0 >

void qi::FutureSync< T >::connect	(	FUNCTYPE	fun,
		ARG0	tracked,
			...
	)

Connect a callback with binding and tracking support.

If the first argument is a weak_ptr or a pointer inheriting from qi::Trackable, the callback will not be called if tracked object was destroyed.

template<typename T>

const std::string& qi::FutureSync< T >::error ( int msecs = FutureTimeout_Infinite ) const

inline

Definition at line 597 of file future_fwd.hpp.

template<typename T>

bool qi::FutureSync< T >::hasError ( int msecs = FutureTimeout_Infinite ) const

inline

Definition at line 595 of file future_fwd.hpp.

template<typename T>

bool qi::FutureSync< T >::hasValue ( int msecs = FutureTimeout_Infinite ) const

inline

Definition at line 596 of file future_fwd.hpp.

template<typename T>

bool qi::FutureSync< T >::isCancelable ( ) const

inline

Definition at line 599 of file future_fwd.hpp.

template<typename T>

bool qi::FutureSync< T >::isCanceled ( ) const

inline

Definition at line 594 of file future_fwd.hpp.

template<typename T>

bool qi::FutureSync< T >::isFinished ( ) const

inline

Definition at line 593 of file future_fwd.hpp.

template<typename T>

bool qi::FutureSync< T >::isRunning ( ) const

inline

Definition at line 592 of file future_fwd.hpp.

template<typename T>

qi::FutureSync< T >::operator const typename Future< T >::ValueTypeCast & ( ) const

inline

Definition at line 586 of file future_fwd.hpp.

template<typename T>

qi::FutureSync< T >::operator Future< T > ( )

inline

Definition at line 570 of file future_fwd.hpp.

template<typename T>

bool qi::FutureSync< T >::operator< ( const FutureSync< T > & b ) const

inline

Definition at line 575 of file future_fwd.hpp.

template<typename T>

FutureSync<T>& qi::FutureSync< T >::operator= ( const FutureSync< T > & b )

inline

Definition at line 546 of file future_fwd.hpp.

template<typename T>

FutureSync<T>& qi::FutureSync< T >::operator= ( const Future< T > & b )

inline

Definition at line 554 of file future_fwd.hpp.

template<typename T>

FutureUniqueId qi::FutureSync< T >::uniqueId ( ) const

inline

Definition at line 580 of file future_fwd.hpp.

template<typename T>

const ValueType& qi::FutureSync< T >::value ( int msecs = FutureTimeout_Infinite ) const

inline

Definition at line 585 of file future_fwd.hpp.

template<typename T>

FutureState qi::FutureSync< T >::wait ( int msecs = FutureTimeout_Infinite ) const

inline

Definition at line 587 of file future_fwd.hpp.

template<typename T>

FutureState qi::FutureSync< T >::wait ( qi::Duration duration ) const

inline

Definition at line 588 of file future_fwd.hpp.

template<typename T>

FutureState qi::FutureSync< T >::wait ( qi::SteadyClock::time_point timepoint ) const

inline

Definition at line 590 of file future_fwd.hpp.

template<typename T>

FutureState qi::FutureSync< T >::waitFor ( qi::Duration duration ) const

inline

Definition at line 589 of file future_fwd.hpp.

template<typename T>

FutureState qi::FutureSync< T >::waitUntil ( qi::SteadyClock::time_point timepoint ) const

inline

Definition at line 591 of file future_fwd.hpp.

Friends And Related Function Documentation

template<typename T>

friend class Future< T >

friend

Definition at line 633 of file future_fwd.hpp.

Member Data Documentation

template<typename T>

Future<T> qi::FutureSync< T >::_future

protected

Definition at line 632 of file future_fwd.hpp.

template<typename T>

bool qi::FutureSync< T >::_sync

mutableprotected

Definition at line 631 of file future_fwd.hpp.

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

/home/opennao/work/master/sdk/libqi/qi/detail/future_fwd.hpp

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

template<typename T> class qi::FutureSync< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename T>
class qi::FutureSync< T >