fc::promise< void > Class Reference

#include <future.hpp>

Inheritance diagram for fc::promise< void >:

Public Types
typedef std::shared_ptr< promise< void > >	ptr
Public Types inherited from fc::promise_base
typedef std::shared_ptr< promise_base >	ptr

Public Member Functions
virtual	~promise ()
void	wait (const microseconds &timeout=microseconds::maximum())
void	wait_until (const time_point &tp)
void	set_value ()
void	set_value (const void_t &)
template<typename CompletionHandler >
void	on_complete (CompletionHandler &&c)
Public Member Functions inherited from fc::promise_base
virtual	~promise_base ()
const char *	get_desc () const
virtual void	cancel (const char *reason FC_CANCELATION_REASON_DEFAULT_ARG)
bool	canceled () const
bool	ready () const
bool	error () const
void	set_exception (const fc::exception_ptr &e)

Static Public Member Functions
static ptr	create (const char *desc FC_TASK_NAME_DEFAULT_ARG)
static ptr	create (bool fulfilled, const char *desc FC_TASK_NAME_DEFAULT_ARG)

Protected Member Functions
	promise (const char *desc)
	promise (bool fulfilled, const char *desc)
Protected Member Functions inherited from fc::promise_base
	promise_base (const char *desc FC_TASK_NAME_DEFAULT_ARG)
void	_wait (const microseconds &timeout_us)
void	_wait_until (const time_point &timeout_us)
void	_notify ()
void	_set_value (const void *v)
void	_on_complete (detail::completion_handler *c)

Additional Inherited Members
Protected Attributes inherited from fc::promise_base
const char *	_cancellation_reason

Detailed Description

Definition at line 159 of file future.hpp.

Member Typedef Documentation

ptr

typedef std::shared_ptr< promise<void> > fc::promise< void >::ptr

Definition at line 161 of file future.hpp.

Constructor & Destructor Documentation

~promise()

virtual fc::promise< void >::~promise ( )

inlinevirtual

Definition at line 163 of file future.hpp.

promise() [1/2]

fc::promise< void >::promise ( const char *  desc )

inlineprotected

Definition at line 189 of file future.hpp.

promise() [2/2]

fc::promise< void >::promise ( bool  fulfilled, const char *  desc  )

inlineprotected

Definition at line 190 of file future.hpp.

Member Function Documentation

create() [1/2]

static ptr fc::promise< void >::create ( bool  fulfilled, const char *desc  FC_TASK_NAME_DEFAULT_ARG  )

inlinestatic

Definition at line 169 of file future.hpp.

create() [2/2]

static ptr fc::promise< void >::create ( const char *desc  FC_TASK_NAME_DEFAULT_ARG )

inlinestatic

Definition at line 165 of file future.hpp.

on_complete()

template<typename CompletionHandler >

void fc::promise< void >::on_complete ( CompletionHandler &&  c )

inline

Definition at line 185 of file future.hpp.

set_value() [1/2]

void fc::promise< void >::set_value ( )

inline

Definition at line 181 of file future.hpp.

set_value() [2/2]

void fc::promise< void >::set_value ( const void_t &  )

inline

Definition at line 182 of file future.hpp.

wait()

void fc::promise< void >::wait ( const microseconds &  timeout = microseconds::maximum() )

inline

Definition at line 174 of file future.hpp.

wait_until()

void fc::promise< void >::wait_until ( const time_point &  tp )

inline

Definition at line 177 of file future.hpp.

---

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

• libraries/fc/include/fc/thread/future.hpp