Lunchbox  1.10.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
lunchbox::FutureTrue Class Reference

A boolean future always returning true. More...

#include <futureFunction.h>

+ Inheritance diagram for lunchbox::FutureTrue:
+ Collaboration diagram for lunchbox::FutureTrue:

Protected Member Functions

bool wait (const uint32_t) final
 Wait for the promise to be fullfilled. More...
 
bool isReady () const final
 
- Protected Member Functions inherited from lunchbox::Referenced
LUNCHBOX_API Referenced ()
 Construct a new reference-counted object. More...
 
 Referenced (const Referenced &)
 Construct a new copy of a reference-counted object. More...
 
virtual LUNCHBOX_API ~Referenced ()
 Destruct a reference-counted object. More...
 
Referencedoperator= (const Referenced &)
 Assign another object to this object. More...
 
virtual LUNCHBOX_API void notifyFree ()
 

Additional Inherited Members

- Public Member Functions inherited from lunchbox::FutureImpl< bool >
virtual ~FutureImpl ()
 Destruct the future. More...
 
- Public Member Functions inherited from lunchbox::Referenced
void ref (const void *holder LB_UNUSED=0) const
 Increase the reference count. More...
 
bool unref (const void *holder LB_UNUSED=0) const
 Decrease the reference count. More...
 
int32_t getRefCount () const
 
void printHolders (std::ostream &) const
 

Detailed Description

A boolean future always returning true.

Fully thread safe.

Definition at line 27 of file futureFunction.h.

Member Function Documentation

bool lunchbox::FutureTrue::isReady ( ) const
inlinefinalprotectedvirtual
Returns
true if the future has been fulfilled, false if it is pending.

Implements lunchbox::FutureImpl< bool >.

Definition at line 31 of file futureFunction.h.

bool lunchbox::FutureTrue::wait ( const uint32_t  timeout)
inlinefinalprotectedvirtual

Wait for the promise to be fullfilled.

May be called multiple times.

Parameters
timeoutoptional timeout in milliseconds. If the future is not ready when the timer goes off a timeout exception is thrown.

Implements lunchbox::FutureImpl< bool >.

Definition at line 30 of file futureFunction.h.


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