FutureBase Class Reference

#include <OnixS/FIXEngine/Threading/Future.h>

Classes
struct	moving_init_t

Public Types
enum

Public Member Functions
bool	valid () const noexcept
ONIXS_FIXENGINE_API bool	isReady () const
ONIXS_FIXENGINE_API bool	hasValue () const
ONIXS_FIXENGINE_API bool	hasException () const
ONIXS_FIXENGINE_API std::exception_ptr	getExceptionPtr () const
ONIXS_FIXENGINE_API FutureStatus::Enum	wait (int timeoutInMs=InfiniteTimeout) const

Protected Member Functions
	FutureBase ()
ONIXS_FIXENGINE_API	FutureBase (const FutureBase &other) noexcept
ONIXS_FIXENGINE_API FutureBase &	operator= (const FutureBase &other) noexcept
ONIXS_FIXENGINE_API	FutureBase (FutureBase &&other) noexcept
ONIXS_FIXENGINE_API FutureBase &	operator= (FutureBase &&other) noexcept
ONIXS_FIXENGINE_API	FutureBase (const System::FutureSharedState *state) noexcept
ONIXS_FIXENGINE_API	FutureBase (const System::FutureSharedState *state, moving_init_t) noexcept
ONIXS_FIXENGINE_API	~FutureBase () noexcept
ONIXS_FIXENGINE_API void	swap (FutureBase &other) noexcept
ONIXS_FIXENGINE_API const FutureValue &	getValue () const
ONIXS_FIXENGINE_API void	getVoid () const

Friends
class	FutureHelper
class	PromiseBase

Detailed Description

Definition at line 115 of file Future.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
InfiniteTimeout	-1

Definition at line 156 of file Future.h.

Constructor & Destructor Documentation

FutureBase() [1/5]

FutureBase ( )

inlineprotected

Definition at line 167 of file Future.h.

FutureBase() [2/5]

ONIXS_FIXENGINE_API FutureBase ( const FutureBase & other )

protectednoexcept

FutureBase() [3/5]

ONIXS_FIXENGINE_API FutureBase ( FutureBase && other )

protectednoexcept

FutureBase() [4/5]

ONIXS_FIXENGINE_API FutureBase ( const System::FutureSharedState * state )

protectednoexcept

Initializes the instance with shared state.

FutureBase() [5/5]

ONIXS_FIXENGINE_API FutureBase ( const System::FutureSharedState * state, moving_init_t  )

protectednoexcept

Initializes the instance with shared state.

~FutureBase()

ONIXS_FIXENGINE_API ~FutureBase ( )

protectednoexcept

Destroys a future object.

If this is the last reference to the asynchronous result associated with *this (if any), then destroy that asynchronous result.

Member Function Documentation

getExceptionPtr()

ONIXS_FIXENGINE_API std::exception_ptr getExceptionPtr

(

)

const

Returns the stored exception.

Exceptions

The	std::logic_error if this instance does not refer to a shared state.
The	std::logic_error if the operation has not finished with an error.

getValue()

ONIXS_FIXENGINE_API const FutureValue & getValue ( ) const

protected

getVoid()

ONIXS_FIXENGINE_API void getVoid ( ) const

protected

hasException()

ONIXS_FIXENGINE_API bool hasException

(

)

const

Returns true if the asynchronous result associated with this Future has a stored exception, false otherwise.

Exceptions

The	std::logic_error if this instance does not refer to a shared state.

hasValue()

ONIXS_FIXENGINE_API bool hasValue

(

)

const

Returns true if the asynchronous result associated with this Future has a stored value, false otherwise.

Exceptions

The	std::logic_error if this instance does not refer to a shared state.

isReady()

ONIXS_FIXENGINE_API bool isReady

(

)

const

Returns true if the asynchronous result associated with this Future is ready (has a value or an exception stored in the shared state), false otherwise.

There are often situations where a get() call on a Future may not be a blocking call, or is only a blocking call under certain circumstances. This method gives the ability to test for early completion and allows us to avoid associating a continuation, which needs to be scheduled with some non-trivial overhead and near-certain loss of the cache efficiency.

Exceptions

The	std::logic_error if this instance does not refer to a shared state.

operator=() [1/2]

ONIXS_FIXENGINE_API FutureBase & operator= ( const FutureBase & other )

protectednoexcept

operator=() [2/2]

ONIXS_FIXENGINE_API FutureBase & operator= ( FutureBase && other )

protectednoexcept

swap()

ONIXS_FIXENGINE_API void swap ( FutureBase & other )

protectednoexcept

valid()

bool valid ( ) const

inlinenoexcept

Check if a future instance is associated with an asynchronous result.

Returns true if the *this has an associated asynchronous result, false otherwise.

Definition at line 121 of file Future.h.

wait()

ONIXS_FIXENGINE_API FutureStatus::Enum wait

(

int

timeoutInMs = InfiniteTimeout

)

const

Waits for the result to become available during the timeout.

Note

Calling wait on the same Future from multiple threads is not safe; the intended use is for each thread that waits on the same shared state to have a copy of a Future.

Exceptions

The	std::logic_error if this instance does not refer to a shared state.

Friends And Related Symbol Documentation

FutureHelper

friend class FutureHelper

friend

Definition at line 200 of file Future.h.

PromiseBase

friend class PromiseBase

friend

Definition at line 201 of file Future.h.