TAO_Condition< MUTEX > Class Template Reference

Same as to the ACE_Condition variable wrapper. More...

#include <Condition.h>

Collaboration diagram for TAO_Condition< MUTEX >:

[legend]List of all members.

Public Types
typedef MUTEX	LOCK
	Useful typedef.
Public Member Functions
	TAO_Condition (MUTEX &m)
	Initialize the condition variable.
	TAO_Condition (void)
	~TAO_Condition (void)
	Implicitly destroy the condition variable.
int	wait (const ACE_Time_Value *abstime)
int	wait (void)
	Block on condition.
int	wait (MUTEX &mutex, const ACE_Time_Value *abstime=0)
int	signal (void)
	Signal one waiting thread.
int	broadcast (void)
	Signal *all* waiting threads.
int	remove (void)
	Explicitly destroy the condition variable.
MUTEX *	mutex (void)
	Returns a reference to the underlying mutex_;.
Private Member Functions
void	operator= (const TAO_Condition< MUTEX > &)
	TAO_Condition (const TAO_Condition< MUTEX > &)
Private Attributes
MUTEX *	mutex_
	Reference to mutex lock.
int	delete_lock_
	A flag to indicate whether the lock needs to be deleted.
TAO_SYNCH_CONDITION *	cond_
	Condition variable.

---

Detailed Description

template<class MUTEX>
class TAO_Condition< MUTEX >

Same as to the ACE_Condition variable wrapper.

This class differs from ACE_Condition in that it uses a TAO_SYNCH_CONDITION instead of ACE_cond_t under the hood to provide blocking.

Definition at line 43 of file Condition.h.

---

Member Typedef Documentation

template<class MUTEX>

typedef MUTEX TAO_Condition< MUTEX >::LOCK

Useful typedef.

Definition at line 48 of file Condition.h.

---

Constructor & Destructor Documentation

template<class MUTEX>

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_Condition< MUTEX >::TAO_Condition

(

MUTEX &

m

)

Initialize the condition variable.

Definition at line 16 of file Condition.cpp.

References ACE_NEW, and TAO_SYNCH_CONDITION.

  : mutex_ (&m),
    delete_lock_ (0),
    cond_ (0)
{
  // @todo: Need to add the allocatore here..
  ACE_NEW (this->cond_,
           TAO_SYNCH_CONDITION (*this->mutex_));
}

template<class MUTEX>

TAO_Condition< MUTEX >::TAO_Condition

(

void

)

A default constructor. Since no lock is provided by the user, one will be created internally.

Definition at line 28 of file Condition.cpp.

References ACE_NEW, TAO_Condition< MUTEX >::delete_lock_, and TAO_SYNCH_CONDITION.

    : mutex_ (0),
      delete_lock_ (0),
      cond_ (0)

{
  // @todo: Need to add the allocatore here..

  ACE_NEW (this->mutex_,
           MUTEX);

  this->delete_lock_ = 1;

  ACE_NEW (this->cond_,
           TAO_SYNCH_CONDITION (*this->mutex_));
}

template<class MUTEX>

TAO_Condition< MUTEX >::~TAO_Condition

(

void

)

Implicitly destroy the condition variable.

Definition at line 47 of file Condition.cpp.

References ACE_ERROR, ACE_TEXT, TAO_Condition< MUTEX >::cond_, LM_ERROR, and TAO_Condition< MUTEX >::mutex_.

{
  if (this->remove () == -1)
    ACE_ERROR ((LM_ERROR,
                ACE_TEXT ("%p\n"),
                ACE_TEXT ("TAO_Condition::~TAO_Condition")));

  delete this->cond_;

  if (this->delete_lock_)
    delete this->mutex_;
}

template<class MUTEX>

TAO_Condition< MUTEX >::TAO_Condition

(

const TAO_Condition< MUTEX > &

)

[private]

---

Member Function Documentation

template<class MUTEX>

ACE_INLINE int TAO_Condition< MUTEX >::broadcast

(

void

)

Signal *all* waiting threads.

Definition at line 50 of file Condition.inl.

References TAO_Condition< MUTEX >::cond_.

Referenced by TAO::Transport_Cache_Manager::~Transport_Cache_Manager().

{
  return this->cond_->broadcast ();
}

template<class MUTEX>

ACE_INLINE MUTEX * TAO_Condition< MUTEX >::mutex

(

void

)

Returns a reference to the underlying mutex_;.

Definition at line 38 of file Condition.inl.

References TAO_Condition< MUTEX >::mutex_.

{
  return this->mutex_;
}

template<class MUTEX>

void TAO_Condition< MUTEX >::operator=

(

const TAO_Condition< MUTEX > &

)

[private]

template<class MUTEX>

ACE_INLINE int TAO_Condition< MUTEX >::remove

(

void

)

Explicitly destroy the condition variable.

Definition at line 32 of file Condition.inl.

References TAO_Condition< MUTEX >::cond_.

{
  return this->cond_->remove ();
}

template<class MUTEX>

ACE_INLINE int TAO_Condition< MUTEX >::signal

(

void

)

Signal one waiting thread.

Definition at line 44 of file Condition.inl.

References TAO_Condition< MUTEX >::cond_.

Referenced by TAO::Transport_Cache_Manager::is_wakeup_useful(), and TAO::Transport_Cache_Manager::make_idle_i().

{
  return this->cond_->signal ();
}

template<class MUTEX>

ACE_INLINE int TAO_Condition< MUTEX >::wait	(	MUTEX &	mutex,
		const ACE_Time_Value *	abstime = 0
	)

Block on condition or until absolute time-of-day has passed. If abstime == 0 use "blocking" wait() semantics on the <mutex> passed as a parameter (this is useful if you need to store the <Condition> in shared memory). Else, if <abstime> != 0 and the call times out before the condition is signaled <wait> returns -1 and sets errno to ETIME.

Definition at line 14 of file Condition.inl.

References TAO_Condition< MUTEX >::cond_.

{
  return this->cond_->wait (mutex,
                           abstime);
}

template<class MUTEX>

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE int TAO_Condition< MUTEX >::wait

(

void

)

Block on condition.

Definition at line 8 of file Condition.inl.

References TAO_Condition< MUTEX >::cond_.

Referenced by TAO_Condition< MUTEX >::wait().

{
  return this->cond_->wait ();
}

template<class MUTEX>

ACE_INLINE int TAO_Condition< MUTEX >::wait

(

const ACE_Time_Value *

abstime

)

Block on condition, or until absolute time-of-day has passed. If abstime == 0 use "blocking" <wait> semantics. Else, if <abstime> != 0 and the call times out before the condition is signaled <wait> returns -1 and sets errno to ETIME.

Definition at line 26 of file Condition.inl.

References TAO_Condition< MUTEX >::wait().

Referenced by TAO::Transport_Cache_Manager::wait_for_connection().

{
  return this->wait (*this->mutex_, abstime);
}

---

Member Data Documentation

template<class MUTEX>

TAO_SYNCH_CONDITION* TAO_Condition< MUTEX >::cond_ [private]

Condition variable.

Definition at line 105 of file Condition.h.

Referenced by TAO_Condition< MUTEX >::broadcast(), TAO_Condition< MUTEX >::remove(), TAO_Condition< MUTEX >::signal(), TAO_Condition< MUTEX >::wait(), and TAO_Condition< MUTEX >::~TAO_Condition().

template<class MUTEX>

int TAO_Condition< MUTEX >::delete_lock_ [private]

A flag to indicate whether the lock needs to be deleted.

Definition at line 102 of file Condition.h.

Referenced by TAO_Condition< MUTEX >::TAO_Condition().

template<class MUTEX>

MUTEX* TAO_Condition< MUTEX >::mutex_ [private]

Reference to mutex lock.

Definition at line 99 of file Condition.h.

Referenced by TAO_Condition< MUTEX >::mutex(), and TAO_Condition< MUTEX >::~TAO_Condition().

---

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

• Condition.h
• Condition.cpp
• Condition.inl

---