Botan 3.14.1
Crypto and TLS for C&
Botan::Joining_Future< T > Class Template Referencefinal

#include <thread_pool.h>

Public Member Functions

decltype(auto) get ()
 Joining_Future (const Joining_Future &)=delete
 Joining_Future (Joining_Future &&) noexcept=default
 Joining_Future (std::future< T > future)
Joining_Future & operator= (const Joining_Future &)=delete
Joining_Future & operator= (Joining_Future &&other) noexcept
bool valid () const noexcept
void wait () const
 ~Joining_Future ()

Detailed Description

template<typename T>
class Botan::Joining_Future< T >

A future which waits for its work to finish when destroyed, so that work referencing the enclosing frame cannot outlive it

Definition at line 27 of file thread_pool.h.

Constructor & Destructor Documentation

◆ Joining_Future() [1/3]

template<typename T>
Botan::Joining_Future< T >::Joining_Future ( std::future< T > future)
inlineexplicit

Definition at line 29 of file thread_pool.h.

Referenced by Joining_Future(), Joining_Future(), operator=(), and operator=().

◆ ~Joining_Future()

template<typename T>
Botan::Joining_Future< T >::~Joining_Future ( )
inline

Definition at line 31 of file thread_pool.h.

31 {
32 if(m_future.valid()) {
33 m_future.wait();
34 }
35 }

◆ Joining_Future() [2/3]

template<typename T>
Botan::Joining_Future< T >::Joining_Future ( const Joining_Future< T > & )
delete

References Joining_Future().

◆ Joining_Future() [3/3]

template<typename T>
Botan::Joining_Future< T >::Joining_Future ( Joining_Future< T > && )
defaultnoexcept

References Joining_Future().

Member Function Documentation

◆ get()

template<typename T>
decltype(auto) Botan::Joining_Future< T >::get ( )
inline

Definition at line 52 of file thread_pool.h.

52{ return m_future.get(); }

◆ operator=() [1/2]

template<typename T>
Joining_Future & Botan::Joining_Future< T >::operator= ( const Joining_Future< T > & )
delete

References Joining_Future().

◆ operator=() [2/2]

template<typename T>
Joining_Future & Botan::Joining_Future< T >::operator= ( Joining_Future< T > && other)
inlinenoexcept

Definition at line 42 of file thread_pool.h.

42 {
43 if(this != &other) {
44 if(m_future.valid()) {
45 m_future.wait();
46 }
47 m_future = std::move(other.m_future);
48 }
49 return *this;
50 }

References Joining_Future().

◆ valid()

template<typename T>
bool Botan::Joining_Future< T >::valid ( ) const
inlinenoexcept

Definition at line 56 of file thread_pool.h.

56{ return m_future.valid(); }

◆ wait()

template<typename T>
void Botan::Joining_Future< T >::wait ( ) const
inline

Definition at line 54 of file thread_pool.h.

54{ m_future.wait(); }

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