TECA
The Toolkit for Extreme Climate Analysis
owned_future< data_t > Struct Template Reference

a future that is owned by a single thread More...

#include <teca_owned_future.h>

Collaboration diagram for owned_future< data_t >:
[legend]

Public Member Functions

 owned_future (const owned_future &)=delete
 
void operator= (const owned_future &)=delete
 
 owned_future (owned_future &&other)
 move construct from another instance More...
 
 owned_future (std::future< data_t > &&future)
 move contruct from std::future More...
 
void operator= (owned_future &&other)
 move assign form anotehr instance More...
 
bool owner ()
 true if this future belongs to the calling thread More...
 
data_t & get ()
 access the managed future's data More...
 

Public Attributes

std::future< data_t > m_future
 the managed future More...
 
std::thread::id m_owner
 the thread id of the thread which created the future More...
 

Detailed Description

template<typename data_t>
struct owned_future< data_t >

a future that is owned by a single thread

Constructor & Destructor Documentation

◆ owned_future() [1/2]

template<typename data_t >
owned_future< data_t >::owned_future ( owned_future< data_t > &&  other)
inline

move construct from another instance

◆ owned_future() [2/2]

template<typename data_t >
owned_future< data_t >::owned_future ( std::future< data_t > &&  future)
inline

move contruct from std::future

Member Function Documentation

◆ get()

template<typename data_t >
data_t& owned_future< data_t >::get ( )
inline

access the managed future's data

◆ operator=()

template<typename data_t >
void owned_future< data_t >::operator= ( owned_future< data_t > &&  other)
inline

move assign form anotehr instance

◆ owner()

template<typename data_t >
bool owned_future< data_t >::owner ( )
inline

true if this future belongs to the calling thread

Member Data Documentation

◆ m_future

template<typename data_t >
std::future<data_t> owned_future< data_t >::m_future

the managed future

◆ m_owner

template<typename data_t >
std::thread::id owned_future< data_t >::m_owner

the thread id of the thread which created the future


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