OpenDDS::DCPS::EntityImpl Class Reference

Implements the OpenDDS::DCPS::Entity interfaces. More...

#include <EntityImpl.h>

Inheritance diagram for OpenDDS::DCPS::EntityImpl:

[legend]Collaboration diagram for OpenDDS::DCPS::EntityImpl:

[legend]List of all members.

Public Member Functions
	EntityImpl ()
	Constructor.
virtual	~EntityImpl ()
	Destructor.
virtual DDS::ReturnCode_t	set_enabled ()
bool	is_enabled () const
virtual DDS::StatusCondition_ptr	get_statuscondition () throw (CORBA::SystemException)
virtual DDS::StatusMask	get_status_changes () throw (CORBA::SystemException)
virtual DDS::InstanceHandle_t	get_instance_handle ()=0 throw (CORBA::SystemException)
virtual void	set_deleted (bool state)
virtual bool	get_deleted ()
void	set_status_changed_flag (DDS::StatusKind status, bool status_changed_flag)
void	notify_status_condition ()
virtual void	transport_config (const TransportConfig_rch &cfg)
TransportConfig_rch	transport_config () const
virtual EntityImpl *	parent () const
Protected Attributes
ACE_Atomic_Op< TAO_SYNCH_MUTEX, bool >	enabled_
	The flag indicates the entity is enabled.
ACE_Atomic_Op< TAO_SYNCH_MUTEX, bool >	entity_deleted_
	The flag indicates the entity is being deleted.
Private Attributes
DDS::StatusMask	status_changes_
DDS::StatusCondition_var	status_condition_
TransportConfig_rch	transport_config_
ACE_Thread_Mutex	lock_

---

Detailed Description

Implements the OpenDDS::DCPS::Entity interfaces.

This class is the base class of other servant classes. e.g. DomainParticipantImpl, PublisherImpl ...

---

Constructor & Destructor Documentation

OpenDDS::DCPS::EntityImpl::EntityImpl

(

)

Constructor.

OpenDDS::DCPS::EntityImpl::~EntityImpl

(

)

[virtual]

Destructor.

---

Member Function Documentation

bool OpenDDS::DCPS::EntityImpl::get_deleted

(

)

[virtual]

virtual DDS::InstanceHandle_t OpenDDS::DCPS::EntityImpl::get_instance_handle

(

)

throw (CORBA::SystemException) [pure virtual]

Implements DDS::Entity.

Implemented in OpenDDS::DCPS::DataReaderImpl, OpenDDS::DCPS::DataWriterImpl, OpenDDS::DCPS::DomainParticipantImpl, OpenDDS::DCPS::PublisherImpl, OpenDDS::DCPS::SubscriberImpl, and OpenDDS::DCPS::TopicImpl.

DDS::StatusMask OpenDDS::DCPS::EntityImpl::get_status_changes

(

)

throw (CORBA::SystemException) [virtual]

Implements DDS::Entity.

DDS::StatusCondition_ptr OpenDDS::DCPS::EntityImpl::get_statuscondition

(

)

throw (CORBA::SystemException) [virtual]

Implements DDS::Entity.

bool OpenDDS::DCPS::EntityImpl::is_enabled

(

)

const

void OpenDDS::DCPS::EntityImpl::notify_status_condition

(

)

Call this *after* dispatching to listeners when the "changed status flag" is enabled so that any waiting waitsets can be unblocked.

virtual EntityImpl* OpenDDS::DCPS::EntityImpl::parent

(

)

const [inline, virtual]

Reimplemented in OpenDDS::DCPS::DataReaderImpl, OpenDDS::DCPS::DataWriterImpl, OpenDDS::DCPS::PublisherImpl, and OpenDDS::DCPS::SubscriberImpl.

void OpenDDS::DCPS::EntityImpl::set_deleted

(

bool

state

)

[virtual]

DDS::ReturnCode_t OpenDDS::DCPS::EntityImpl::set_enabled

(

)

[virtual]

void OpenDDS::DCPS::EntityImpl::set_status_changed_flag	(	DDS::StatusKind	status,
		bool	status_changed_flag
	)

TransportConfig_rch OpenDDS::DCPS::EntityImpl::transport_config

(

)

const

void OpenDDS::DCPS::EntityImpl::transport_config

(

const TransportConfig_rch &

cfg

)

[virtual]

Reimplemented in OpenDDS::DCPS::TopicImpl.

---

Member Data Documentation

ACE_Atomic_Op<TAO_SYNCH_MUTEX, bool> OpenDDS::DCPS::EntityImpl::enabled_ [protected]

The flag indicates the entity is enabled.

ACE_Atomic_Op<TAO_SYNCH_MUTEX, bool> OpenDDS::DCPS::EntityImpl::entity_deleted_ [protected]

The flag indicates the entity is being deleted.

ACE_Thread_Mutex OpenDDS::DCPS::EntityImpl::lock_ [mutable, private]

Reimplemented in OpenDDS::DCPS::DataWriterImpl.

DDS::StatusMask OpenDDS::DCPS::EntityImpl::status_changes_ [private]

The status_changes_ variable lists all status changed flag. The StatusChangedFlag becomes TRUE whenever the plain communication status changes and it is reset to FALSE each time the application accesses the plain communication status via the proper get_<plain communication status> operation on the Entity.

DDS::StatusCondition_var OpenDDS::DCPS::EntityImpl::status_condition_ [private]

TransportConfig_rch OpenDDS::DCPS::EntityImpl::transport_config_ [private]

---

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

• EntityImpl.h
• EntityImpl.cpp

---