Public Member Functions | Private Member Functions | Private Attributes | List of all members
coil::Condition< Mutex > Class Template Reference

Condition template class. More...

#include <Condition.h>

Public Member Functions

void broadcast ()
 
void broadcast ()
 Resume of all the thread practice. More...
 
void broadcast ()
 Resume of all the thread practice. More...
 
 Condition (Mutex &mutex)
 
 Condition (M &mutex)
 Constructor. More...
 
 Condition (M &mutex)
 Constructor. More...
 
void signal ()
 
void signal ()
 Resume of the thread practice. More...
 
void signal ()
 Resume of the thread practice. More...
 
bool wait ()
 
bool wait (long second, long nano_second=0)
 
bool wait ()
 Wait of the thread practice. More...
 
bool wait (long second, long nano_second=0)
 Thread practice wait of set time. More...
 
bool wait ()
 Wait of the thread practice. More...
 
bool wait (long second, long nano_second=0)
 Thread practice wait of set time. More...
 
 ~Condition ()
 
 ~Condition ()
 Destructor. More...
 
 ~Condition ()
 Destructor. More...
 

Private Member Functions

 Condition (const Mutex &)
 
 Condition (const M &)
 
 Condition (const Mutex &)
 
Conditionoperator= (const Mutex &)
 
Conditionoperator= (const M &)
 
Conditionoperator= (const Mutex &)
 
int pthread_cond_broadcast (pthread_cond_t *cv)
 Resume of all the thread practice. More...
 
int pthread_cond_signal (pthread_cond_t *cv)
 Resume of the thread practice. More...
 
int pthread_cond_wait (coil::pthread_cond_t *cv, coil::Mutex *external_mutex, DWORD aMilliSecond)
 Wait of the thread practice. More...
 

Private Attributes

ACE_cond_t m_cond
 
pthread_cond_t m_cond
 
coil::pthread_cond_t m_cond
 
Mutexm_mutex
 
M & m_mutex
 

Detailed Description

template<class Mutex>
class coil::Condition< Mutex >

Condition template class.

Definition at line 39 of file ace/coil/Condition.h.

Constructor & Destructor Documentation

◆ Condition() [1/6]

template<class Mutex>
coil::Condition< Mutex >::Condition ( Mutex mutex)
inline

Definition at line 42 of file ace/coil/Condition.h.

◆ ~Condition() [1/3]

template<class Mutex>
coil::Condition< Mutex >::~Condition ( )
inline

Definition at line 48 of file ace/coil/Condition.h.

◆ Condition() [2/6]

template<class Mutex>
coil::Condition< Mutex >::Condition ( const Mutex )
private

◆ Condition() [3/6]

template<class Mutex>
coil::Condition< Mutex >::Condition ( M &  mutex)
inline

Constructor.

Constructor

Definition at line 63 of file posix/coil/Condition.h.

◆ ~Condition() [2/3]

template<class Mutex>
coil::Condition< Mutex >::~Condition ( )
inline

Destructor.

Destructor

Definition at line 84 of file posix/coil/Condition.h.

◆ Condition() [4/6]

template<class Mutex>
coil::Condition< Mutex >::Condition ( const M &  )
private

◆ Condition() [5/6]

template<class Mutex>
coil::Condition< Mutex >::Condition ( M &  mutex)
inline

Constructor.

Constructor

Definition at line 102 of file win32/coil/Condition.h.

◆ ~Condition() [3/3]

template<class Mutex>
coil::Condition< Mutex >::~Condition ( )
inline

Destructor.

Destructor

Definition at line 123 of file win32/coil/Condition.h.

◆ Condition() [6/6]

template<class Mutex>
coil::Condition< Mutex >::Condition ( const Mutex )
private

Member Function Documentation

◆ broadcast() [1/3]

template<class Mutex>
void coil::Condition< Mutex >::broadcast ( )
inline

Definition at line 59 of file ace/coil/Condition.h.

◆ broadcast() [2/3]

template<class Mutex>
void coil::Condition< Mutex >::broadcast ( )
inline

Resume of all the thread practice.

Let all waiting thread practice resume.

Definition at line 124 of file posix/coil/Condition.h.

◆ broadcast() [3/3]

template<class Mutex>
void coil::Condition< Mutex >::broadcast ( )
inline

Resume of all the thread practice.

Let all waiting thread practice resume.

Definition at line 162 of file win32/coil/Condition.h.

◆ operator=() [1/3]

template<class Mutex>
Condition& coil::Condition< Mutex >::operator= ( const Mutex )
private

◆ operator=() [2/3]

template<class Mutex>
Condition& coil::Condition< Mutex >::operator= ( const M &  )
private

◆ operator=() [3/3]

template<class Mutex>
Condition& coil::Condition< Mutex >::operator= ( const Mutex )
private

◆ pthread_cond_broadcast()

template<class Mutex>
int coil::Condition< Mutex >::pthread_cond_broadcast ( pthread_cond_t cv)
inlineprivate

Resume of all the thread practice.

Let all waiting thread practice resume.

Returns
If it is 0 succeed.

Definition at line 356 of file win32/coil/Condition.h.

◆ pthread_cond_signal()

template<class Mutex>
int coil::Condition< Mutex >::pthread_cond_signal ( pthread_cond_t cv)
inlineprivate

Resume of the thread practice.

Let the practice of a waiting thread resume.

Returns
If it is 0 succeed.

Definition at line 323 of file win32/coil/Condition.h.

◆ pthread_cond_wait()

template<class Mutex>
int coil::Condition< Mutex >::pthread_cond_wait ( coil::pthread_cond_t cv,
coil::Mutex external_mutex,
DWORD  aMilliSecond 
)
inlineprivate

Wait of the thread practice.

Stop the practice of the thread till become the signal state.

Returns
If it is 0 succeed, other is fail.

Definition at line 243 of file win32/coil/Condition.h.

◆ signal() [1/3]

template<class Mutex>
void coil::Condition< Mutex >::signal ( )
inline

Definition at line 53 of file ace/coil/Condition.h.

◆ signal() [2/3]

template<class Mutex>
void coil::Condition< Mutex >::signal ( void  )
inline

Resume of the thread practice.

Let the practice of a waiting thread resume.

Definition at line 104 of file posix/coil/Condition.h.

◆ signal() [3/3]

template<class Mutex>
void coil::Condition< Mutex >::signal ( void  )
inline

Resume of the thread practice.

Let the practice of a waiting thread resume.

Definition at line 142 of file win32/coil/Condition.h.

◆ wait() [1/6]

template<class Mutex>
bool coil::Condition< Mutex >::wait ( )
inline

Definition at line 65 of file ace/coil/Condition.h.

◆ wait() [2/6]

template<class Mutex>
bool coil::Condition< Mutex >::wait ( long  second,
long  nano_second = 0 
)
inline

Definition at line 71 of file ace/coil/Condition.h.

◆ wait() [3/6]

template<class Mutex>
bool coil::Condition< Mutex >::wait ( )
inline

Wait of the thread practice.

Stop the practice of the thread till a condition variable is transmitted.

Returns
true: successful, false: failed

Definition at line 148 of file posix/coil/Condition.h.

◆ wait() [4/6]

template<class Mutex>
bool coil::Condition< Mutex >::wait ( long  second,
long  nano_second = 0 
)
inline

Thread practice wait of set time.

In set time, stop the practice of the thread.

Parameters
secondTime of the seconds.
nano_secondtime of the nanoseconds.
Returns
true: successful, false: failed

Definition at line 178 of file posix/coil/Condition.h.

◆ wait() [5/6]

template<class Mutex>
bool coil::Condition< Mutex >::wait ( void  )
inline

Wait of the thread practice.

Stop the practice of the thread till a condition variable is transmitted.

Returns
true: successful, false: failed

Definition at line 186 of file win32/coil/Condition.h.

◆ wait() [6/6]

template<class Mutex>
bool coil::Condition< Mutex >::wait ( long  second,
long  nano_second = 0 
)
inline

Thread practice wait of set time.

In set time, stop the practice of the thread.

Parameters
secondTime of the seconds.
nano_secondtime of the nanoseconds.
Returns
true: successful, false: failed

Definition at line 216 of file win32/coil/Condition.h.

Member Data Documentation

◆ m_cond [1/3]

template<class Mutex>
ACE_cond_t coil::Condition< Mutex >::m_cond
private

Definition at line 84 of file ace/coil/Condition.h.

◆ m_cond [2/3]

template<class Mutex>
pthread_cond_t coil::Condition< Mutex >::m_cond
private

Definition at line 196 of file posix/coil/Condition.h.

◆ m_cond [3/3]

template<class Mutex>
coil::pthread_cond_t coil::Condition< Mutex >::m_cond
private

Definition at line 393 of file win32/coil/Condition.h.

◆ m_mutex [1/2]

template<class Mutex>
M & coil::Condition< Mutex >::m_mutex
private

Definition at line 85 of file ace/coil/Condition.h.

◆ m_mutex [2/2]

template<class Mutex>
M& coil::Condition< Mutex >::m_mutex
private

Definition at line 197 of file posix/coil/Condition.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:46