dispenso::Future< Result & > Class Template Reference

More...

#include <future.h>

Inherits dispenso::detail::FutureBase< Result & >.

Public Member Functions
	Future () noexcept
	Future (Future &&f) noexcept
	Future (Base &&f) noexcept
	Future (const Future &f) noexcept
	Future (const Base &f) noexcept
template<typename F , typename Schedulable >
	Future (F &&f, Schedulable &schedulable, std::launch asyncPolicy=kNotAsync, std::launch deferredPolicy=std::launch::deferred)
Result &	get () const

Friends
template<typename X >
Future< X & >	make_ready_future (std::reference_wrapper< X > x)

Detailed Description

template<typename Result>
class dispenso::Future< Result & >

Definition at line 274 of file future.h.

Constructor & Destructor Documentation

Future() [1/6]

template<typename Result >

dispenso::Future< Result & >::Future ( )

inlinenoexcept

Default constructor.

Definition at line 279 of file future.h.

Future() [2/6]

template<typename Result >

dispenso::Future< Result & >::Future ( Future< Result & > && f )

inlinenoexcept

Move constructor.

Definition at line 281 of file future.h.

Future() [3/6]

template<typename Result >

dispenso::Future< Result & >::Future ( Base && f )

inlinenoexcept

Move constructor.

Definition at line 283 of file future.h.

Future() [4/6]

template<typename Result >

dispenso::Future< Result & >::Future ( const Future< Result & > & f )

inlinenoexcept

Copy constructor.

Definition at line 285 of file future.h.

Future() [5/6]

template<typename Result >

dispenso::Future< Result & >::Future ( const Base & f )

inlinenoexcept

Copy constructor.

Definition at line 287 of file future.h.

Future() [6/6]

template<typename Result >

template<typename F , typename Schedulable >

dispenso::Future< Result & >::Future ( F && f, Schedulable & schedulable, std::launch asyncPolicy = kNotAsync, std::launch deferredPolicy = std::launch::deferred )

inline

Construct with callable and schedulable.

See also

Future<Result>::Future(F&&, Schedulable&, std::launch, std::launch)

Definition at line 291 of file future.h.

Member Function Documentation

get()

template<typename Result >

Result & dispenso::Future< Result & >::get ( ) const

inline

Get the result of the future functor. This function blocks until the result is ready.

Returns

Access to the underlying reference.

Definition at line 321 of file future.h.

Friends And Related Symbol Documentation

Future

template<typename Result >

template<typename R >

friend class Future

friend

Definition at line 352 of file future.h.

make_ready_future

template<typename Result >

template<typename X >

Future< X & > make_ready_future ( std::reference_wrapper< X > x )

friend

Make a Future in a ready state with the reference_wrapper passed into make_ready_future

Parameters

x	the wrapped reference to use to create the returned future.

Definition at line 611 of file future.h.

---

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

• /github/workspace/dispenso/future.h