honey::FutureBase Class Reference

Base class for Future types. More...

#include <Future.h>

Inheritance diagram for honey::FutureBase:

Collaboration diagram for honey::FutureBase:

Public Types
typedef future::priv::StateBase	StateBase

Public Member Functions
bool	valid () const
	Check if this instance has state and can be used. State can be transferred out to another instance through move-assignment. More...
bool	ready () const
	Check if result is ready. More...
void	wait () const
	Wait until result is ready. More...
template<class Rep , class Period >
future::Status	wait (Duration< Rep, Period > time) const
	Wait until result is ready or until an amount of time has passed. More...
template<class Clock , class Dur >
future::Status	wait (TimePoint< Clock, Dur > time) const
	Wait until result is ready or until a certain time. More...
StateBase &	__stateBase () const
	Get the shared state. More...

Protected Member Functions
virtual StateBase *	stateBase () const =0

Detailed Description

Base class for Future types.

Member Typedef Documentation

typedef future::priv::StateBase honey::FutureBase::StateBase

Member Function Documentation

StateBase& honey::FutureBase::__stateBase ( ) const

inline

Get the shared state.

bool honey::FutureBase::ready ( ) const

inline

Check if result is ready.

Exceptions

future::NoState

virtual StateBase* honey::FutureBase::stateBase ( ) const

protectedpure virtual

Implemented in honey::Future< R >, and honey::SharedFuture< R >.

bool honey::FutureBase::valid ( ) const

inline

Check if this instance has state and can be used. State can be transferred out to another instance through move-assignment.

void honey::FutureBase::wait ( ) const

inline

Wait until result is ready.

Exceptions

future::NoState

template<class Rep , class Period >

future::Status honey::FutureBase::wait ( Duration< Rep, Period >  time ) const

inline

Wait until result is ready or until an amount of time has passed.

Exceptions

future::NoState

template<class Clock , class Dur >

future::Status honey::FutureBase::wait ( TimePoint< Clock, Dur >  time ) const

inline

Wait until result is ready or until a certain time.

Exceptions

future::NoState

---

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

• src/common/Honey/Thread/Future/Future.h