Inheritance diagram for org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >:

Collaboration diagram for org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >:

Public Member Functions
	EntityImpl (OsplServiceEnvironment environment, OLDPARENT oldParent)

final void	close ()

final void	enable ()

ServiceEnvironment	getEnvironment ()

final InstanceHandle	getInstanceHandle ()

final LISTENER	getListener ()

OLD	getOld ()

OLDPARENT	getOldParent ()

String	getProperty (String key)
	Provides access to the current value for a given property. More...

QOS	getQos ()
	This operation allows access to the existing set of QoS policies for the Entity. More...

final Set< Class<? extends Status > >	getStatusChanges ()

StatusCondition<?>	getStatusCondition ()
	This operation allows access to the org.omg.dds.core.StatusCondition associated with the Entity. More...

final void	retain ()

void	setListener (LISTENER listener)
	This operation installs a Listener on the Entity. More...

void	setListener (LISTENER listener, Collection< Class<? extends Status >> statuses)
	This operation installs a Listener on the Entity. More...

void	setListener (LISTENER listener, Class<? extends Status >... statuses)
	This operation installs a Listener on the Entity. More...

void	setProperty (String key, String value)
	This method sets the property specified by the key to the value given by the value. More...

void	setQos (QOS qos)
	This operation is used to set the QoS policies of the Entity. More...

Static Public Member Functions
static boolean	printReferences ()

Protected Member Functions
abstract void	destroy ()

void	setOld (OLD old)

Protected Attributes
final transient OsplServiceEnvironment	environment

LISTENERIMPL	listener

Detailed Description

Definition at line 34 of file EntityImpl.java.

Constructor & Destructor Documentation

◆ EntityImpl()

org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.EntityImpl	(	OsplServiceEnvironment	environment,
		OLDPARENT	oldParent
	)

Definition at line 93 of file EntityImpl.java.

Member Function Documentation

◆ close()

final void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.close ( )

Definition at line 139 of file EntityImpl.java.

◆ destroy()

abstract void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.destroy ( )

abstractprotected

◆ enable()

final void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.enable ( )

Definition at line 153 of file EntityImpl.java.

◆ getEnvironment()

ServiceEnvironment org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getEnvironment ( )

Definition at line 121 of file EntityImpl.java.

◆ getInstanceHandle()

final InstanceHandle org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getInstanceHandle ( )

Definition at line 166 of file EntityImpl.java.

◆ getListener()

final LISTENER org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getListener ( )

Definition at line 174 of file EntityImpl.java.

◆ getOld()

OLD org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getOld ( )

Definition at line 102 of file EntityImpl.java.

◆ getOldParent()

OLDPARENT org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getOldParent ( )

Definition at line 116 of file EntityImpl.java.

◆ getProperty()

String org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getProperty ( String key )

Provides access to the current value for a given property.

Parameters

key	The key of the property to obtain the value for.

Returns: The value for the specified property, or null if it has not been set.

Implements org.opensplice.dds.core.Properties.

Definition at line 189 of file EntityImpl.java.

◆ getQos()

QOS org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.getQos ( )

inherited

This operation allows access to the existing set of QoS policies for the Entity.

This operation must be provided by each of the derived Entity classes (org.omg.dds.domain.DomainParticipant, org.omg.dds.topic.Topic, org.omg.dds.pub.Publisher, org.omg.dds.pub.DataWriter, org.omg.dds.sub.Subscriber, org.omg.dds.sub.DataReader) so that the policies meaningful to the particular Entity are retrieved.

See also: #setQos(EntityQos)

◆ getStatusChanges()

final Set<Class<? extends Status> > org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getStatusChanges ( )

Definition at line 160 of file EntityImpl.java.

◆ getStatusCondition()

StatusCondition<?> org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.getStatusCondition ( )

inherited

This operation allows access to the org.omg.dds.core.StatusCondition associated with the Entity.

The returned condition can then be added to a org.omg.dds.core.WaitSet so that the application can wait for specific status changes that affect the Entity.

◆ printReferences()

static boolean org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.printReferences ( )

static

Definition at line 66 of file EntityImpl.java.

◆ retain()

final void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.retain ( )

Definition at line 126 of file EntityImpl.java.

◆ setListener() [1/3]

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.setListener ( LISTENER listener )

inherited

This operation installs a Listener on the Entity.

The listener will only be invoked on all communication statuses pertaining to the concrete type of this entity.

It is permitted to use null as the value of the listener. The null listener behaves as a Listener whose operations perform no action.

Only one listener can be attached to each Entity. If a listener was already set, the operation will replace it with the new one. Consequently if the value null is passed for the listener parameter, any existing listener will be removed.

Parameters

listener the listener to attach.

See also: getListener(); #setListener(EventListener, Collection)

◆ setListener() [2/3]

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.setListener	(	LISTENER	listener,
		Collection< Class<? extends Status >>	statuses
	)

inherited

This operation installs a Listener on the Entity.

The listener will only be invoked on the changes of communication status indicated by the specified mask.

It is permitted to use null as the value of the listener. The null listener behaves as a Listener whose operations perform no action.

Only one listener can be attached to each Entity. If a listener was already set, the operation will replace it with the new one. Consequently if the value null is passed for the listener parameter, any existing listener will be removed.

See also: getListener(); #setListener(EventListener)

◆ setListener() [3/3]

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.setListener	(	LISTENER	listener,
		Class<? extends Status >...	statuses
	)

inherited

This operation installs a Listener on the Entity.

The listener will only be invoked on the changes of communication status indicated by the specified mask.

It is permitted to use null as the value of the listener. The null listener behaves as a Listener whose operations perform no action.

Only one listener can be attached to each Entity. If a listener was already set, the operation will replace it with the new one. Consequently if the value null is passed for the listener parameter, any existing listener will be removed.

See also: getListener(); #setListener(EventListener)

◆ setOld()

void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.setOld ( OLD old )

protected

Definition at line 112 of file EntityImpl.java.

◆ setProperty()

void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.setProperty	(	String	key,
		String	value
	)

This method sets the property specified by the key to the value given by the value.

Currently, this method is only supported on a org.omg.dds.sub.DataReader and that supports the following properties:

parallelReadThreadCount - By default, the demarshalling of data into Java objects by a single read or take operation happens only in the calling thread. The parallelReadThreadCount property can be used to control the number of parallel threads to be used for this demarshalling. When reading multiple of samples takes a significant amount of time, increasing the number of threads on a multi-core machine can provide a significant benefit. The value is interpreted as the number of parallel threads to use (i.e., the value is a string representing a natural integer in decimal notation, so for example the string '4' will cause 4 threads to be used). The value '0' is allowed and selects the default behavior. If the call was successful, successive read/take operations on that org.omg.dds.sub.DataReader will use the specified number of threads for the demarshalling step of the respective operations until the value of this property is changed again.

CDRCopy - The default demarshalling technique constructs the Java object directly from the shared memory, but for some types, it is more efficient to marshal the value in shared memory into CDR representation, and then demarshal the CDR representation from Java. The value is interpreted as a boolean (i.e., value must be either 'true' or 'false'), with 'false' selecting the default technique and 'true' selecting the alternative, CDR-based technique. The CDR-based technique requires JacORB to be configured as the default ORB in the JVM, and furthermore requires that the JacORB IDL preprocessor has been used to generate a Helper class for the topic type of this org.omg.dds.sub.DataReader and that this helper class can be found in the class path. The ORB initialization and Helper class lookup is all done at run-time to avoid introducing a compile-time dependency, but this means that attempting to set the CDRCopy property to 'true' can fail in complicated ways because of these dependencies. When set to true, the CDR-based technique will be used for successive read/take operations on the data reader, until the property is set to false again.

Parameters

key	The key of the property
value	The value to assign to the property.

Implements org.opensplice.dds.core.Properties.

Definition at line 182 of file EntityImpl.java.

◆ setQos()

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.setQos ( QOS qos )

inherited

This operation is used to set the QoS policies of the Entity.

This operation must be provided by each of the derived Entity classes (org.omg.dds.domain.DomainParticipant, org.omg.dds.topic.Topic, org.omg.dds.pub.Publisher, org.omg.dds.pub.DataWriter, org.omg.dds.sub.Subscriber, org.omg.dds.sub.DataReader) so that the policies that are meaningful to each Entity can be set.

The set of policies specified as the parameter are applied on top of the existing QoS, replacing the values of any policies previously set.

Certain policies are "immutable"; they can only be set at Entity creation time, or before the entity is made enabled. If setQos is invoked after the Entity is enabled and it attempts to change the value of an "immutable" policy, the operation will fail with org.omg.dds.core.ImmutablePolicyException.

Certain values of QoS policies can be incompatible with the settings of the other policies. The setQos operation will also fail if it specifies a set of values that once combined with the existing values would result in an inconsistent set of policies. In this case, it shall fail with org.omg.dds.core.InconsistentPolicyException.

If the application supplies a non-default value for a QoS policy that is not supported by the implementation of the service, the setQos operation will fail with UnsupportedOperationException.

The existing set of policies are only changed if the setQos operation succeeds. In all other cases, none of the policies is modified.

Exceptions

ImmutablePolicyException	if an immutable policy changes its value.
InconsistentPolicyException	if a combination of policies is inconsistent with one another.
UnsupportedOperationException	if an unsupported policy has a non-default value.

See also: getQos()

Member Data Documentation

◆ environment

final transient OsplServiceEnvironment org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.environment

protected

Definition at line 36 of file EntityImpl.java.

◆ listener

LISTENERIMPL org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.listener

protected

Definition at line 39 of file EntityImpl.java.

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

java5/common/java/code/org/opensplice/dds/core/EntityImpl.java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EntityImpl()

Member Function Documentation

◆ close()

◆ destroy()

◆ enable()

◆ getEnvironment()

◆ getInstanceHandle()

◆ getListener()

◆ getOld()

◆ getOldParent()

◆ getProperty()

◆ getQos()

◆ getStatusChanges()

◆ getStatusCondition()

◆ printReferences()

◆ retain()

◆ setListener() [1/3]

◆ setListener() [2/3]

◆ setListener() [3/3]

◆ setOld()

◆ setProperty()

◆ setQos()

Member Data Documentation

◆ environment

◆ listener