WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
wpi::future< void > Class Template Referencefinal

Explicit specialization for future<void>. More...

#include <future.h>

Public Member Functions

 future () noexcept=default
 Constructs an empty (invalid) future.
 
 future (future &&oth) noexcept
 
 future (const future &)=delete
 
 ~future ()
 Ignores the result of the future if it has not been retrieved.
 
futureoperator= (future &&oth) noexcept
 
futureoperator= (const future &)=delete
 
void get ()
 Gets the value. More...
 
template<typename R , typename F >
future< R > then (PromiseFactory< R > &factory, F &&func)
 
template<typename F , typename R = typename std::result_of<F && ()>::type>
future< R > then (F &&func)
 
bool is_ready () const noexcept
 
bool valid () const noexcept
 Checks if the future is valid. More...
 
void wait () const
 Waits for the promise to provide a value. More...
 
template<class Clock , class Duration >
bool wait_until (const std::chrono::time_point< Clock, Duration > &timeout_time) const
 Waits for the promise to provide a value, or the specified time has been reached. More...
 
template<class Rep , class Period >
bool wait_for (const std::chrono::duration< Rep, Period > &timeout_duration) const
 Waits for the promise to provide a value, or the specified amount of time has elapsed. More...
 

Friends

class PromiseFactory< void >
 
class promise< void >
 

Detailed Description

template<>
class wpi::future< void >

Explicit specialization for future<void>.

Member Function Documentation

void wpi::future< void >::get ( )
inline

Gets the value.

Calls wait() if the value is not yet available. Can only be called once. The future will be marked invalid after the call.

bool wpi::future< void >::valid ( ) const
inlinenoexcept

Checks if the future is valid.

A default-constructed future or one where get() has been called is invalid.

Returns
True if valid
void wpi::future< void >::wait ( ) const
inline

Waits for the promise to provide a value.

Does not return until the value is available or the promise is destroyed If the value has already been provided, returns immediately.

template<class Rep , class Period >
bool wpi::future< void >::wait_for ( const std::chrono::duration< Rep, Period > &  timeout_duration) const
inline

Waits for the promise to provide a value, or the specified amount of time has elapsed.

Returns
True if the promise provided a value, false if timed out.
template<class Clock , class Duration >
bool wpi::future< void >::wait_until ( const std::chrono::time_point< Clock, Duration > &  timeout_time) const
inline

Waits for the promise to provide a value, or the specified time has been reached.

Returns
True if the promise provided a value, false if timed out.

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