google::cloud::promise< void > Class Reference

Specialize promise as defined in ISO/IEC TS 19571:2016 for void. More...

#include <google/cloud/future_void.h>

Public Member Functions
	promise ()
	Creates a promise with an unsatisfied shared state. More...
	promise (std::function< void()> cancellation_callback)
	Creates a promise with an unsatisfied shared state. More...
	promise (null_promise_t x)
	Creates a promise without a shared state. More...
	promise (promise &&)=default
	Constructs a new promise and transfer any shared state from rhs. More...
promise &	operator= (promise &&rhs) noexcept
	Abandons the shared state in *this, if any, and transfers the shared state from rhs. More...
	~promise ()=default
	Abandons any shared state. More...
	promise (promise const &)=delete
promise &	operator= (promise const &)=delete
void	swap (promise &other) noexcept
	Swaps the shared state in *this with rhs. More...
future< void >	get_future ()
	Creates the future<void> using the same shared state as *this. More...
void	set_value ()
	Satisfies the shared state. More...

Detailed Description

Specialize promise as defined in ISO/IEC TS 19571:2016 for void.

Definition at line 140 of file future_void.h.

Constructor & Destructor Documentation

promise() [1/5]

google::cloud::promise< void >::promise ( )

inline

Creates a promise with an unsatisfied shared state.

Definition at line 143 of file future_void.h.

promise() [2/5]

google::cloud::promise< void >::promise ( std::function< void()>  cancellation_callback )

inlineexplicit

Creates a promise with an unsatisfied shared state.

Definition at line 146 of file future_void.h.

promise() [3/5]

google::cloud::promise< void >::promise ( null_promise_t  x )

inlineexplicit

Creates a promise without a shared state.

Definition at line 150 of file future_void.h.

promise() [4/5]

google::cloud::promise< void >::promise ( promise< void > &&  )

default

Constructs a new promise and transfer any shared state from rhs.

~promise()

google::cloud::promise< void >::~promise ( )

default

Abandons any shared state.

If the shared state was not already satisfied it becomes satisfied with a std::future_error exception. The error code in this exception is std::future_errc::broken_promise.

promise() [5/5]

google::cloud::promise< void >::promise ( promise< void > const &  )

delete

Member Function Documentation

get_future()

future<void> google::cloud::promise< void >::get_future ( )

inline

Creates the future<void> using the same shared state as *this.

Definition at line 183 of file future_void.h.

operator=() [1/2]

promise& google::cloud::promise< void >::operator= ( promise< void > &&  rhs )

inlinenoexcept

Abandons the shared state in *this, if any, and transfers the shared state from rhs.

Definition at line 157 of file future_void.h.

operator=() [2/2]

promise& google::cloud::promise< void >::operator= ( promise< void > const &  )

delete

set_value()

void google::cloud::promise< void >::set_value ( )

inline

Satisfies the shared state.

Exceptions

std::future_error	with std::future_errc::promise_already_satisfied if the shared state is already satisfied.
std::future_error	with std::no_state if the promise does not have a shared state.

Definition at line 196 of file future_void.h.

swap()

void google::cloud::promise< void >::swap ( promise< void > &  other )

inlinenoexcept

Swaps the shared state in *this with rhs.

Definition at line 176 of file future_void.h.