CesiumAsync::Promise< void > Class Reference

Specialization for promises that resolve to no value. More...

#include <CesiumAsync/Promise.h>

Public Member Functions
void	resolve () const
	Will be called when the task completed successfully.
template<typename TException>
void	reject (TException error) const
	Will be called when the task failed.
void	reject (const std::exception_ptr &error) const
	Will be called when the task failed.
Future< void >	getFuture () const
	Gets the Future that resolves or rejects when this Promise is resolved or rejected.
void	resolve (void &&value) const
	Will be called when the task completed successfully.
void	resolve (const void &value) const
	Will be called when the task completed successfully.
void	reject (TException error) const
	Will be called when the task failed.
void	reject (const std::exception_ptr &error) const
	Will be called when the task failed.
Future< void >	getFuture () const
	Gets the Future that resolves or rejects when this Promise is resolved or rejected.

Friends
class	AsyncSystem
class	AsyncSystem

Detailed Description

Specialization for promises that resolve to no value.

Definition at line 81 of file Promise.h.

Member Function Documentation

getFuture() [1/2]

Future< void > CesiumAsync::Promise< void >::getFuture ( ) const

inline

Gets the Future that resolves or rejects when this Promise is resolved or rejected.

This method may only be called once.

Returns

The future.

Definition at line 62 of file Promise.h.

getFuture() [2/2]

Future< void > CesiumAsync::Promise< void >::getFuture ( ) const

inline

Gets the Future that resolves or rejects when this Promise is resolved or rejected.

This method may only be called once.

Returns

The future.

Definition at line 109 of file Promise.h.

reject() [1/4]

void CesiumAsync::Promise< void >::reject ( const std::exception_ptr & error ) const

inline

Will be called when the task failed.

Parameters

error

The error, captured with std::current_exception, that caused the task to fail.

Definition at line 50 of file Promise.h.

reject() [2/4]

void CesiumAsync::Promise< void >::reject ( const std::exception_ptr & error ) const

inline

Will be called when the task failed.

Parameters

error

The error, captured with std::current_exception, that caused the task to fail.

Definition at line 103 of file Promise.h.

reject() [3/4]

void CesiumAsync::Promise< void >::reject ( TException error ) const

inline

Will be called when the task failed.

Parameters

error

The error that caused the task to fail.

Definition at line 40 of file Promise.h.

reject() [4/4]

template<typename TException>

void CesiumAsync::Promise< void >::reject ( TException error ) const

inline

Will be called when the task failed.

Parameters

error

The error that caused the task to fail.

Definition at line 93 of file Promise.h.

resolve() [1/3]

void CesiumAsync::Promise< void >::resolve ( ) const

inline

Will be called when the task completed successfully.

Definition at line 86 of file Promise.h.

resolve() [2/3]

void CesiumAsync::Promise< void >::resolve ( const void & value ) const

inline

Will be called when the task completed successfully.

Parameters

value

The value that was computed by the asynchronous task.

Definition at line 33 of file Promise.h.

resolve() [3/3]

void CesiumAsync::Promise< void >::resolve ( void && value ) const

inline

Will be called when the task completed successfully.

Parameters

value

The value that was computed by the asynchronous task.

Definition at line 26 of file Promise.h.

Friends And Related Symbol Documentation

AsyncSystem [1/2]

friend class AsyncSystem

friend

Definition at line 75 of file Promise.h.

AsyncSystem [2/2]

friend class AsyncSystem

friend

Definition at line 122 of file Promise.h.

---

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

• /home/runner/work/cesium-native/cesium-native/CesiumAsync/include/CesiumAsync/Promise.h