Lunchbox  1.14.0
Multi-threaded C++ toolbox library for all application developers creating high-performance multi-threaded programs.
lunchbox::Future< void > Class Template Reference

Future template specialization for void. More...

#include <future.h>

+ Collaboration diagram for lunchbox::Future< void >:

Public Types

typedef RefPtr< FutureImpl< void > > Impl
 The wait implementation.
 

Public Member Functions

 Future (Impl impl)
 Construct a new future. More...
 
 ~Future ()
 Destruct the future. More...
 
void wait (const uint32_t timeout_=LB_TIMEOUT_INDEFINITE)
 Wait for the promise to be fullfilled. More...
 
bool isReady () const
 

Protected Attributes

Impl impl_
 

Detailed Description

template<>
class lunchbox::Future< void >

Future template specialization for void.

Definition at line 126 of file future.h.

Constructor & Destructor Documentation

lunchbox::Future< void >::Future ( Impl  impl)
inlineexplicit

Construct a new future.

Definition at line 136 of file future.h.

lunchbox::Future< void >::~Future ( )
inline

Destruct the future.

Definition at line 139 of file future.h.

Member Function Documentation

bool lunchbox::Future< void >::isReady ( ) const
inline
Returns
true if the future has been fulfilled, false if it is pending.

Definition at line 156 of file future.h.

void lunchbox::Future< void >::wait ( const uint32_t  timeout_ = LB_TIMEOUT_INDEFINITE)
inline

Wait for the promise to be fullfilled.

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

Definition at line 148 of file future.h.


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