org.omg.dds.core
Interface Entity<SELF extends Entity<SELF,LISTENER,QOS>,LISTENER extends java.util.EventListener,QOS extends EntityQos<?,?>>

Type Parameters:

SELF - The most-derived DDS-standard interface implemented by this entity.

LISTENER - The listener interface appropriate for this entity.

QOS - The QoS interface appropriate for this entity.

All Superinterfaces:

DDSObject

All Known Subinterfaces:

BytesDataReader, BytesDataWriter, DataReader<TYPE>, DataWriter<TYPE>, DomainEntity<SELF,PARENT,LISTENER,QOS>, DomainParticipant, KeyedBytesDataReader, KeyedBytesDataWriter, KeyedStringDataReader, KeyedStringDataWriter, Publisher, StringDataReader, StringDataWriter, Subscriber, Topic<TYPE>

public interface Entity<SELF extends Entity<SELF,LISTENER,QOS>,LISTENER extends java.util.EventListener,QOS extends EntityQos<?,?>>
extends DDSObject

This class is the abstract base class for all the DCPS objects that support QoS policies, a listener and a status condition.

Method Summary

void	close() Halt communication and dispose the resources held by this entity.
void	enable()
InstanceHandle	getInstanceHandle()
LISTENER	getListener()
QOS	getQos()
java.util.Collection<java.lang.Class<? extends Status<?,?>>>	getStatusChanges(java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)
StatusCondition<SELF>	getStatusCondition()
void	retain() Indicates that references to this object may go out of scope but that the application expects to look it up again later.
void	setListener(LISTENER listener)
void	setQos(QOS qos)
void	setQos(java.lang.String qosLibraryName, java.lang.String qosProfileName) Set the QoS to that specified in the given QoS profile in the given QoS library.

Methods inherited from interface org.omg.dds.core.DDSObject

getBootstrap

Method Detail

getListener

LISTENER getListener()

setListener

void setListener(LISTENER listener)

getQos

QOS getQos()

setQos

void setQos(QOS qos)

See Also:

setQos(String, String)

setQos

void setQos(java.lang.String qosLibraryName,
            java.lang.String qosProfileName)

Set the QoS to that specified in the given QoS profile in the given QoS library.

Parameters:

qosLibraryName -

qosProfileName -

See Also:

setQos(EntityQos)

enable

void enable()

getStatusCondition

StatusCondition<SELF> getStatusCondition()

getStatusChanges

java.util.Collection<java.lang.Class<? extends Status<?,?>>> getStatusChanges(java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)

getInstanceHandle

InstanceHandle getInstanceHandle()

close

void close()

Halt communication and dispose the resources held by this entity.

retain

void retain()

Indicates that references to this object may go out of scope but that the application expects to look it up again later. Therefore, the Service must consider this object to be still in use and may not close it automatically.