#include <WaitSet.h>

Inheritance diagram for DDS::WaitSet:

[legend]

Collaboration diagram for DDS::WaitSet:

[legend]

Public Types
typedef WaitSet_ptr	_ptr_type

typedef WaitSet_var	_var_type

Public Types inherited from OpenDDS::DCPS::LocalObject< WaitSetInterf >
typedef WaitSetInterf ::_ptr_type	_ptr_type

typedef WaitSetInterf ::_var_type	_var_type

Public Types inherited from CORBA::LocalObject
typedef LocalObject_ptr	_ptr_type

typedef LocalObject_var	_var_type

typedef LocalObject_out	_out_type

Public Types inherited from CORBA::Object
typedef Object_ptr	_ptr_type

typedef Object_var	_var_type

typedef Object_out	_out_type

Public Member Functions
	WaitSet ()

virtual	~WaitSet ()

ReturnCode_t	wait (ConditionSeq &active_conditions, const Duration_t &timeout)

ReturnCode_t	attach_condition (Condition_ptr cond)

ReturnCode_t	detach_condition (Condition_ptr cond)

ReturnCode_t	get_conditions (ConditionSeq &attached_conditions)

ReturnCode_t	detach_conditions (const ConditionSeq &conditions)

typedef	OPENDDS_SET_CMP (Condition_var, OpenDDS::DCPS::VarLess< Condition >) ConditionSet

Public Member Functions inherited from OpenDDS::DCPS::LocalObjectBase
virtual void	_add_ref ()

virtual void	_remove_ref ()

virtual CORBA::ULong	_refcount_value () const

Public Member Functions inherited from CORBA::LocalObject
virtual	~LocalObject (void)

virtual CORBA::Boolean	_non_existent (void)

virtual char *	_repository_id (void)

virtual CORBA::InterfaceDef_ptr	_get_interface (void)

virtual CORBA::Object_ptr	_get_component (void)

virtual void	_create_request (CORBA::Context_ptr ctx, const char *operation, CORBA::NVList_ptr arg_list, CORBA::NamedValue_ptr result, CORBA::Request_ptr &request, CORBA::Flags req_flags)

virtual void	_create_request (CORBA::Context_ptr ctx, const char *operation, CORBA::NVList_ptr arg_list, CORBA::NamedValue_ptr result, CORBA::ExceptionList_ptr exclist, CORBA::ContextList_ptr ctxtlist, CORBA::Request_ptr &request, CORBA::Flags req_flags)

virtual CORBA::Request_ptr	_request (const char *operation)

CORBA::Policy_ptr	_get_policy (CORBA::PolicyType type)

CORBA::Policy_ptr	_get_cached_policy (TAO_Cached_Policy_Type type)

CORBA::Object_ptr	_set_policy_overrides (const CORBA::PolicyList &policies, CORBA::SetOverrideType set_add)

CORBA::PolicyList *	_get_policy_overrides (const CORBA::PolicyTypeSeq &types)

CORBA::Boolean	_validate_connection (CORBA::PolicyList_out inconsistent_policies)

virtual CORBA::ULong	_hash (CORBA::ULong maximum)

virtual CORBA::Boolean	_is_equivalent (CORBA::Object_ptr other_obj)

virtual CORBA::ORB_ptr	_get_orb (void)

virtual TAO::ObjectKey *	_key (void)

Public Member Functions inherited from CORBA::Object
virtual	~Object (void)

virtual TAO_Abstract_ServantBase *	_servant (void) const

virtual CORBA::Boolean	_is_collocated (void) const

virtual CORBA::Boolean	_is_local (void) const

	Object (TAO_Stub p, CORBA::Boolean collocated=false, TAO_Abstract_ServantBase servant=0, TAO_ORB_Core *orb_core=0)

	Object (IOP::IOR ior, TAO_ORB_Core orb_core)

virtual TAO_Stub *	_stubobj (void) const

virtual TAO_Stub *	_stubobj (void)

virtual void	_proxy_broker (TAO::Object_Proxy_Broker *proxy_broker)

virtual CORBA::Boolean	marshal (TAO_OutputCDR &cdr)

CORBA::Boolean	is_evaluated (void) const

TAO_ORB_Core *	orb_core (void) const

IOP::IOR *	steal_ior (void)

const IOP::IOR &	ior (void) const

virtual bool	can_convert_to_ior (void) const

virtual char *	convert_to_ior (bool use_omg_ior_format, const char *ior_prefix) const

void	_decr_refcount (void)

virtual CORBA::Boolean	_is_a (const char *logical_type_id)

virtual const char *	_interface_repository_id (void) const

CORBA::Policy_ptr	_get_policy (CORBA::PolicyType type)

CORBA::Policy_ptr	_get_cached_policy (TAO_Cached_Policy_Type type)

CORBA::Object_ptr	_set_policy_overrides (const CORBA::PolicyList &policies, CORBA::SetOverrideType set_add)

CORBA::PolicyList *	_get_policy_overrides (const CORBA::PolicyTypeSeq &types)

CORBA::Boolean	_validate_connection (CORBA::PolicyList_out inconsistent_policies)

Public Member Functions inherited from OpenDDS::DCPS::RcObject
virtual	~RcObject ()

long	ref_count () const

WeakObject *	_get_weak_object () const

Static Public Member Functions
static WaitSet_ptr	_duplicate (WaitSet_ptr obj)

Static Public Member Functions inherited from OpenDDS::DCPS::LocalObject< WaitSetInterf >
static _ptr_type	_narrow (CORBA::Object_ptr obj)

Static Public Member Functions inherited from CORBA::LocalObject
static LocalObject_ptr	_duplicate (LocalObject_ptr obj)

static LocalObject_ptr	_nil (void)

static LocalObject_ptr	_narrow (CORBA::Object_ptr obj)

Static Public Member Functions inherited from CORBA::Object
static CORBA::Boolean	marshal (const Object_ptr x, TAO_OutputCDR &cdr)

static void	_tao_any_destructor (void *)

static CORBA::Boolean	is_nil_i (CORBA::Object_ptr obj)

static void	tao_object_initialize (Object *)

static CORBA::Object_ptr	_duplicate (CORBA::Object_ptr obj)

static CORBA::Object_ptr	_nil (void)

static CORBA::Object_ptr	_narrow (CORBA::Object_ptr obj)

Private Types
typedef OpenDDS::DCPS::ConditionVariable< ACE_Recursive_Thread_Mutex >	ConditionVariableType

Private Member Functions
ReturnCode_t	detach_i (const Condition_ptr cond)

void	signal (Condition_ptr cond)

Private Attributes
ACE_Recursive_Thread_Mutex	lock_

ConditionVariableType	cond_

bool	waiting_

ConditionSet	attached_conditions_

ConditionSet	signaled_conditions_

Friends
class	OpenDDS::DCPS::ConditionImpl

Additional Inherited Members
Protected Member Functions inherited from CORBA::LocalObject
	LocalObject (void)

Protected Member Functions inherited from CORBA::Object
	Object (int dummy=0)

TAO::Object_Proxy_Broker *	proxy_broker () const

Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()

Protected Attributes inherited from CORBA::Object
ACE_Atomic_Op< TAO_SYNCH_MUTEX, unsigned long >	refcount_

Detailed Description

Definition at line 52 of file WaitSet.h.

Member Typedef Documentation

◆ _ptr_type

typedef WaitSet_ptr DDS::WaitSet::_ptr_type

Definition at line 55 of file WaitSet.h.

◆ _var_type

typedef WaitSet_var DDS::WaitSet::_var_type

Definition at line 56 of file WaitSet.h.

◆ ConditionVariableType

typedef OpenDDS::DCPS::ConditionVariable<ACE_Recursive_Thread_Mutex> DDS::WaitSet::ConditionVariableType

private

Definition at line 89 of file WaitSet.h.

Constructor & Destructor Documentation

◆ WaitSet()

DDS::WaitSet::WaitSet ( )

inline

Definition at line 58 of file WaitSet.h.

     : cond_(lock_)
     , waiting_(false)
   {}

◆ ~WaitSet()

virtual DDS::WaitSet::~WaitSet ( )

inlinevirtual

Definition at line 63 of file WaitSet.h.

References _duplicate(), OpenDDS::DCPS::OPENDDS_SET_CMP(), signal(), and wait().

63 {}

Member Function Documentation

◆ _duplicate()

WaitSet_ptr DDS::WaitSet::_duplicate ( WaitSet_ptr obj )

static

Definition at line 182 of file WaitSet.cpp.

References OpenDDS::DCPS::LocalObjectBase::_add_ref(), CORBA::is_nil(), CORBA::Object::marshal(), OPENDDS_END_VERSIONED_NAMESPACE_DECL, and CORBA::release().

 {
   if (!CORBA::is_nil(obj)) obj->_add_ref();
 
   return obj;
 }

◆ attach_condition()

DDS::ReturnCode_t DDS::WaitSet::attach_condition ( Condition_ptr cond )

Definition at line 38 of file WaitSet.cpp.

References ACE_GUARD_RETURN, OpenDDS::DCPS::ConditionImpl::attach_to_ws(), attached_conditions_, lock_, DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_OK, DDS::RETCODE_OUT_OF_RESOURCES, DDS::RETCODE_PRECONDITION_NOT_MET, and signal().

 {
   using OpenDDS::DCPS::ConditionImpl;
   Condition_var condv(Condition::_duplicate(cond));
 
   ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, g, lock_,
                    RETCODE_OUT_OF_RESOURCES);
   ConditionImpl* ci = dynamic_cast<ConditionImpl*>(cond);
 
   if (!ci) return RETCODE_BAD_PARAMETER;
 
   ReturnCode_t ret = ci->attach_to_ws(this);
 
   if (ret == RETCODE_OK) {
     attached_conditions_.insert(condv);
 
     if (condv->get_trigger_value()) signal(condv.in());
 
     return RETCODE_OK;
 
   } else if (ret == RETCODE_PRECONDITION_NOT_MET) {
     // RETCODE_PRECONDITION_NOT_MET means it was already in the set
     return RETCODE_OK;
   }
 
   return ret;
 }

◆ detach_condition()

ReturnCode_t DDS::WaitSet::detach_condition ( Condition_ptr cond )

Definition at line 66 of file WaitSet.cpp.

References ACE_GUARD_RETURN, detach_i(), lock_, and DDS::RETCODE_OUT_OF_RESOURCES.

 {
   ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, g, lock_,
                    RETCODE_OUT_OF_RESOURCES);
   return detach_i(cond);
 }

◆ detach_conditions()

ReturnCode_t DDS::WaitSet::detach_conditions ( const ConditionSeq & conditions )

Convenience method for detaching multiple conditions, for example when shutting down.

Definition at line 73 of file WaitSet.cpp.

References ACE_GUARD_RETURN, detach_i(), lock_, DDS::RETCODE_OK, and DDS::RETCODE_OUT_OF_RESOURCES.

 {
   ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, g, lock_,
                    RETCODE_OUT_OF_RESOURCES);
 
   for (CORBA::ULong i = 0; i < conds.length(); ++i) {
     ReturnCode_t ret = detach_i(conds[ i]);
 
     if (ret != RETCODE_OK) {
       return ret;
     }
   }
 
   return RETCODE_OK;
 }

◆ detach_i()

ReturnCode_t DDS::WaitSet::detach_i ( const Condition_ptr cond )

private

Definition at line 89 of file WaitSet.cpp.

References attached_conditions_, OpenDDS::DCPS::ConditionImpl::detach_from_ws(), DDS::RETCODE_BAD_PARAMETER, and signaled_conditions_.

Referenced by detach_condition(), and detach_conditions().

 {
   using OpenDDS::DCPS::ConditionImpl;
   Condition_var condv(Condition::_duplicate(cond));
 
   ConditionImpl* ci = dynamic_cast<ConditionImpl*>(cond);
 
   if (!ci) return RETCODE_BAD_PARAMETER;
 
   ReturnCode_t ret = ci->detach_from_ws(this);
   attached_conditions_.erase(condv);
   signaled_conditions_.erase(condv);
   return ret;
 }

◆ get_conditions()

ReturnCode_t DDS::WaitSet::get_conditions ( ConditionSeq & attached_conditions )

Definition at line 104 of file WaitSet.cpp.

References ACE_GUARD_RETURN, attached_conditions_, lock_, DDS::RETCODE_OK, and DDS::RETCODE_OUT_OF_RESOURCES.

 {
   ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, g, lock_,
                    RETCODE_OUT_OF_RESOURCES);
   copyInto(conds, attached_conditions_);
   return RETCODE_OK;
 }

◆ OPENDDS_SET_CMP()

typedef DDS::WaitSet::OPENDDS_SET_CMP	(	Condition_var	,
		OpenDDS::DCPS::VarLess< Condition >
	)

◆ signal()

void DDS::WaitSet::signal ( Condition_ptr cond )

private

Definition at line 171 of file WaitSet.cpp.

References ACE_GUARD, attached_conditions_, cond_, lock_, OpenDDS::DCPS::ConditionVariable< Mutex >::notify_one(), and signaled_conditions_.

Referenced by attach_condition().

 {
   Condition_var condv(Condition::_duplicate(condition));
   ACE_GUARD(ACE_Recursive_Thread_Mutex, g, lock_);
 
   if (attached_conditions_.find(condv) != attached_conditions_.end()) {
     signaled_conditions_.insert(condv);
     cond_.notify_one();
   }
 }

◆ wait()

ReturnCode_t DDS::WaitSet::wait	(	ConditionSeq &	active_conditions,
		const Duration_t &	timeout
	)

Definition at line 112 of file WaitSet.cpp.

References ACE_ERROR, ACE_GUARD_RETURN, attached_conditions_, cond_, OpenDDS::DCPS::CvStatus_Error, OpenDDS::DCPS::CvStatus_NoTimeout, OpenDDS::DCPS::CvStatus_Timeout, OpenDDS::DCPS::DCPS_debug_level, OpenDDS::DCPS::is_infinite(), LM_ERROR, lock_, OpenDDS::DCPS::non_negative_duration(), OpenDDS::DCPS::TimePoint_T< MonotonicClock >::now(), DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_ERROR, DDS::RETCODE_OK, DDS::RETCODE_OUT_OF_RESOURCES, DDS::RETCODE_PRECONDITION_NOT_MET, DDS::RETCODE_TIMEOUT, signaled_conditions_, TheServiceParticipant, OpenDDS::DCPS::ConditionVariable< Mutex >::wait(), OpenDDS::DCPS::ConditionVariable< Mutex >::wait_until(), and waiting_.

 {
   using namespace OpenDDS::DCPS;
 
   if (!non_negative_duration(timeout)) {
     return DDS::RETCODE_BAD_PARAMETER;
   }
 
   MonotonicTimePoint deadline;
   const bool use_deadline = !is_infinite(timeout);
   if (use_deadline) {
     deadline = MonotonicTimePoint::now() + TimeDuration(timeout);
   }
 
   ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, g, lock_,
                    RETCODE_OUT_OF_RESOURCES);
 
   if (waiting_) {
     return RETCODE_PRECONDITION_NOT_MET;
   }
 
   waiting_ = true;
   signaled_conditions_.clear();
 
   for (ConditionSet::const_iterator iter = attached_conditions_.begin(),
        end = attached_conditions_.end(); iter != end; ++iter) {
     if ((*iter)->get_trigger_value()) {
       signaled_conditions_.insert(*iter);
     }
   }
 
   CvStatus status = CvStatus_NoTimeout;
   ThreadStatusManager& thread_status_manager = TheServiceParticipant->get_thread_status_manager();
   while ((attached_conditions_.empty() || signaled_conditions_.empty()) &&
       status == CvStatus_NoTimeout) {
     status = use_deadline ? cond_.wait_until(deadline, thread_status_manager) : cond_.wait(thread_status_manager);
   }
 
   copyInto(active_conditions, signaled_conditions_);
   signaled_conditions_.clear();
   waiting_ = false;
 
   switch (status) {
   case CvStatus_NoTimeout:
     return RETCODE_OK;
 
   case CvStatus_Timeout:
     return RETCODE_TIMEOUT;
 
   case CvStatus_Error:
   default:
     if (DCPS_debug_level) {
       ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: WaitSet::wait: wait_until failed\n"));
     }
     return RETCODE_ERROR;
   }
 }

Friends And Related Function Documentation

◆ OpenDDS::DCPS::ConditionImpl

friend class OpenDDS::DCPS::ConditionImpl

friend

Definition at line 85 of file WaitSet.h.

Member Data Documentation

◆ attached_conditions_

ConditionSet DDS::WaitSet::attached_conditions_

private

Definition at line 93 of file WaitSet.h.

Referenced by attach_condition(), detach_i(), get_conditions(), signal(), and wait().

◆ cond_

ConditionVariableType DDS::WaitSet::cond_

private

Definition at line 90 of file WaitSet.h.

Referenced by signal(), and wait().

◆ lock_

ACE_Recursive_Thread_Mutex DDS::WaitSet::lock_

private

Definition at line 87 of file WaitSet.h.

Referenced by attach_condition(), detach_condition(), detach_conditions(), get_conditions(), signal(), and wait().

◆ signaled_conditions_

ConditionSet DDS::WaitSet::signaled_conditions_

private

Definition at line 94 of file WaitSet.h.

Referenced by detach_i(), signal(), and wait().

◆ waiting_

bool DDS::WaitSet::waiting_

private

Definition at line 92 of file WaitSet.h.

Referenced by wait().

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

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ _ptr_type

◆ _var_type

◆ ConditionVariableType

Constructor & Destructor Documentation

◆ WaitSet()

◆ ~WaitSet()

Member Function Documentation

◆ _duplicate()

◆ attach_condition()

◆ detach_condition()

◆ detach_conditions()

◆ detach_i()

◆ get_conditions()

◆ OPENDDS_SET_CMP()

◆ signal()

◆ wait()

Friends And Related Function Documentation

◆ OpenDDS::DCPS::ConditionImpl

Member Data Documentation

◆ attached_conditions_

◆ cond_

◆ lock_

◆ signaled_conditions_

◆ waiting_