OnixS C++ FIX Engine 4.13.0
API Documentation
Loading...
Searching...
No Matches
Promise< void > Class Reference

Public Member Functions

 Promise () ONIXS_FIXENGINE_NOTHROW
 Promise (const Promise< void > &other) ONIXS_FIXENGINE_NOTHROW
Promise< void > & operator= (const Promise< void > &other) ONIXS_FIXENGINE_NOTHROW
void swap (Promise< void > &other) ONIXS_FIXENGINE_NOTHROW
SharedFuture< void > getFuture () const
void set ()
template<typename ExceptionType>
void setException (const ExceptionType &exception)
Public Member Functions inherited from PromiseBase
bool valid ()
ONIXS_FIXENGINE_API void setExceptionImpl ()

Additional Inherited Members

Protected Member Functions inherited from PromiseBase
ONIXS_FIXENGINE_API PromiseBase () ONIXS_FIXENGINE_NOTHROW
ONIXS_FIXENGINE_API PromiseBase (const PromiseBase &other) ONIXS_FIXENGINE_NOTHROW
ONIXS_FIXENGINE_API PromiseBaseoperator= (const PromiseBase &other) ONIXS_FIXENGINE_NOTHROW
ONIXS_FIXENGINE_API ~PromiseBase () ONIXS_FIXENGINE_NOTHROW
ONIXS_FIXENGINE_API void swap (PromiseBase &other) ONIXS_FIXENGINE_NOTHROW
ONIXS_FIXENGINE_API void setValue (ValueBase *value)
ONIXS_FIXENGINE_API void setVoid ()
ONIXS_FIXENGINE_API SharedFuture< FutureValuegetFutureImpl () const
template<typename T>
SharedFuture< T > getTypedFuture () const

Detailed Description

Definition at line 445 of file Future.h.

Constructor & Destructor Documentation

◆ Promise() [1/2]

Promise ( )
inline

Definition at line 449 of file Future.h.

◆ Promise() [2/2]

Promise ( const Promise< void > & other)
inline

The copy constructor.

Definition at line 453 of file Future.h.

Member Function Documentation

◆ getFuture()

SharedFuture< void > getFuture ( ) const
inline

Definition at line 482 of file Future.h.

◆ operator=()

Promise< void > & operator= ( const Promise< void > & other)
inline

The copy assignment.

Definition at line 457 of file Future.h.

◆ set()

void set ( )
inline

Sets the successful result to the given shared state.

Definition at line 488 of file Future.h.

◆ setException()

template<typename ExceptionType>
void setException ( const ExceptionType & exception)
inline

Sets the result to indicate an exception.

Note
Does nothing if the shared state already stores a value or exception.

Definition at line 497 of file Future.h.

◆ swap()

void swap ( Promise< void > & other)
inline

Swaps two Promise objects.

Definition at line 477 of file Future.h.