Scopira  20080306
scopira::tool::event_ptr< T > Class Template Reference

#include <thread_pthreads.h>

Inheritance diagram for scopira::tool::event_ptr< T >:
scopira::tool::locker_ptr< T > scopira::tool::locker_ptr< T > scopira::tool::area_ptr< T > scopira::tool::area_ptr< T > scopira::tool::area_ptr< T > scopira::tool::area_ptr< T >

Public Member Functions

 event_ptr (const event_area< T > &ref)
 ctor
 
void notify (void)
 
void notify_all (void)
 
void wait (void)
 
bool wait (int msec)
 
 event_ptr (const event_area< T > &ref)
 ctor
 
void notify (void)
 
void notify_all (void)
 
void wait (void)
 
bool wait (int msec)
 
- Public Member Functions inherited from scopira::tool::locker_ptr< T >
 locker_ptr (const shared_area< T > &ref)
 ctor
 
 ~locker_ptr ()
 dtor
 
 locker_ptr (const shared_area< T > &ref)
 ctor
 
 ~locker_ptr ()
 dtor
 
- Public Member Functions inherited from scopira::tool::area_ptr< T >
 area_ptr (const shared_area< T > &ref)
 
 area_ptr (const rw_area< T > &ref)
 
T * get (void)
 members
 
T & operator* (void)
 pointer behaviour
 
T * operator-> (void)
 pointer behaviour
 
void reset (void)
 
 area_ptr (const shared_area< T > &ref)
 
 area_ptr (const rw_area< T > &ref)
 
T * get (void)
 members
 
T & operator* (void)
 pointer behaviour
 
T * operator-> (void)
 pointer behaviour
 
void reset (void)
 

Protected Attributes

scopira::tool::conditiondm_cond
 
- Protected Attributes inherited from scopira::tool::locker_ptr< T >
scopira::tool::mutexdm_mut
 
- Protected Attributes inherited from scopira::tool::area_ptr< T >
T * dm_ptr
 

Additional Inherited Members

- Protected Member Functions inherited from scopira::tool::area_ptr< T >
 area_ptr (const volatile T &ref)
 
 area_ptr (const volatile T &ref)
 

Detailed Description

template<class T>
class scopira::tool::event_ptr< T >

This ptr builds on locker_ptr and adds condition aware helper methods.

Author
Aleksander Demko

Member Function Documentation

◆ notify() [1/2]

template<class T>
void scopira::tool::event_ptr< T >::notify ( void  )
inline

Reflects the call back to the pm_condition.

Remember, you can also call notify from outside the mutex lock region.

Author
Aleksander Demko

References scopira::tool::condition::notify().

◆ notify() [2/2]

template<class T>
void scopira::tool::event_ptr< T >::notify ( void  )
inline

Reflects the call back to the pm_condition.

Remember, you can also call notify from outside the mutex lock region.

Author
Aleksander Demko

References scopira::tool::condition::notify().

◆ notify_all() [1/2]

template<class T>
void scopira::tool::event_ptr< T >::notify_all ( void  )
inline

Reflects the call back to the pm_condition.

Remember, you can also call notify from outside the mutex lock region.

Author
Aleksander Demko

References scopira::tool::condition::notify_all().

◆ notify_all() [2/2]

template<class T>
void scopira::tool::event_ptr< T >::notify_all ( void  )
inline

Reflects the call back to the pm_condition.

Remember, you can also call notify from outside the mutex lock region.

Author
Aleksander Demko

References scopira::tool::condition::notify_all().

◆ wait() [1/4]

template<class T>
void scopira::tool::event_ptr< T >::wait ( void  )
inline

Reflector.

Calls wait() on the contained pm_condition with its matching pm_mutex.

Author
Aleksander Demko

References scopira::tool::condition::wait().

◆ wait() [2/4]

template<class T>
void scopira::tool::event_ptr< T >::wait ( void  )
inline

Reflector.

Calls wait() on the contained pm_condition with its matching pm_mutex.

Author
Aleksander Demko

References scopira::tool::condition::wait().

◆ wait() [3/4]

template<class T>
bool scopira::tool::event_ptr< T >::wait ( int  msec)
inline

Reflector.

Calls wait() on the contained pm_condition with its matching pm_mutex.

Returns
true if timed out, false if got a notification event
Author
Aleksander Demko

References scopira::tool::condition::wait().

◆ wait() [4/4]

template<class T>
bool scopira::tool::event_ptr< T >::wait ( int  msec)
inline

Reflector.

Calls wait() on the contained pm_condition with its matching pm_mutex.

Returns
true if timed out, false if got a notification event
Author
Aleksander Demko

References scopira::tool::condition::wait().


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