PLCnext API Documentation  22.9.0.33
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
Arp::System::Nm::Future< void > Class Reference

Future object as proxy for return value an asynchronous function call More...

#include <Future.hpp>

Inheritance diagram for Arp::System::Nm::Future< void >:
Inheritance graph

Public Member Functions

 Future ()
 Constructs an invalid Future More...
 
 Future (const Future &other)=default
 
 Future (Future &&other)=default
 
Futureoperator= (const Future &other)=default
 
Futureoperator= (Future &&other)=default
 
void GetValue () const
 Gets the void result of the asynchronous function call More...
 
- Public Member Functions inherited from Arp::System::Nm::FutureBase
 FutureBase (const FutureBase &other)=default
 
 FutureBase (FutureBase &&other) noexcept=default
 
FutureBaseoperator= (const FutureBase &other)=default
 
FutureBaseoperator= (FutureBase &&other) noexcept=default
 
const bool IsValid () const
 Returns true, if this Future has an assiciated Promise More...
 
const bool HasValue () const
 Returns true, if a value or an exception has been set More...
 
const bool HasException () const
 Returns true, if an exception has been set More...
 

Additional Inherited Members

- Protected Member Functions inherited from Arp::System::Nm::FutureBase
void CheckForValueAndException () const
 
template<typename ExceptionType >
void SetException (const ExceptionType &e)
 
void Clear (bool isValid)
 

Detailed Description

Future object as proxy for return value an asynchronous function call

Constructor & Destructor Documentation

◆ Future()

Constructs an invalid Future

The default contstructor is intended for Futures to be used as class members. Using copy or move constructors or assignments a class member can linked with a Promise.

Member Function Documentation

◆ GetValue()

void Arp::System::Nm::Future< void >::GetValue ( ) const

Gets the void result of the asynchronous function call

This function may throws an exception if the asynchronous funtion has not completed yet. Use HasValue() to check it. If an exception was set by the Promise the exception is rethrown here.


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