future.h File Reference

#include "var_future/config.h"
#include "var_future/impl/storage_decl.h"
#include <memory>
#include <string>
#include "var_future/impl/async.h"
#include "var_future/impl/future.h"
#include "var_future/impl/join.h"
#include "var_future/impl/promise.h"
#include "var_future/impl/storage_impl.h"

Go to the source code of this file.

Classes
class	aom::Basic_promise< Alloc, Ts >
	Landing for a value that finishes a Future. More...
class	aom::Basic_future< Alloc, Ts >
	Values that will be eventually available. More...
struct	aom::Unfullfilled_promise
	Error assigned to a future who's promise is destroyed before being finished. More...
class	aom::Basic_promise< Alloc, Ts >
	Landing for a value that finishes a Future. More...

Typedefs
template<typename... Ts>
using	aom::Future = Basic_future< std::allocator< void >, Ts... >
template<typename... Ts>
using	aom::Promise = Basic_promise< std::allocator< void >, Ts... >

Functions
template<typename... FutTs>
auto	aom::join (FutTs &&... futures)
	Ties a set of Future<> into a single Future<> that is finished once all child futures are finished. More...
template<typename QueueT , typename CbT >
auto	aom::async (QueueT &q, CbT &&callback)
	Posts a callback into to queue, and return a future that will be finished upon executaiton of the callback. More...
template<typename Alloc , typename... Ts>
Basic_future< Alloc, Ts... >	aom::flatten (Basic_future< Alloc, std::tuple< Ts... >> &rhs)
	Create a higher-order Future from a future<tuple> More...
template<typename... Ts>
auto	aom::segmented (Ts &&... args)
	Used to let a callback return a higher-order future. More...
std::string	aom::varfut_lib_version_string ()
	Obtains the current version of the library. More...

Detailed Description

Futures

Function Documentation

async()

template<typename QueueT , typename CbT >

auto aom::async	(	QueueT &	q,
		CbT &&	callback
	)

Posts a callback into to queue, and return a future that will be finished upon executaiton of the callback.

Template Parameters

QueueT
CbT

Parameters

q
callback

Returns

auto

flatten()

template<typename Alloc , typename... Ts>

Basic_future<Alloc, Ts...> aom::flatten

(

Basic_future< Alloc, std::tuple< Ts... >> &

rhs

)

Create a higher-order Future from a future<tuple>

Parameters

rhs

Postcondition

rhs will be uninitialized.

this will inherit the state rhs was in.

join()

template<typename... FutTs>

auto aom::join

(

FutTs &&...

futures

)

Ties a set of Future<> into a single Future<> that is finished once all child futures are finished.

Template Parameters

FutTs

Parameters

futures

Returns

auto

segmented()

template<typename... Ts>

auto aom::segmented

(

Ts &&...

args

)

Used to let a callback return a higher-order future.

Template Parameters

Ts

Parameters

args

Returns

auto

varfut_lib_version_string()

std::string aom::varfut_lib_version_string ( )

inline

Obtains the current version of the library.

Returns

std::string