boost::threadpool::detail::future_impl< Result > Class Template Reference

#include <src/threadpool/boost/threadpool/detail/future.hpp>

Public Types
typedef Result const &	result_type
	Indicates the functor's result type. More...
typedef Result	future_result_type
	Indicates the future's result type. More...
typedef future_impl< future_result_type >	future_type

Public Member Functions
	future_impl ()
bool	ready () const volatile
void	wait () const volatile
bool	timed_wait (boost::xtime const &timestamp) const
result_type	operator() () const volatile
void	set_value (future_result_type const &r) volatile
bool	cancel () volatile
bool	is_cancelled () const volatile
void	set_execution_status (bool executing) volatile

Private Attributes
volatile bool	m_ready
volatile future_result_type	m_result
mutex	m_monitor
condition	m_condition_ready
volatile bool	m_is_cancelled
volatile bool	m_executing

Detailed Description

template<class Result>
class boost::threadpool::detail::future_impl< Result >

Definition at line 36 of file future.hpp.

Member Typedef Documentation

template<class Result >

typedef Result boost::threadpool::detail::future_impl< Result >::future_result_type

Indicates the future's result type.

Definition at line 41 of file future.hpp.

template<class Result >

typedef future_impl<future_result_type> boost::threadpool::detail::future_impl< Result >::future_type

Definition at line 42 of file future.hpp.

template<class Result >

typedef Result const& boost::threadpool::detail::future_impl< Result >::result_type

Indicates the functor's result type.

Definition at line 39 of file future.hpp.

Constructor & Destructor Documentation

template<class Result >

boost::threadpool::detail::future_impl< Result >::future_impl ( )

inline

Definition at line 59 of file future.hpp.

  : m_ready(false)
  , m_is_cancelled(false)
  {
  }

Member Function Documentation

template<class Result >

bool boost::threadpool::detail::future_impl< Result >::cancel ( ) volatile

inline

Definition at line 133 of file future.hpp.

   {
     if(!m_ready || m_executing)
     {
        m_is_cancelled = true;
        return true;
     }
     else
     {
       return false;
     }
   }

template<class Result >

bool boost::threadpool::detail::future_impl< Result >::is_cancelled ( ) const volatile

inline

Definition at line 147 of file future.hpp.

   {
     return m_is_cancelled;
   }

template<class Result >

result_type boost::threadpool::detail::future_impl< Result >::operator() ( void  ) const volatile

inline

Definition at line 96 of file future.hpp.

  {
    wait();
/*
    if( throw_exception_ != 0 )
    {
      throw_exception_( this );
    }
*/
 
    return *(const_cast<const future_result_type*>(&m_result));
  }

template<class Result >

bool boost::threadpool::detail::future_impl< Result >::ready ( ) const volatile

inline

Definition at line 65 of file future.hpp.

  {
    return m_ready; 
  }

template<class Result >

void boost::threadpool::detail::future_impl< Result >::set_execution_status ( bool  executing ) volatile

inline

Definition at line 153 of file future.hpp.

   {
     m_executing = executing;
   }

template<class Result >

void boost::threadpool::detail::future_impl< Result >::set_value ( future_result_type const &  r ) volatile

inline

Definition at line 110 of file future.hpp.

  {
    locking_ptr<future_type, mutex> lockedThis(*this, m_monitor);
    if(!m_ready && !m_is_cancelled)
    {
      lockedThis->m_result = r;
      lockedThis->m_ready = true;
      lockedThis->m_condition_ready.notify_all();
    }
  }

template<class Result >

bool boost::threadpool::detail::future_impl< Result >::timed_wait ( boost::xtime const &  timestamp ) const

inline

Definition at line 82 of file future.hpp.

  {
    const future_type* self = const_cast<const future_type*>(this);
    mutex::scoped_lock lock(self->m_monitor);

    while(!m_ready)
    {
      if(!self->m_condition_ready.timed_wait(lock, timestamp)) return false;
    }

    return true;
  }

template<class Result >

void boost::threadpool::detail::future_impl< Result >::wait ( ) const volatile

inline

Definition at line 70 of file future.hpp.

  {
    const future_type* self = const_cast<const future_type*>(this);
    mutex::scoped_lock lock(self->m_monitor);

    while(!m_ready)
    {
      self->m_condition_ready.wait(lock);
    }
  }

Member Data Documentation

template<class Result >

condition boost::threadpool::detail::future_impl< Result >::m_condition_ready

mutableprivate

Definition at line 49 of file future.hpp.

template<class Result >

volatile bool boost::threadpool::detail::future_impl< Result >::m_executing

private

Definition at line 52 of file future.hpp.

template<class Result >

volatile bool boost::threadpool::detail::future_impl< Result >::m_is_cancelled

private

Definition at line 51 of file future.hpp.

template<class Result >

mutex boost::threadpool::detail::future_impl< Result >::m_monitor

mutableprivate

Definition at line 48 of file future.hpp.

template<class Result >

volatile bool boost::threadpool::detail::future_impl< Result >::m_ready

private

Definition at line 45 of file future.hpp.

template<class Result >

volatile future_result_type boost::threadpool::detail::future_impl< Result >::m_result

private

Definition at line 46 of file future.hpp.

---

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

• GaudiMTTools/src/threadpool/boost/threadpool/detail/future.hpp