Abstract base class for all the DDS objects that support QoS policies, status events, and a status condition. More...

Inheritance diagram for Entity:

Public Member Functions
void	Enable ()
	Enables this Entity (by default entities are automatically enabled after creation) More...

abstract void	ResetEvents (StatusMask newMask)
	Stop notifying of events not selected in the newMask and remove their event handlers. The actual events are defined in each derived entity class. More...

EntityLock	Lock ()
	Locks the Entity using its internal lock. More...

void	Dispose ()
	Releases the resources used by this Entity and disposes its contained entities as well (if any). More...

Properties
InstanceHandle	InstanceHandle `[get]`
	Gets the InstanceHandle that identifies this Entity More...

StatusMask	StatusChanges `[get]`
	Retrieves the list of communication statuses in this Entity that are triggered. More...

StatusCondition	StatusCondition `[get]`
	Gets the StatusCondition associated with this Entity. More...

bool	Enabled `[get]`
	Indicates whether this Entity is enabled. More...

bool	Disposed `[get]`
	Indicates whether this Entity has already been disposed. More...

Detailed Description

Abstract base class for all the DDS objects that support QoS policies, status events, and a status condition.

The full documentation is available in the C API: DDS_Entity

Member Function Documentation

◆ Dispose()

void Dispose ( )

Releases the resources used by this Entity and disposes its contained entities as well (if any).

Exceptions

PreconditionNotMetException When the entity cannot be disposed. For example, a topic cannot be disposed if a DataReader or a DataWriter is using it; a DataReader can't be disposed when a LoanedSamples returned by the DataReader is still in use.

◆ Enable()

void Enable ( )

Enables this Entity (by default entities are automatically enabled after creation)

The full documentation is available in the C API: DDS_Entity_enable

◆ Lock()

EntityLock Lock ( )

Locks the Entity using its internal lock.

The full documentation is available in the C API: DDS_Entity_lock

◆ ResetEvents()

abstract void ResetEvents ( StatusMask newMask )

pure virtual

Stop notifying of events not selected in the newMask and remove their event handlers. The actual events are defined in each derived entity class.

Parameters

newMask Selects which events will continue to receive notifications. Events not included in the status mask will no longer be notified. Use StatusMask.None to remove all event handlers.

Implemented in Publisher, DomainParticipant, Subscriber, AnyDataReader, AnyDataWriter, and Topic< T >.

Property Documentation

◆ Disposed

bool Disposed

get

Indicates whether this Entity has already been disposed.

◆ Enabled

bool Enabled

get

Indicates whether this Entity is enabled.

◆ InstanceHandle

InstanceHandle InstanceHandle

get

Gets the InstanceHandle that identifies this Entity

The full documentation is available in the C API: DDS_Entity_get_instance_handle

◆ StatusChanges

StatusMask StatusChanges

get

Retrieves the list of communication statuses in this Entity that are triggered.

The full documentation is available in the C API: DDS_Entity_get_status_changes

◆ StatusCondition

StatusCondition StatusCondition

get

Gets the StatusCondition associated with this Entity.

The full documentation is available in the C API: DDS_Entity_get_statuscondition

Public Member Functions

Properties