Inheritance diagram for org.opensplice.dds.domain.DomainParticipantImpl:

Collaboration diagram for org.opensplice.dds.domain.DomainParticipantImpl:

Public Member Functions
	DomainParticipantImpl (OsplServiceEnvironment environment, DomainParticipantFactoryImpl factory, int domainId, DomainParticipantQos qos, DomainParticipantListener listener, Collection< Class<? extends Status >> statuses)

void	assertLiveliness ()
	This operation manually asserts the liveliness of the DomainParticipant. More...

final void	close ()

abstract void	close ()
	Halt communication and dispose the resources held by this Entity. More...

void	closeContainedEntities ()
	This operation deletes all the entities that were created by means of the "create" operations on the DomainParticipant. More...

boolean	containsEntity (InstanceHandle handle)
	This operation checks whether or not the given handle represents an org.omg.dds.core.Entity that was created from the DomainParticipant. More...

void	createPersistentSnapshot (String partitionExpression, String topicExpression, String uri)

Publisher	createPublisher ()
	This operation creates a Publisher with default QoS policies and no PublisherListener. More...

Publisher	createPublisher (PublisherQos qos)
	This operation creates a Publisher. More...

Publisher	createPublisher (PublisherQos qos, PublisherListener listener, Collection< Class<? extends Status >> statuses)
	This operation creates a Publisher. More...

Publisher	createPublisher (PublisherQos qos, PublisherListener listener, Class<? extends Status >... statuses)
	This operation creates a Publisher. More...

Subscriber	createSubscriber ()
	This operation creates a Subscriber with default QoS policies and no SubscriberListener. More...

Subscriber	createSubscriber (SubscriberQos qos)
	This operation creates a Subscriber. More...

Subscriber	createSubscriber (SubscriberQos qos, SubscriberListener listener, Collection< Class<? extends Status >> statuses)
	This operation creates a Subscriber. More...

Subscriber	createSubscriber (SubscriberQos qos, SubscriberListener listener, Class<? extends Status >... statuses)
	This operation creates a Subscriber. More...

Topic< DynamicType >	createTopic (String topicName, DynamicType type)
	This operation creates a Topic with default QoS policies and no TopicListener. More...

Topic< DynamicType >	createTopic (String topicName, DynamicType type, TopicQos qos, TopicListener< DynamicType > listener, Collection< Class<? extends Status >> statuses)
	This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener. More...

Topic< DynamicType >	createTopic (String topicName, DynamicType type, TopicQos qos, TopicListener< DynamicType > listener, Class<? extends Status >... statuses)
	This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener. More...

Topic< DynamicType >	createTopic (String topicName, DynamicType type, TypeSupport< DynamicType > typeSupport)
	This operation creates a Topic with default QoS policies and no TopicListener. More...

Topic< DynamicType >	createTopic (String topicName, DynamicType type, TypeSupport< DynamicType > typeSupport, TopicQos qos, TopicListener< DynamicType > listener, Collection< Class<? extends Status >> statuses)
	This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener. More...

Topic< DynamicType >	createTopic (String topicName, DynamicType type, TypeSupport< DynamicType > typeSupport, TopicQos qos, TopicListener< DynamicType > listener, Class<? extends Status >... statuses)
	This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener. More...

void	deleteHistoricalData (String partitionExpression, String topicExpression)

void	destroyPublisher (PublisherImpl child)

void	destroySubscriber (SubscriberImpl child)

final void	enable ()

void	enable ()
	This operation enables the Entity. More...

Subscriber	getBuiltinSubscriber ()
	This operation allows access to the built-in Subscriber. More...

ModifiableTime	getCurrentTime (ModifiableTime currentTime)
	This operation returns the current value of the time that the service uses to time stamp data writes and to set the reception time stamp for the data updates it receives. More...

Time	getCurrentTime ()
	This operation returns the current value of the time that the service uses to time stamp data writes and to set the reception time stamp for the data updates it receives. More...

PublisherQos	getDefaultPublisherQos ()
	This operation retrieves the default value of the Publisher QoS, that is, the QoS policies which will be used for newly created org.omg.dds.pub.Publisher entities in the case where the QoS policies are defaulted in the createPublisher() operation. More...

SubscriberQos	getDefaultSubscriberQos ()
	This operation retrieves the default value of the Subscriber QoS, that is, the QoS policies which will be used for newly created org.omg.dds.sub.Subscriber entities in the case where the QoS policies are defaulted in the createSubscriber() operation. More...

TopicQos	getDefaultTopicQos ()
	This operation retrieves the default value of the Topic QoS, that is, the QoS policies which will be used for newly created org.omg.dds.topic.Topic entities in the case where the QoS policies are defaulted in the createTopic(String, Class) operation. More...

ParticipantBuiltinTopicData	getDiscoveredParticipantData (InstanceHandle participantHandle)
	This operation retrieves information on a DomainParticipant that has been discovered on the network. More...

Set< InstanceHandle >	getDiscoveredParticipants ()
	This operation retrieves the list of DomainParticipants that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the ignoreParticipant(InstanceHandle) operation. More...

TopicBuiltinTopicData	getDiscoveredTopicData (InstanceHandle topicHandle)
	This operation retrieves information on a org.omg.dds.topic.Topic that has been discovered on the network. More...

Set< InstanceHandle >	getDiscoveredTopics ()
	This operation retrieves the list of org.omg.dds.topic.Topics that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the ignoreTopic(InstanceHandle) operation. More...

int	getDomainId ()
	This operation retrieves the domain ID used to create the DomainParticipant. More...

ServiceEnvironment	getEnvironment ()

ServiceEnvironment	getEnvironment ()

final InstanceHandle	getInstanceHandle ()

InstanceHandle	getInstanceHandle ()

LISTENER	getListener ()
	This operation allows access to the existing Listener attached to the Entity. More...

final LISTENER	getListener ()

OLD	getOld ()

OLDPARENT	getOldParent ()

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

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

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

Set< Class<? extends Status > >	getStatusChanges ()
	This operation retrieves the list of communication statuses in the Entity that are 'triggered. More...

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

void	ignoreParticipant (InstanceHandle handle)
	This operation allows an application to instruct the Service to locally ignore a remote domain participant. More...

void	ignorePublication (InstanceHandle handle)
	This operation allows an application to instruct the Service to locally ignore a remote publication; a publication is defined by the association of a topic name, and user data and partition set on the org.omg.dds.pub.Publisher. More...

void	ignoreSubscription (InstanceHandle handle)
	This operation allows an application to instruct the Service to locally ignore a remote subscription; a subscription is defined by the association of a topic name, and user data and partition set on the org.omg.dds.sub.Subscriber. More...

void	ignoreTopic (InstanceHandle handle)
	This operation allows an application to instruct the Service to locally ignore a org.omg.dds.topic.Topic. More...

org.omg.dds.sub.Subscriber	lookupSubscriber (DDS.Subscriber subs)

final void	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. More...

void	setDefaultPublisherQos (PublisherQos qos)
	This operation sets a default value of the Publisher QoS policies, which will be used for newly created org.omg.dds.pub.Publisher entities in the case where the QoS policies are defaulted in the createPublisher() operation. More...

void	setDefaultSubscriberQos (SubscriberQos qos)
	This operation sets a default value of the Subscriber QoS policies that will be used for newly created org.omg.dds.sub.Subscriber entities in the case where the QoS policies are defaulted in the createSubscriber() operation. More...

void	setDefaultTopicQos (TopicQos qos)
	This operation sets a default value of the Topic QoS policies, which will be used for newly created org.omg.dds.topic.Topic entities in the case where the QoS policies are defaulted in the createTopic(String, Class) operation. More...

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

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, 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	setListener (LISTENER listener, Class<? extends Status >... statuses)
	This operation installs a Listener on the Entity. More...

void	setListener (org.omg.dds.domain.DomainParticipantListener listener)

void	setListener (org.omg.dds.domain.DomainParticipantListener listener, Collection< Class<? extends Status >> statuses)

void	setListener (DomainParticipantListener listener, Class<? extends Status >... statuses)

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...

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

void	setQos (DomainParticipantQos qos)

Static Public Member Functions
static boolean	printReferences ()

Protected Member Functions
void	destroy ()

void	setOld (OLD old)

Protected Attributes
final transient OsplServiceEnvironment	environment

LISTENERIMPL	listener

Detailed Description

Definition at line 89 of file DomainParticipantImpl.java.

Constructor & Destructor Documentation

◆ DomainParticipantImpl()

org.opensplice.dds.domain.DomainParticipantImpl.DomainParticipantImpl	(	OsplServiceEnvironment	environment,
		DomainParticipantFactoryImpl	factory,
		int	domainId,
		DomainParticipantQos	qos,
		DomainParticipantListener	listener,
		Collection< Class<? extends Status >>	statuses
	)

Definition at line 98 of file DomainParticipantImpl.java.

Member Function Documentation

◆ assertLiveliness()

void org.opensplice.dds.domain.DomainParticipantImpl.assertLiveliness ( )

This operation manually asserts the liveliness of the DomainParticipant.

This is used in combination with the org.omg.dds.core.policy.Liveliness to indicate to the Service that the entity remains active.

This operation needs to only be used if the DomainParticipant contains org.omg.dds.pub.DataWriter entities with the org.omg.dds.core.policy.Liveliness#getKind() set to org.omg.dds.core.policy.Liveliness.Kind#MANUAL_BY_PARTICIPANT and it only affects the liveliness of those DataWriter entities. Otherwise, it has no effect.

Note - Writing data via the org.omg.dds.pub.DataWriter#write(Object) operation on a DataWriter asserts liveliness on the DataWriter itself and its DomainParticipant. Consequently the use of assertLiveliness is only needed if the application is not writing data regularly.

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 646 of file DomainParticipantImpl.java.

◆ close() [1/2]

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

inherited

Definition at line 139 of file EntityImpl.java.

◆ close() [2/2]

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

abstractinherited

Halt communication and dispose the resources held by this Entity.

Closing an Entity implicitly closes all of its contained objects, if any. For example, closing a Publisher also closes all of its contained DataWriters.

An Entity cannot be closed if it has any unclosed dependent objects, not including contained objects. These include the following:

A org.omg.dds.topic.Topic cannot be closed if it is still in use by any org.omg.dds.topic.ContentFilteredTopics or org.omg.dds.topic.MultiTopics.
A Topic cannot be closed if any org.omg.dds.pub.DataWriters or org.omg.dds.sub.DataReader is still using it.
A DataReader cannot be closed if it has any outstanding loans as a result of a call to org.omg.dds.sub.DataReader#read(), org.omg.dds.sub.DataReader#take(), or one of the variants thereof.

The deletion of a org.omg.dds.pub.DataWriter will automatically unregister all instances. Depending on the settings of the org.omg.dds.core.policy.WriterDataLifecycle, the deletion of the DataWriter may also dispose all instances.

Exceptions

PreconditionNotMetException if close is called on an Entity with unclosed dependent object(s), not including contained objects.

See also: org.omg.dds.topic.TopicDescription::close()

◆ closeContainedEntities()

void org.opensplice.dds.domain.DomainParticipantImpl.closeContainedEntities ( )

This operation deletes all the entities that were created by means of the "create" operations on the DomainParticipant.

That is, it deletes all contained org.omg.dds.pub.Publisher, org.omg.dds.sub.Subscriber, org.omg.dds.topic.Topic, org.omg.dds.topic.ContentFilteredTopic, and org.omg.dds.topic.MultiTopic objects.

Prior to deleting each contained entity, this operation will recursively call the corresponding closeContainedEntities operation on each contained entity (if applicable). This pattern is applied recursively. In this manner the operation closeContainedEntities on the DomainParticipant will end up deleting all the entities recursively contained in the DomainParticipant, that is also the org.omg.dds.pub.DataWriter, org.omg.dds.sub.DataReader, as well as the org.omg.dds.sub.QueryCondition and org.omg.dds.sub.ReadCondition objects belonging to the contained DataReaders.

Once closeContainedEntities returns successfully, the application may delete the DomainParticipant knowing that it has no contained entities.

Exceptions

org.omg.dds.core.PreconditionNotMetException if any of the contained entities is in a state where it cannot be closed.

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 531 of file DomainParticipantImpl.java.

◆ containsEntity()

boolean org.opensplice.dds.domain.DomainParticipantImpl.containsEntity ( InstanceHandle handle )

This operation checks whether or not the given handle represents an org.omg.dds.core.Entity that was created from the DomainParticipant.

The containment applies recursively. That is, it applies both to entities (org.omg.dds.topic.TopicDescription, org.omg.dds.pub.Publisher, or org.omg.dds.sub.Subscriber) created directly using the DomainParticipant as well as entities created using a contained Publisher or Subscriber as the factory, and so forth.

Parameters

handle the handle to an entity that need to be checked. The instance handle for an Entity may be obtained from built-in topic data, from various statuses, or from the Entity operation org.omg.dds.core.Entity#getInstanceHandle().

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 794 of file DomainParticipantImpl.java.

◆ createPersistentSnapshot()

void org.opensplice.dds.domain.DomainParticipantImpl.createPersistentSnapshot	(	String	partitionExpression,
		String	topicExpression,
		String	uri
	)

Definition at line 990 of file DomainParticipantImpl.java.

◆ createPublisher() [1/4]

Publisher org.opensplice.dds.domain.DomainParticipantImpl.createPublisher ( )

This operation creates a Publisher with default QoS policies and no PublisherListener.

The created Publisher belongs to the DomainParticipant that is its factory.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

Returns: a Publisher object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 204 of file DomainParticipantImpl.java.

◆ createPublisher() [2/4]

Publisher org.opensplice.dds.domain.DomainParticipantImpl.createPublisher ( PublisherQos qos )

This operation creates a Publisher.

The created Publisher belongs to the DomainParticipant that is its factory.

Parameters

qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Publisher will be created.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: createPublisher()

Returns: a Publisher object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 209 of file DomainParticipantImpl.java.

◆ createPublisher() [3/4]

Publisher org.opensplice.dds.domain.DomainParticipantImpl.createPublisher	(	PublisherQos	qos,
		PublisherListener	listener,
		Collection< Class<? extends Status >>	statuses
	)

This operation creates a Publisher.

The created Publisher belongs to the DomainParticipant that is its factory.

For each communication status, the StatusChangedFlag flag is initially set to false. It becomes true whenever that communication status changes. For each communication status activated in the mask, the associated org.omg.dds.pub.PublisherListener operation is invoked and the communication status is reset to false, as the listener implicitly accesses the status which is passed as a parameter to that operation. The status is reset prior to calling the listener, so if the application calls the get<status_name>Status from inside the listener it will see the status already reset. The following statuses are applicable to the PublisherListener:

OfferedDeadlineMissedStatus
OfferedIncompatibleQosStatus
LivelinessLostStatus
PublicationMatchedStatus

Status Propagation:

In case a communication status is not activated in the statuses of the PublisherListener, the status will be propagated to the DomainParticipantListener of the containing DomainParticipant. In case the DomainParticipantListener is also not attached or the communication status is not activated in its mask, the application is not notified of the change.

Parameters

qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Publisher will be created.
listener	The listener to be attached.
statuses	Of which status changes the listener should be notified. A null collection signifies all status changes.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: createPublisher()

Returns: a Publisher object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 215 of file DomainParticipantImpl.java.

◆ createPublisher() [4/4]

Publisher org.opensplice.dds.domain.DomainParticipantImpl.createPublisher	(	PublisherQos	qos,
		PublisherListener	listener,
		Class<? extends Status >...	statuses
	)

This operation creates a Publisher.

The created Publisher belongs to the DomainParticipant that is its factory.

For each communication status, the StatusChangedFlag flag is initially set to false. It becomes true whenever that communication status changes. For each communication status activated in the mask, the associated org.omg.dds.pub.PublisherListener operation is invoked and the communication status is reset to false, as the listener implicitly accesses the status which is passed as a parameter to that operation. The status is reset prior to calling the listener, so if the application calls the get<status_name>Status from inside the listener it will see the status already reset. The following statuses are applicable to the PublisherListener:

OfferedDeadlineMissedStatus
OfferedIncompatibleQosStatus
LivelinessLostStatus
PublicationMatchedStatus

Status Propagation:

In case a communication status is not activated in the statuses of the PublisherListener, the status will be propagated to the DomainParticipantListener of the containing DomainParticipant. In case the DomainParticipantListener is also not attached or the communication status is not activated in its mask, the application is not notified of the change.

Parameters

qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Publisher will be created.
listener	The listener to be attached.
statuses	Of which status changes the listener should be notified. A null collection signifies all status changes.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: createPublisher()

Returns: a Publisher object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 229 of file DomainParticipantImpl.java.

◆ createSubscriber() [1/4]

Subscriber org.opensplice.dds.domain.DomainParticipantImpl.createSubscriber ( )

This operation creates a Subscriber with default QoS policies and no SubscriberListener.

The created Subscriber belongs to the DomainParticipant that is its factory.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

Returns: a Subscriber object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 235 of file DomainParticipantImpl.java.

◆ createSubscriber() [2/4]

Subscriber org.opensplice.dds.domain.DomainParticipantImpl.createSubscriber ( SubscriberQos qos )

This operation creates a Subscriber.

The created Subscriber belongs to the DomainParticipant that is its factory.

Parameters

qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Subscriber will be created.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: createSubscriber()

Returns: a Subscriber object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 240 of file DomainParticipantImpl.java.

◆ createSubscriber() [3/4]

Subscriber org.opensplice.dds.domain.DomainParticipantImpl.createSubscriber	(	SubscriberQos	qos,
		SubscriberListener	listener,
		Collection< Class<? extends Status >>	statuses
	)

This operation creates a Subscriber.

The created Subscriber belongs to the DomainParticipant that is its factory. For each communication status, the StatusChangedFlag flag is initially set to false. It becomes true whenever that communication status changes. For each communication status activated in the mask, the associated org.omg.dds.sub.SubscriberListener operation is invoked and the communication status is reset to false, as the listener implicitly accesses the status which is passed as a parameter to that operation. The status is reset prior to calling the listener, so if the application calls the get<status_name>Status from inside the listener it will see the status already reset. The following statuses are applicable to the SubscriberListener:

RequestedDeadlineMissedStatus
RequestedIncompatibleQosStatus
SampleRejectedStatus
LivelinessChangedStatus
DataAvailableStatus
DataOnReadersStatus
SubscriptionMatchedStatus
SampleLostStatus

Status Propagation:

In case a communication status is not activated in the statuses of the SubscriberListener, the communication status will be propagated to the DomainParticipantListener of the containing DomainParticipant. In case the DomainParticipantListener is also not attached or the communication status is not activated in its mask, the application is not notified of the change.

Parameters

qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Subscriber will be created.
listener	The listener to be attached.
statuses	Of which status changes the listener should be notified. A null collection signifies all status changes.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: createSubscriber()

Returns: a Subscriber object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 246 of file DomainParticipantImpl.java.

◆ createSubscriber() [4/4]

Subscriber org.opensplice.dds.domain.DomainParticipantImpl.createSubscriber	(	SubscriberQos	qos,
		SubscriberListener	listener,
		Class<? extends Status >...	statuses
	)

This operation creates a Subscriber.

The created Subscriber belongs to the DomainParticipant that is its factory.

For each communication status, the StatusChangedFlag flag is initially set to false. It becomes true whenever that communication status changes. For each communication status activated in the mask, the associated org.omg.dds.sub.SubscriberListener operation is invoked and the communication status is reset to false, as the listener implicitly accesses the status which is passed as a parameter to that operation. The status is reset prior to calling the listener, so if the application calls the get<status_name>Status from inside the listener it will see the status already reset. The following statuses are applicable to the SubscriberListener:

RequestedDeadlineMissedStatus
RequestedIncompatibleQosStatus
SampleRejectedStatus
LivelinessChangedStatus
DataAvailableStatus
DataOnReadersStatus
SubscriptionMatchedStatus
SampleLostStatus

Status Propagation:

In case a communication status is not activated in the statuses of the SubscriberListener, the communication status will be propagated to the DomainParticipantListener of the containing DomainParticipant. In case the DomainParticipantListener is also not attached or the communication status is not activated in its mask, the application is not notified of the change.

Parameters

qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Subscriber will be created.
listener	The listener to be attached.
statuses	Of which status changes the listener should be notified. A null collection signifies all status changes.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: createSubscriber()

Returns: a Subscriber object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 260 of file DomainParticipantImpl.java.

◆ createTopic() [1/6]

Topic<DynamicType> org.opensplice.dds.domain.DomainParticipantImpl.createTopic	(	String	topicName,
		DynamicType	type
	)

This operation creates a Topic with default QoS policies and no TopicListener.

The created Topic belongs to the DomainParticipant that is its factory.

NOTE: Topics with a DynamicType are currently not supported by OpenSplice!

Parameters

topicName	The name of the new Topic.
type	A org.omg.dds.type.dynamic.DynamicType of all samples to be published and subscribed over the new Topic. The Service will attempt to locate an appropriate org.omg.dds.type.TypeSupport instance based on this type.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: #createTopic(String, Class)

Returns: a Topic object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 347 of file DomainParticipantImpl.java.

◆ createTopic() [2/6]

Topic<DynamicType> org.opensplice.dds.domain.DomainParticipantImpl.createTopic	(	String	topicName,
		DynamicType	type,
		TopicQos	qos,
		TopicListener< DynamicType >	listener,
		Collection< Class<? extends Status >>	statuses
	)

This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener.

The created Topic belongs to the DomainParticipant that is its factory.

NOTE: Topics with a DynamicType are currently not supported by OpenSplice!

For each communication status, the StatusChangedFlag flag is initially set to false. It becomes true whenever that communication status changes. For each communication status activated in the mask, the associated org.omg.dds.topic.TopicListener operation is invoked and the communication status is reset to false, as the listener implicitly accesses the status which is passed as a parameter to that operation. The status is reset prior to calling the listener, so if the application calls the get<status_name>Status from inside the listener it will see the status already reset. The following statuses are applicable to the PublisherListener:

InconsistentTopicStatus
AllDataDisposedStatus

Status Propagation:

In case a communication status is not activated in the statuses of the TopicListener, the status will be propagated to the DomainParticipantListener of the containing DomainParticipant. In case the DomainParticipantListener is also not attached or the communication status is not activated in its mask, the application is not notified of the change.

Parameters

topicName	The name of the new Topic.
type	A org.omg.dds.type.dynamic.DynamicType of all samples to be published and subscribed over the new Topic. The Service will attempt to locate an appropriate org.omg.dds.type.TypeSupport instance based on this type.
qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Publisher will be created.
listener	The listener to be attached.
statuses	Of which status changes the listener should be notified. A null collection signifies all status changes.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: #createTopic(String, Class)

Returns: a Topic object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 353 of file DomainParticipantImpl.java.

◆ createTopic() [3/6]

Topic<DynamicType> org.opensplice.dds.domain.DomainParticipantImpl.createTopic	(	String	topicName,
		DynamicType	type,
		TopicQos	qos,
		TopicListener< DynamicType >	listener,
		Class<? extends Status >...	statuses
	)

This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener.

The created Topic belongs to the DomainParticipant that is its factory.

NOTE: Topics with a DynamicType are currently not supported by OpenSplice!

For each communication status, the StatusChangedFlag flag is initially set to false. It becomes true whenever that communication status changes. For each communication status activated in the mask, the associated org.omg.dds.topic.TopicListener operation is invoked and the communication status is reset to false, as the listener implicitly accesses the status which is passed as a parameter to that operation. The status is reset prior to calling the listener, so if the application calls the get<status_name>Status from inside the listener it will see the status already reset. The following statuses are applicable to the PublisherListener:

InconsistentTopicStatus
AllDataDisposedStatus

Status Propagation:

In case a communication status is not activated in the statuses of the TopicListener, the status will be propagated to the DomainParticipantListener of the containing DomainParticipant. In case the DomainParticipantListener is also not attached or the communication status is not activated in its mask, the application is not notified of the change.

Parameters

topicName	The name of the new Topic.
type	A org.omg.dds.type.dynamic.DynamicType of all samples to be published and subscribed over the new Topic. The Service will attempt to locate an appropriate org.omg.dds.type.TypeSupport instance based on this type.
qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Publisher will be created.
listener	The listener to be attached.
statuses	Of which status changes the listener should be notified. A null collection signifies all status changes.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: #createTopic(String, Class)

Returns: a Topic object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 361 of file DomainParticipantImpl.java.

◆ createTopic() [4/6]

Topic<DynamicType> org.opensplice.dds.domain.DomainParticipantImpl.createTopic	(	String	topicName,
		DynamicType	type,
		TypeSupport< DynamicType >	typeSupport
	)

This operation creates a Topic with default QoS policies and no TopicListener.

The created Topic belongs to the DomainParticipant that is its factory.

NOTE: Topics with a DynamicType are currently not supported by OpenSplice!

Parameters

topicName	The name of the new Topic.
type	A org.omg.dds.type.dynamic.DynamicType representing the type of all samples to be published and subscribed over the new Topic.
typeSupport	A org.omg.dds.type.TypeSupport for org.omg.dds.type.dynamic.DynamicType.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: #createTopic(String, Class)

Returns: a Topic object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 369 of file DomainParticipantImpl.java.

◆ createTopic() [5/6]

Topic<DynamicType> org.opensplice.dds.domain.DomainParticipantImpl.createTopic	(	String	topicName,
		DynamicType	type,
		TypeSupport< DynamicType >	typeSupport,
		TopicQos	qos,
		TopicListener< DynamicType >	listener,
		Collection< Class<? extends Status >>	statuses
	)

This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener.

The created Topic belongs to the DomainParticipant that is its factory.

NOTE: Topics with a DynamicType are currently not supported by OpenSplice!

For each communication status, the StatusChangedFlag flag is initially set to false. It becomes true whenever that communication status changes. For each communication status activated in the mask, the associated org.omg.dds.topic.TopicListener operation is invoked and the communication status is reset to false, as the listener implicitly accesses the status which is passed as a parameter to that operation. The status is reset prior to calling the listener, so if the application calls the get<status_name>Status from inside the listener it will see the status already reset. The following statuses are applicable to the PublisherListener:

InconsistentTopicStatus
AllDataDisposedStatus

Status Propagation:

In case a communication status is not activated in the statuses of the TopicListener, the status will be propagated to the DomainParticipantListener of the containing DomainParticipant. In case the DomainParticipantListener is also not attached or the communication status is not activated in its mask, the application is not notified of the change.

Parameters

topicName	The name of the new Topic.
type	A org.omg.dds.type.dynamic.DynamicType
typeSupport	A org.omg.dds.type.TypeSupport for org.omg.dds.type.dynamic.DynamicType
qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Publisher will be created.
listener	The listener to be attached.
statuses	Of which status changes the listener should be notified. A null collection signifies all status changes.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: #createTopic(String, Class)

Returns: a Topic object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 377 of file DomainParticipantImpl.java.

◆ createTopic() [6/6]

Topic<DynamicType> org.opensplice.dds.domain.DomainParticipantImpl.createTopic	(	String	topicName,
		DynamicType	type,
		TypeSupport< DynamicType >	typeSupport,
		TopicQos	qos,
		TopicListener< DynamicType >	listener,
		Class<? extends Status >...	statuses
	)

This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener.

The created Topic belongs to the DomainParticipant that is its factory.

NOTE: Topics with a DynamicType are currently not supported by OpenSplice!

For each communication status, the StatusChangedFlag flag is initially set to false. It becomes true whenever that communication status changes. For each communication status activated in the mask, the associated org.omg.dds.topic.TopicListener operation is invoked and the communication status is reset to false, as the listener implicitly accesses the status which is passed as a parameter to that operation. The status is reset prior to calling the listener, so if the application calls the get<status_name>Status from inside the listener it will see the status already reset. The following statuses are applicable to the PublisherListener:

InconsistentTopicStatus
AllDataDisposedStatus

Status Propagation:

In case a communication status is not activated in the statuses of the TopicListener, the status will be propagated to the DomainParticipantListener of the containing DomainParticipant. In case the DomainParticipantListener is also not attached or the communication status is not activated in its mask, the application is not notified of the change.

Parameters

topicName	The name of the new Topic.
type	A org.omg.dds.type.dynamic.DynamicType
typeSupport	A org.omg.dds.type.TypeSupport for org.omg.dds.type.dynamic.DynamicType
qos	The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Publisher will be created.
listener	The listener to be attached.
statuses	Of which status changes the listener should be notified. A null collection signifies all status changes.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.InconsistentPolicyException	The parameter qos contains conflicting QosPolicy settings.

See also: #createTopic(String, Class)

Returns: a Topic object

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 386 of file DomainParticipantImpl.java.

◆ deleteHistoricalData()

void org.opensplice.dds.domain.DomainParticipantImpl.deleteHistoricalData	(	String	partitionExpression,
		String	topicExpression
	)

Definition at line 984 of file DomainParticipantImpl.java.

◆ destroy()

void org.opensplice.dds.domain.DomainParticipantImpl.destroy ( )

protected

Definition at line 842 of file DomainParticipantImpl.java.

◆ destroyPublisher()

void org.opensplice.dds.domain.DomainParticipantImpl.destroyPublisher ( PublisherImpl child )

Definition at line 933 of file DomainParticipantImpl.java.

◆ destroySubscriber()

void org.opensplice.dds.domain.DomainParticipantImpl.destroySubscriber ( SubscriberImpl child )

Definition at line 944 of file DomainParticipantImpl.java.

◆ enable() [1/2]

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

inherited

Definition at line 153 of file EntityImpl.java.

◆ enable() [2/2]

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

inherited

This operation enables the Entity.

Entity objects can be created either enabled or disabled. This is controlled by the value of the org.omg.dds.core.policy.EntityFactory on the corresponding factory for the Entity.

The default setting of org.omg.dds.core.policy.EntityFactory is such that, by default, it is not necessary to explicitly call enable on newly created entities.

The enable operation is idempotent. Calling enable on an already enabled Entity has no effect.

If an Entity has not yet been enabled, the following kinds of operations may be invoked on it:

Operations to set or get an Entity's QoS policies (including default QoS policies) and listener
getStatusCondition()
'factory' operations and close()
getStatusChanges() and other get status operations (although the status of a disabled entity never changes)
'lookup' operations

Other operations may explicitly state that they may be called on disabled entities; those that do not will fail with org.omg.dds.core.NotEnabledException.

It is legal to delete an Entity that has not been enabled by calling close(). Entities created from a factory that is disabled are created disabled regardless of the setting of org.omg.dds.core.policy.EntityFactory.

Calling enable on an Entity whose factory is not enabled will fail with org.omg.dds.core.PreconditionNotMetException.

If org.omg.dds.core.policy.EntityFactory#isAutoEnableCreatedEntities() is true, the enable operation on the factory will automatically enable all entities created from the factory.

The Listeners associated with an entity are not called until the entity is enabled. org.omg.dds.core.Conditions associated with an entity that is not enabled are "inactive," that is, have a triggerValue == false.

In addition to the general description, the enable operation on a org.omg.dds.sub.Subscriber has special meaning in specific usecases. This applies only to Subscribers with PresentationQoS coherent-access set to true with access-scope set to group.

In this case the subscriber is always created in a disabled state, regardless of the factory's auto-enable created entities setting. While the subscriber remains disabled, DataReaders can be created that will participate in coherent transactions of the subscriber.

See org.omg.dds.sub.Subscriber#beginAccess() and org.omg.dds.sub.Subscriber#endAccess() for more information.

All DataReaders will also be created in a disabled state. Coherency with group access-scope requires data to be delivered as a transaction, atomically, to all eligible readers. Therefore data should not be delivered to any single DataReader immediately after it's created, as usual, but only after the application has finished creating all DataReaders for a given Subscriber. At this point, the application should enable the Subscriber which in turn enables all its DataReaders.

Note that for a DataWriter which has a corresponding Publisher with a PresentationQoS with coherent-access set to true and access-scope set to topic or group that the HistoryQoS of the DataWriter should be set to KEEP_ALL otherwise the enable operation will fail. See org.omg.dds.pub.Publisher#createDataWriter(Topic, DataWriterQos, DataWriterListener, Collection)

◆ getBuiltinSubscriber()

Subscriber org.opensplice.dds.domain.DomainParticipantImpl.getBuiltinSubscriber ( )

This operation allows access to the built-in Subscriber.

Each DomainParticipant contains several built-in org.omg.dds.topic.Topic objects as well as corresponding org.omg.dds.sub.DataReader objects to access them. All these DataReader objects belong to a single built-in Subscriber.

The built-in Topics are used to communicate information about other DomainParticipant, Topic, org.omg.dds.sub.DataReader, and org.omg.dds.pub.DataWriter objects.

Returns: the built-in subscriber

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 266 of file DomainParticipantImpl.java.

◆ getCurrentTime() [1/2]

ModifiableTime org.opensplice.dds.domain.DomainParticipantImpl.getCurrentTime ( ModifiableTime currentTime )

This operation returns the current value of the time that the service uses to time stamp data writes and to set the reception time stamp for the data updates it receives.

Parameters

currentTime a container for the current time, which the Service will overwrite with the result of this operation, or null, if the Service should store the current time in a new object.

Returns: currentTime, if it is non-null, or a new object otherwise.

See also: getCurrentTime()

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 801 of file DomainParticipantImpl.java.

◆ getCurrentTime() [2/2]

Time org.opensplice.dds.domain.DomainParticipantImpl.getCurrentTime ( )

This operation returns the current value of the time that the service uses to time stamp data writes and to set the reception time stamp for the data updates it receives.

Returns: an immutable object containing the current time.

See also: getCurrentTime(ModifiableTime)

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 820 of file DomainParticipantImpl.java.

◆ getDefaultPublisherQos()

PublisherQos org.opensplice.dds.domain.DomainParticipantImpl.getDefaultPublisherQos ( )

This operation retrieves the default value of the Publisher QoS, that is, the QoS policies which will be used for newly created org.omg.dds.pub.Publisher entities in the case where the QoS policies are defaulted in the createPublisher() operation.

The values retrieved will match the set of values specified on the last successful call to setDefaultPublisherQos(PublisherQos), or else, if the call was never made, the default values identified by the DDS specification.

See also: setDefaultPublisherQos(PublisherQos)

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 654 of file DomainParticipantImpl.java.

◆ getDefaultSubscriberQos()

SubscriberQos org.opensplice.dds.domain.DomainParticipantImpl.getDefaultSubscriberQos ( )

This operation retrieves the default value of the Subscriber QoS, that is, the QoS policies which will be used for newly created org.omg.dds.sub.Subscriber entities in the case where the QoS policies are defaulted in the createSubscriber() operation.

The values retrieved will match the set of values specified on the last successful call to setDefaultSubscriberQos(SubscriberQos), or else, if the call was never made, the default values identified by the DDS specification.

See also: setDefaultSubscriberQos(SubscriberQos)

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 679 of file DomainParticipantImpl.java.

◆ getDefaultTopicQos()

TopicQos org.opensplice.dds.domain.DomainParticipantImpl.getDefaultTopicQos ( )

This operation retrieves the default value of the Topic QoS, that is, the QoS policies which will be used for newly created org.omg.dds.topic.Topic entities in the case where the QoS policies are defaulted in the createTopic(String, Class) operation.

The values retrieved will match the set of values specified on the last successful call to setDefaultTopicQos(TopicQos), or else, if the call was never made, the default values identified by the DDS specification.

See also: setDefaultTopicQos(TopicQos)

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 704 of file DomainParticipantImpl.java.

◆ getDiscoveredParticipantData()

ParticipantBuiltinTopicData org.opensplice.dds.domain.DomainParticipantImpl.getDiscoveredParticipantData ( InstanceHandle participantHandle )

This operation retrieves information on a DomainParticipant that has been discovered on the network.

The participant must be in the same domain as the participant on which this operation is invoked and must not have been "ignored" by means of the ignoreParticipant(InstanceHandle) operation.

Use the operation getDiscoveredParticipants() to find the DomainParticipants that are currently discovered.

Parameters

participantHandle a handle to the participant, the data of which is to be retrieved.

Returns: a new object containing a copy of the information.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the participantHandle does not correspond to a DomainParticipant such as is described above.
UnsupportedOperationException	If the infrastructure does not locally maintain the connectivity information.

See also: getDiscoveredParticipants(); getDiscoveredTopicData(InstanceHandle)

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 745 of file DomainParticipantImpl.java.

◆ getDiscoveredParticipants()

Set<InstanceHandle> org.opensplice.dds.domain.DomainParticipantImpl.getDiscoveredParticipants ( )

This operation retrieves the list of DomainParticipants that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the ignoreParticipant(InstanceHandle) operation.

Returns: a new collection containing a copy of the information.

Exceptions

UnsupportedOperationException If the infrastructure does not locally maintain the connectivity information.

See also: getDiscoveredParticipantData(InstanceHandle); getDiscoveredTopics()

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 728 of file DomainParticipantImpl.java.

◆ getDiscoveredTopicData()

TopicBuiltinTopicData org.opensplice.dds.domain.DomainParticipantImpl.getDiscoveredTopicData ( InstanceHandle topicHandle )

This operation retrieves information on a org.omg.dds.topic.Topic that has been discovered on the network.

The topic must be in the same domain as the participant on which this operation is invoked and must not have been "ignored" by means of the ignoreTopic(InstanceHandle) operation.

Use the operation getDiscoveredTopics() to find the Topics that are currently discovered.

Parameters

topicHandle a handle to the topic, the data of which is to be retrieved.

Returns: a new object containing a copy of the information.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the topicHandle does not correspond to a Topic such as is described above.
UnsupportedOperationException	If the infrastructure does not locally maintain the connectivity information or if the infrastructure does not hold the information necessary to fill in the topicData.

See also: getDiscoveredTopics(); getDiscoveredParticipantData(InstanceHandle)

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 779 of file DomainParticipantImpl.java.

◆ getDiscoveredTopics()

Set<InstanceHandle> org.opensplice.dds.domain.DomainParticipantImpl.getDiscoveredTopics ( )

This operation retrieves the list of org.omg.dds.topic.Topics that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the ignoreTopic(InstanceHandle) operation.

Returns: a new collection containing a copy of the information.

Exceptions

UnsupportedOperationException If the infrastructure does not locally maintain the connectivity information.

See also: getDiscoveredTopicData(InstanceHandle); getDiscoveredParticipants()

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 762 of file DomainParticipantImpl.java.

◆ getDomainId()

int org.opensplice.dds.domain.DomainParticipantImpl.getDomainId ( )

This operation retrieves the domain ID used to create the DomainParticipant.

The domain ID identifies the DDS domain to which the DomainParticipant belongs. Each DDS domain represents a separate data "communication plane" isolated from other domains.

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 641 of file DomainParticipantImpl.java.

◆ getEnvironment() [1/2]

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )

inherited

Returns: the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

◆ getEnvironment() [2/2]

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

inherited

Definition at line 121 of file EntityImpl.java.

◆ getInstanceHandle() [1/2]

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

inherited

Definition at line 166 of file EntityImpl.java.

◆ getInstanceHandle() [2/2]

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

inherited

Returns: the org.omg.dds.core.InstanceHandle that represents the Entity.

◆ getListener() [1/2]

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

inherited

This operation allows access to the existing Listener attached to the Entity.

Returns: The attached listener if set, or null otherwise.

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

◆ getListener() [2/2]

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

inherited

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 ( )

inherited

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 ( )

inherited

Definition at line 116 of file EntityImpl.java.

◆ getProperty()

String org.opensplice.dds.domain.DomainParticipantImpl.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 1009 of file DomainParticipantImpl.java.

◆ getQos()

DomainParticipantQos org.opensplice.dds.domain.DomainParticipantImpl.getQos ( )

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)

Implements org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.

Definition at line 171 of file DomainParticipantImpl.java.

◆ getStatusChanges() [1/2]

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 ( )

inherited

Definition at line 160 of file EntityImpl.java.

◆ getStatusChanges() [2/2]

Set<Class<? extends Status> > org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.getStatusChanges ( )

inherited

This operation retrieves the list of communication statuses in the Entity that are 'triggered.

' That is, the list of statuses whose value has changed since the last time the application read the status.

When the entity is first created or if the entity is not enabled, all communication statuses are in the "untriggered" state so the list returned will be empty.

The list of statuses returned refers to the statuses that are triggered on the Entity itself and does not include statuses that apply to contained entities.

Returns: a new Set containing the triggered statuses.

◆ getStatusCondition()

StatusCondition<DomainParticipant> org.opensplice.dds.domain.DomainParticipantImpl.getStatusCondition ( )

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.

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 831 of file DomainParticipantImpl.java.

◆ ignoreParticipant()

void org.opensplice.dds.domain.DomainParticipantImpl.ignoreParticipant ( InstanceHandle handle )

This operation allows an application to instruct the Service to locally ignore a remote domain participant.

From that point onwards, the Service will locally behave as if the remote participant did not exist. This means it will ignore any org.omg.dds.topic.Topic, publication, or subscription that originates on that domain participant.

This operation can be used, in conjunction with the discovery of remote participants offered by means of the "DCPSParticipant" built-in Topic, to provide, for example, access control. Application data can be associated with a DomainParticipant by means of the org.omg.dds.core.policy.UserData. This application data is propagated as a field in the built-in topic and can be used by an application to implement its own access control policy.

The domain participant to ignore is identified by the handle argument. This handle is the one that appears in the org.omg.dds.sub.Sample retrieved when reading the data samples available for the built-in DataReader to the "DCPSParticipant" topic. The built-in org.omg.dds.sub.DataReader is read with the same read/take operations used for any DataReader.

This operation is not required to be reversible. The Service offers no means to reverse it.

Parameters

handle the instance handle of the entity which needs to be ignored

Exceptions

org.omg.dds.core.OutOfResourcesException	if the Service is unable to ignore the indicated participant because an internal resource has been exhausted.
java.lang.UnsupportedOperationException	if the supplied operation is not implemented.

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 582 of file DomainParticipantImpl.java.

◆ ignorePublication()

void org.opensplice.dds.domain.DomainParticipantImpl.ignorePublication ( InstanceHandle handle )

This operation allows an application to instruct the Service to locally ignore a remote publication; a publication is defined by the association of a topic name, and user data and partition set on the org.omg.dds.pub.Publisher.

After this call, any data written related to that publication will be ignored.

The org.omg.dds.pub.DataWriter to ignore is identified by the handle argument. This handle is the one that appears in the org.omg.dds.sub.Sample retrieved when reading the data samples from the built-in org.omg.dds.sub.DataReader to the "DCPSPublication" topic.

This operation is not required to be reversible. The Service offers no means to reverse it.

Parameters

handle the instance handle of the entity which needs to be ignored

Exceptions

org.omg.dds.core.OutOfResourcesException	if the Service is unable to ignore the indicated publication because an internal resource has been exhausted.
java.lang.UnsupportedOperationException	if the supplied operation is not implemented.

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 611 of file DomainParticipantImpl.java.

◆ ignoreSubscription()

void org.opensplice.dds.domain.DomainParticipantImpl.ignoreSubscription ( InstanceHandle handle )

This operation allows an application to instruct the Service to locally ignore a remote subscription; a subscription is defined by the association of a topic name, and user data and partition set on the org.omg.dds.sub.Subscriber.

After this call, any data received related to that subscription will be ignored.

The org.omg.dds.sub.DataReader to ignore is identified by the handle argument. This handle is the one that appears in the org.omg.dds.sub.Sample retrieved when reading the data samples from the built-in DataReader to the "DCPSSubscription" topic.

This operation is not required to be reversible. The Service offers no means to reverse it.

Parameters

handle the instance handle of the entity which needs to be ignored

Exceptions

org.omg.dds.core.OutOfResourcesException	if the Service is unable to ignore the indicated subscription because an internal resource has been exhausted.
java.lang.UnsupportedOperationException	if the supplied operation is not implemented.

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 626 of file DomainParticipantImpl.java.

◆ ignoreTopic()

void org.opensplice.dds.domain.DomainParticipantImpl.ignoreTopic ( InstanceHandle handle )

This operation allows an application to instruct the Service to locally ignore a org.omg.dds.topic.Topic.

This means it will locally ignore any publication or subscription to the Topic.

This operation can be used to save local resources when the application knows that it will never publish or subscribe to data under certain topics.

The Topic to ignore is identified by the handle argument. This handle is the one that appears in the org.omg.dds.sub.Sample retrieved when reading the data samples from the built-in org.omg.dds.sub.DataReader to the "DCPSTopic" topic.

This operation is not required to be reversible. The Service offers no means to reverse it.

Parameters

handle the instance handle of the entity which needs to be ignored

Exceptions

org.omg.dds.core.OutOfResourcesException	if the Service is unable to ignore the indicated topic because an internal resource has been exhausted.
java.lang.UnsupportedOperationException	if the supplied operation is not implemented.

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 596 of file DomainParticipantImpl.java.

◆ lookupSubscriber()

org.omg.dds.sub.Subscriber org.opensplice.dds.domain.DomainParticipantImpl.lookupSubscriber ( DDS.Subscriber subs )

Definition at line 911 of file DomainParticipantImpl.java.

◆ printReferences()

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

staticinherited

Definition at line 66 of file EntityImpl.java.

◆ retain() [1/2]

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

inherited

Definition at line 126 of file EntityImpl.java.

◆ retain() [2/2]

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

inherited

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.

◆ setDefaultPublisherQos()

void org.opensplice.dds.domain.DomainParticipantImpl.setDefaultPublisherQos ( PublisherQos qos )

This operation sets a default value of the Publisher QoS policies, which will be used for newly created org.omg.dds.pub.Publisher entities in the case where the QoS policies are defaulted in the createPublisher() operation.

Parameters

qos	the new publisher qos.

Exceptions

org.omg.dds.core.InconsistentPolicyException if the resulting policies are not self consistent; in that case, the operation will have no effect.

See also: getDefaultPublisherQos()

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 663 of file DomainParticipantImpl.java.

◆ setDefaultSubscriberQos()

void org.opensplice.dds.domain.DomainParticipantImpl.setDefaultSubscriberQos ( SubscriberQos qos )

This operation sets a default value of the Subscriber QoS policies that will be used for newly created org.omg.dds.sub.Subscriber entities in the case where the QoS policies are defaulted in the createSubscriber() operation.

Parameters

qos	the new subscriber qos.

Exceptions

org.omg.dds.core.InconsistentPolicyException if the resulting policies are not self consistent; in that case, the operation will have no effect.

See also: getDefaultSubscriberQos()

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 688 of file DomainParticipantImpl.java.

◆ setDefaultTopicQos()

void org.opensplice.dds.domain.DomainParticipantImpl.setDefaultTopicQos ( TopicQos qos )

This operation sets a default value of the Topic QoS policies, which will be used for newly created org.omg.dds.topic.Topic entities in the case where the QoS policies are defaulted in the createTopic(String, Class) operation.

Parameters

qos	the new topic qos.

Exceptions

org.omg.dds.core.InconsistentPolicyException if the resulting policies are not self consistent; in that case, the operation will have no effect.

See also: getDefaultTopicQos()

Implements org.omg.dds.domain.DomainParticipant.

Definition at line 714 of file DomainParticipantImpl.java.

◆ setListener() [1/9]

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/9]

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() [3/9]

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() [4/9]

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() [5/9]

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)

◆ setListener() [6/9]

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)

◆ setListener() [7/9]

void org.opensplice.dds.domain.DomainParticipantImpl.setListener ( org.omg.dds.domain.DomainParticipantListener listener )

Definition at line 848 of file DomainParticipantImpl.java.

◆ setListener() [8/9]

void org.opensplice.dds.domain.DomainParticipantImpl.setListener	(	org.omg.dds.domain.DomainParticipantListener	listener,
		Collection< Class<? extends Status >>	statuses
	)

Definition at line 855 of file DomainParticipantImpl.java.

◆ setListener() [9/9]

void org.opensplice.dds.domain.DomainParticipantImpl.setListener	(	DomainParticipantListener	listener,
		Class<? extends Status >...	statuses
	)

Definition at line 863 of file DomainParticipantImpl.java.

◆ 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 )

protectedinherited

Definition at line 112 of file EntityImpl.java.

◆ setProperty()

void org.opensplice.dds.domain.DomainParticipantImpl.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 1002 of file DomainParticipantImpl.java.

◆ setQos() [1/3]

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()

◆ setQos() [2/3]

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()

◆ setQos() [3/3]

void org.opensplice.dds.domain.DomainParticipantImpl.setQos ( DomainParticipantQos qos )

Definition at line 184 of file DomainParticipantImpl.java.

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

protectedinherited

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

protectedinherited

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/domain/DomainParticipantImpl.java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DomainParticipantImpl()

Member Function Documentation

◆ assertLiveliness()

◆ close() [1/2]

◆ close() [2/2]

◆ closeContainedEntities()

◆ containsEntity()

◆ createPersistentSnapshot()

◆ createPublisher() [1/4]

◆ createPublisher() [2/4]

◆ createPublisher() [3/4]

◆ createPublisher() [4/4]

◆ createSubscriber() [1/4]

◆ createSubscriber() [2/4]

◆ createSubscriber() [3/4]

◆ createSubscriber() [4/4]

◆ createTopic() [1/6]

◆ createTopic() [2/6]

◆ createTopic() [3/6]

◆ createTopic() [4/6]

◆ createTopic() [5/6]

◆ createTopic() [6/6]

◆ deleteHistoricalData()

◆ destroy()

◆ destroyPublisher()

◆ destroySubscriber()

◆ enable() [1/2]

◆ enable() [2/2]

◆ getBuiltinSubscriber()

◆ getCurrentTime() [1/2]

◆ getCurrentTime() [2/2]

◆ getDefaultPublisherQos()

◆ getDefaultSubscriberQos()

◆ getDefaultTopicQos()

◆ getDiscoveredParticipantData()

◆ getDiscoveredParticipants()

◆ getDiscoveredTopicData()

◆ getDiscoveredTopics()

◆ getDomainId()

◆ getEnvironment() [1/2]

◆ getEnvironment() [2/2]

◆ getInstanceHandle() [1/2]

◆ getInstanceHandle() [2/2]

◆ getListener() [1/2]

◆ getListener() [2/2]

◆ getOld()

◆ getOldParent()

◆ getProperty()

◆ getQos()

◆ getStatusChanges() [1/2]

◆ getStatusChanges() [2/2]

◆ getStatusCondition()

◆ ignoreParticipant()

◆ ignorePublication()

◆ ignoreSubscription()

◆ ignoreTopic()

◆ lookupSubscriber()

◆ printReferences()

◆ retain() [1/2]

◆ retain() [2/2]

◆ setDefaultPublisherQos()

◆ setDefaultSubscriberQos()

◆ setDefaultTopicQos()

◆ setListener() [1/9]

◆ setListener() [2/9]

◆ setListener() [3/9]

◆ setListener() [4/9]

◆ setListener() [5/9]

◆ setListener() [6/9]

◆ setListener() [7/9]

◆ setListener() [8/9]

◆ setListener() [9/9]

◆ setOld()

◆ setProperty()