#include <ConditionVariable.h>

Collaboration diagram for OpenDDS::DCPS::ConditionVariable< Mutex >:

Public Member Functions
	ConditionVariable (Mutex &mutex)

CvStatus	wait (ThreadStatusManager &thread_status_manager)
	Block until thread is woken up. More...

CvStatus	wait_until (const MonotonicTimePoint &expire_at, ThreadStatusManager &thread_status_manager)
	Block until woken up or until expire_at. Same as wait() if expire_at is zero. More...

CvStatus	wait_for (const TimeDuration &expire_in, ThreadStatusManager &thread_status_manager)
	Block until woken up or for expire_in. Same as wait() if expire_in is zero. More...

bool	notify_one ()
	Unblock one of the threads waiting on this condition. More...

bool	notify_all ()
	Unblock all of the threads waiting on this condition. More...

Protected Attributes
ACE_Condition< Mutex >	impl_

Detailed Description

template<typename Mutex>
class OpenDDS::DCPS::ConditionVariable< Mutex >

ACE_Condition wrapper based on std::condition_variable that enforces monotonic time behavior.

Besides the fact that it only works with ACE Mutexes, the major difference between this and std::condition_variable_any, the generalized form of std::condition_variable, is that it takes the mutex as a constructor argument, where the std::condition_variables take them as method arguments.

Definition at line 45 of file ConditionVariable.h.

Constructor & Destructor Documentation

◆ ConditionVariable()

template<typename Mutex>

OpenDDS::DCPS::ConditionVariable< Mutex >::ConditionVariable ( Mutex & mutex )

inlineexplicit

Definition at line 47 of file ConditionVariable.h.

   : impl_(mutex, ACE_Condition_Attributes_T<MonotonicClock>())
   {
   }

Member Function Documentation

◆ notify_all()

template<typename Mutex>

bool OpenDDS::DCPS::ConditionVariable< Mutex >::notify_all ( )

inline

Unblock all of the threads waiting on this condition.

Definition at line 106 of file ConditionVariable.h.

Referenced by OpenDDS::DCPS::DataReaderImpl::add_association(), OpenDDS::DCPS::DomainParticipantImpl::assign_handle(), OpenDDS::DCPS::DispatchService::cancel(), OpenDDS::DCPS::ThreadPerConnectionSendTask::close(), OpenDDS::DCPS::ReplayerImpl::data_delivered(), OpenDDS::DCPS::WriteDataContainer::data_delivered(), OpenDDS::DCPS::ReplayerImpl::data_dropped(), OpenDDS::DCPS::WriteDataContainer::data_dropped(), OpenDDS::DCPS::TypeObjReqCond::done(), OpenDDS::DCPS::DataReaderImpl::enable(), OpenDDS::DCPS::DomainParticipantImpl::handle_exception(), OpenDDS::DCPS::MessageTracker::message_delivered(), OpenDDS::DCPS::MessageTracker::message_dropped(), OpenDDS::DCPS::ReactorTask::open_reactor_task(), OpenDDS::DCPS::WriteDataContainer::remove_oldest_sample(), OpenDDS::DCPS::WriteDataContainer::remove_reader_acks(), OpenDDS::DCPS::ThreadPool::run(), OpenDDS::DCPS::DispatchService::run_event_loop(), OpenDDS::DCPS::DispatchService::shutdown(), OpenDDS::DCPS::ReactorTask::svc(), OpenDDS::DCPS::WriteDataContainer::unregister_all(), OpenDDS::DCPS::WriteDataContainer::update_acked(), and OpenDDS::DCPS::WriteDataContainer::wakeup_blocking_writers().

   {
     if (impl_.broadcast() == 0) {
       return true;
     }
     if (DCPS_debug_level) {
       ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: ConditionVariable::notify_all: %m\n"));
     }
     return false;
   }

◆ notify_one()

template<typename Mutex>

bool OpenDDS::DCPS::ConditionVariable< Mutex >::notify_one ( )

inline

Unblock one of the threads waiting on this condition.

Definition at line 94 of file ConditionVariable.h.

Referenced by OpenDDS::DCPS::QueueTaskBase< DataLink_rch >::add(), OpenDDS::DCPS::ThreadPerConnectionSendTask::add_request(), OpenDDS::DCPS::QueueTaskBase< DataLink_rch >::close(), OpenDDS::DCPS::DispatchService::dispatch(), OpenDDS::DCPS::ThreadPool::run(), OpenDDS::DCPS::DispatchService::schedule(), DDS::WaitSet::signal(), OpenDDS::DCPS::DcpsUpcalls::svc(), OpenDDS::DCPS::PerConnectionSynch::unregister_worker_i(), OpenDDS::DCPS::PerConnectionSynch::work_available(), and OpenDDS::DCPS::DcpsUpcalls::writer_done().

   {
     if (impl_.signal() == 0) {
       return true;
     }
     if (DCPS_debug_level) {
       ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: ConditionVariable::notify_one: %m\n"));
     }
     return false;
   }

◆ wait()

template<typename Mutex>

CvStatus OpenDDS::DCPS::ConditionVariable< Mutex >::wait ( ThreadStatusManager & thread_status_manager )

inline

Block until thread is woken up.

Definition at line 53 of file ConditionVariable.h.

Referenced by OpenDDS::DCPS::DomainParticipantImpl::await_handle(), OpenDDS::DCPS::ReplayerImpl::cleanup(), OpenDDS::DCPS::DomainParticipantImpl::delete_contained_entities(), OpenDDS::DCPS::ThreadPool::join_all(), OpenDDS::DCPS::ReactorTask::open_reactor_task(), TAO_DDS_DCPSInfo_i::remove_domain_participant(), OpenDDS::DCPS::ThreadPool::run(), OpenDDS::DCPS::DispatchService::run_event_loop(), OpenDDS::DCPS::DispatchService::shutdown(), OpenDDS::RTPS::Spdp::shutdown(), OpenDDS::DCPS::DcpsUpcalls::svc(), OpenDDS::DCPS::PerConnectionSynch::svc(), OpenDDS::DCPS::ThreadPerConnectionSendTask::svc(), OpenDDS::DCPS::QueueTaskBase< DataLink_rch >::svc(), OpenDDS::DCPS::ThreadPool::ThreadPool(), OpenDDS::DCPS::TypeObjReqCond::wait(), DDS::WaitSet::wait(), OpenDDS::DCPS::WriteDataContainer::wait_ack_of_seq(), OpenDDS::DCPS::ConditionVariable< ACE_Thread_Mutex >::wait_for(), OpenDDS::DCPS::ReactorTask::wait_for_startup_i(), and OpenDDS::DCPS::ConditionVariable< ACE_Thread_Mutex >::wait_until().

   {
     ThreadStatusManager::Sleeper s(thread_status_manager);
     if (impl_.wait() == 0) {
       return CvStatus_NoTimeout;
     }
     if (DCPS_debug_level) {
       ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: ConditionVariable::wait: %p\n"));
     }
     return CvStatus_Error;
   }

◆ wait_for()

template<typename Mutex>

CvStatus OpenDDS::DCPS::ConditionVariable< Mutex >::wait_for	(	const TimeDuration &	expire_in,
		ThreadStatusManager &	thread_status_manager
	)

inline

Block until woken up or for expire_in. Same as wait() if expire_in is zero.

Definition at line 84 of file ConditionVariable.h.

   {
     if (expire_in.is_zero()) {
       return wait(thread_status_manager);
     }
     ThreadStatusManager::Sleeper s(thread_status_manager);
     return wait_until(MonotonicTimePoint::now() + expire_in);
   }

◆ wait_until()

template<typename Mutex>

CvStatus OpenDDS::DCPS::ConditionVariable< Mutex >::wait_until	(	const MonotonicTimePoint &	expire_at,
		ThreadStatusManager &	thread_status_manager
	)

inline

Block until woken up or until expire_at. Same as wait() if expire_at is zero.

Definition at line 66 of file ConditionVariable.h.

Referenced by OpenDDS::DCPS::DomainParticipantImpl::await_handle(), OpenDDS::DCPS::WriteDataContainer::obtain_buffer(), OpenDDS::DCPS::DispatchService::run_event_loop(), OpenDDS::DCPS::DcpsUpcalls::svc(), OpenDDS::DCPS::QueueTaskBase< DataLink_rch >::svc(), DDS::WaitSet::wait(), OpenDDS::DCPS::WriteDataContainer::wait_ack_of_seq(), OpenDDS::DCPS::ConditionVariable< ACE_Thread_Mutex >::wait_for(), OpenDDS::DCPS::MessageTracker::wait_messages_pending(), and OpenDDS::DCPS::WriteDataContainer::wait_pending().

   {
     if (expire_at.is_zero()) {
       return wait(thread_status_manager);
     }
     ThreadStatusManager::Sleeper s(thread_status_manager);
     if (impl_.wait(&expire_at.value()) == 0) {
       return CvStatus_NoTimeout;
     } else if (errno == ETIME) {
       return CvStatus_Timeout;
     }
     if (DCPS_debug_level) {
       ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: ConditionVariable::wait_until: %m\n"));
     }
     return CvStatus_Error;
   }