Sync::Future< T > Class Template Reference

#include <Future.h>

Collaboration diagram for Sync::Future< T >:

Public Member Functions
	Future ()
virtual	~Future ()
bool	Done ()
void	Cancel ()
void	Wait ()
bool	IsCanceled ()
virtual void	Set (const T &r)
virtual T	Get ()

Protected Member Functions
void	InternalWait ()
void	InternalSet (const T &r)

Protected Attributes
PthreadMutex	future_lock
PthreadCondition	future_cond
bool	done
bool	canceled
T	ret

Detailed Description

template<typename T>
class Sync::Future< T >

The basic idea with the future is an object which will provide a value at some time in the future.

Definition at line 37 of file Future.h.

Constructor & Destructor Documentation

template<typename T>

Sync::Future< T >::Future ( )

inline

Definition at line 39 of file Future.h.

: done(false), canceled(false), ret() {}

template<typename T>

virtual Sync::Future< T >::~Future ( )

inlinevirtual

Definition at line 40 of file Future.h.

{}

Member Function Documentation

template<typename T>

void Sync::Future< T >::Cancel ( )

inline

Definition at line 47 of file Future.h.

                      {
            AutoLock<PthreadMutex> al(future_lock);
            canceled = true;
            future_cond.Broadcast();
        }

template<typename T>

bool Sync::Future< T >::Done ( )

inline

Definition at line 42 of file Future.h.

                    {
            AutoLock<PthreadMutex> al(future_lock);
            return done || canceled;
        }

template<typename T>

virtual T Sync::Future< T >::Get ( )

inlinevirtual

Reimplemented in CPN::ConnectionServer::PendingConnection.

Definition at line 68 of file Future.h.

                        {
            AutoLock<PthreadMutex> al(future_lock);
            InternalWait();
            return ret;
        }

template<typename T>

void Sync::Future< T >::InternalSet ( const T &  r )

inlineprotected

Definition at line 79 of file Future.h.

Referenced by Sync::Future< int >::Set(), and Sync::Future< void >::Set().

                                     {
            ret = r;
            done = true;
            future_cond.Broadcast();
        }

Here is the caller graph for this function:

template<typename T>

void Sync::Future< T >::InternalWait ( )

inlineprotected

Definition at line 75 of file Future.h.

Referenced by Sync::Future< int >::Get(), Sync::Future< void >::Get(), Sync::Future< int >::Wait(), and Sync::Future< void >::Wait().

                            {
            while (!canceled && !done) { future_cond.Wait(future_lock); }
        }

Here is the caller graph for this function:

template<typename T>

bool Sync::Future< T >::IsCanceled ( )

inline

Definition at line 58 of file Future.h.

                          {
            AutoLock<PthreadMutex> al(future_lock);
            return canceled;
        }

template<typename T>

virtual void Sync::Future< T >::Set ( const T &  r )

inlinevirtual

Definition at line 63 of file Future.h.

                                     {
            AutoLock<PthreadMutex> al(future_lock);
            InternalSet(r);
        }

template<typename T>

void Sync::Future< T >::Wait ( )

inline

Definition at line 53 of file Future.h.

                    {
            AutoLock<PthreadMutex> al(future_lock);
            InternalWait();
        }

Member Data Documentation

template<typename T>

bool Sync::Future< T >::canceled

protected

Definition at line 88 of file Future.h.

Referenced by Sync::Future< int >::Cancel(), Sync::Future< void >::Cancel(), Sync::Future< int >::Done(), Sync::Future< void >::Done(), Sync::Future< int >::InternalWait(), Sync::Future< void >::InternalWait(), Sync::Future< int >::IsCanceled(), and Sync::Future< void >::IsCanceled().

template<typename T>

bool Sync::Future< T >::done

protected

Definition at line 87 of file Future.h.

Referenced by Sync::Future< int >::Done(), Sync::Future< void >::Done(), Sync::Future< int >::InternalSet(), Sync::Future< void >::InternalSet(), Sync::Future< int >::InternalWait(), and Sync::Future< void >::InternalWait().

template<typename T>

PthreadCondition Sync::Future< T >::future_cond

protected

Definition at line 86 of file Future.h.

Referenced by Sync::Future< int >::Cancel(), Sync::Future< void >::Cancel(), Sync::Future< int >::InternalSet(), Sync::Future< void >::InternalSet(), Sync::Future< int >::InternalWait(), and Sync::Future< void >::InternalWait().

template<typename T>

PthreadMutex Sync::Future< T >::future_lock

protected

Definition at line 85 of file Future.h.

Referenced by Sync::Future< int >::Cancel(), Sync::Future< void >::Cancel(), Sync::Future< int >::Done(), Sync::Future< void >::Done(), Sync::Future< int >::Get(), Sync::Future< void >::Get(), Sync::Future< int >::InternalWait(), Sync::Future< void >::InternalWait(), Sync::Future< int >::IsCanceled(), Sync::Future< void >::IsCanceled(), Sync::Future< int >::Set(), Sync::Future< void >::Set(), Sync::Future< int >::Wait(), and Sync::Future< void >::Wait().

template<typename T>

T Sync::Future< T >::ret

protected

Definition at line 89 of file Future.h.

Referenced by Sync::Future< int >::Get(), and Sync::Future< int >::InternalSet().

---

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

• include/cpn/threading/Future.h