 |
OpenSplice Java 5 DCPS
v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
|
|
OpenSplice Java 5 DCPS
v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
|
OpenSplice-specific extension of org.omg.dds.domain.DomainParticipant with support for deleting historical data from the durability service and creating a snapshot of current persistent data. More...
Public Member Functions | |
| void | assertLiveliness () |
| This operation manually asserts the liveliness of the DomainParticipant. More... | |
| 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... | |
| public< TYPE > ContentFilteredTopic< TYPE > | createContentFilteredTopic (String name, Topic<? extends TYPE > relatedTopic, String filterExpression, List< String > expressionParameters) |
| This operation creates a org.omg.dds.topic.ContentFilteredTopic. More... | |
| public< TYPE > ContentFilteredTopic< TYPE > | createContentFilteredTopic (String name, Topic<? extends TYPE > relatedTopic, String filterExpression, String... expressionParameters) |
| This operation creates a org.omg.dds.topic.ContentFilteredTopic. More... | |
| public< TYPE > MultiTopic< TYPE > | createMultiTopic (String name, Class< TYPE > type, String subscriptionExpression, List< String > expressionParameters) |
| This operation creates a MultiTopic. More... | |
| public< TYPE > MultiTopic< TYPE > | createMultiTopic (String name, Class< TYPE > type, String subscriptionExpression, String... expressionParameters) |
| This operation creates a MultiTopic. More... | |
| public< TYPE > MultiTopic< TYPE > | createMultiTopic (String name, TypeSupport< TYPE > type, String subscriptionExpression, List< String > expressionParameters) |
| This operation creates a MultiTopic. More... | |
| public< TYPE > MultiTopic< TYPE > | createMultiTopic (String name, TypeSupport< TYPE > type, String subscriptionExpression, String... expressionParameters) |
| This operation creates a MultiTopic. More... | |
| void | createPersistentSnapshot (String partitionExpression, String topicExpression, String uri) |
| This operation will create a snapshot of all persistent data matching the provided partition and topic expressions and store the snapshot at the location indicated by the URI. More... | |
| 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... | |
| public< TYPE > Topic< TYPE > | createTopic (String topicName, Class< TYPE > type) |
| This operation creates a Topic with default QoS policies and no TopicListener. More... | |
| public< TYPE > Topic< TYPE > | createTopic (String topicName, Class< TYPE > type, TopicQos qos, TopicListener< TYPE > listener, Collection< Class<? extends Status >> statuses) |
| This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener. More... | |
| public< TYPE > Topic< TYPE > | createTopic (String topicName, Class< TYPE > type, TopicQos qos, TopicListener< TYPE > listener, Class<? extends Status >... statuses) |
| This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener. More... | |
| public< TYPE > Topic< TYPE > | createTopic (String topicName, TypeSupport< TYPE > type) |
| This operation creates a Topic with default QoS policies and no TopicListener. More... | |
| public< TYPE > Topic< TYPE > | createTopic (String topicName, TypeSupport< TYPE > type, TopicQos qos, TopicListener< TYPE > listener, Collection< Class<? extends Status >> statuses) |
| This operation creates a Topic with the desired QoS policies and attaches to it the specified TopicListener. More... | |
| public< TYPE > Topic< TYPE > | createTopic (String topicName, TypeSupport< TYPE > type, TopicQos qos, TopicListener< TYPE > 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) |
| 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) |
| This operation deletes all historical TRANSIENT and PERSISTENT data that is stored by the durability service that is configured to support this DomainParticipant. More... | |
| void | enable () |
| This operation enables the Entity. More... | |
| public< TYPE > Topic< TYPE > | findTopic (String topicName, Duration timeout) throws TimeoutException |
| This operation gives access to an existing (or ready to exist) enabled Topic, based on its name. More... | |
| public< TYPE > Topic< TYPE > | findTopic (String topicName, long timeout, TimeUnit unit) throws TimeoutException |
| This operation gives access to an existing (or ready to exist) enabled Topic, based on its name. 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 () |
| InstanceHandle | getInstanceHandle () |
| LISTENER | getListener () |
| This operation allows access to the existing Listener attached to the Entity. More... | |
| String | getProperty (String key) |
| This operation looks up the property for a given key in the DomainParticipant, returning the value belonging to this key If the property has not been set using setProperty, the default value of the property is returned. More... | |
| QOS | getQos () |
| This operation allows access to the existing set of QoS policies for the Entity. More... | |
| 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... | |
| public< TYPE > TopicDescription< TYPE > | lookupTopicDescription (String name) |
| This operation gives access to an existing locally-created TopicDescription based on its name. More... | |
| 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, 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 operation sets the property specified by a key value pair. More... | |
| void | setQos (QOS qos) |
| This operation is used to set the QoS policies of the Entity. More... | |
OpenSplice-specific extension of org.omg.dds.domain.DomainParticipant with support for deleting historical data from the durability service and creating a snapshot of current persistent data.
Definition at line 30 of file DomainParticipant.java.
|
inherited |
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.
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
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:
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.
| PreconditionNotMetException | if close is called on an Entity with unclosed dependent object(s), not including contained objects. |
|
inherited |
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.
| org.omg.dds.core.PreconditionNotMetException | if any of the contained entities is in a state where it cannot be closed. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| 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(). |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
This operation creates a org.omg.dds.topic.ContentFilteredTopic.
A ContentFilteredTopic can be used to do content-based subscriptions.
ContentFilteredTopic describes a more sophisticated subscription which indicates that the Subscriber does not necessarily want to see all values of each instance published under the Topic. Rather, it only wants to see the values whose contents satisfy certain criteria. Therefore this class must be used to request content-based subscriptions.
| <TYPE> | The type of all samples subscribed to with the new ContentFilteredTopic. It may be the same as the type of the relatedTopic or any supertype of that type. |
| name | The name of the new ContentFilteredTopic. |
| relatedTopic | The related Topic being subscribed to. The ContentFilteredTopic only relates to samples published under this Topic, filtered according to their content. |
| filterExpression | A logical(SQL) expression that involves the values of some of the data fields in the sample. |
| expressionParameters | A collection of strings with the parameter value used in the SQL expression (i.e., the number of n tokens in the expression). The number of values in expressionParameters must be equal or greater than the highest referenced n token in the filterExpression (e.g. if %1 and %8 are used as parameter in the filterExpression, the expressionParameters should at least contain n+1 = 9 values). |
| 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. |
|
inherited |
This operation creates a org.omg.dds.topic.ContentFilteredTopic.
A ContentFilteredTopic can be used to do content-based subscriptions.
| <TYPE> | The type of all samples subscribed to with the new ContentFilteredTopic. It may be the same as the type of the relatedTopic or any supertype of that type. |
| name | The name of the new ContentFilteredTopic. |
| relatedTopic | The related Topic being subscribed to. The ContentFilteredTopic only relates to samples published under this Topic, filtered according to their content. |
| filterExpression | A logical expression that involves the values of some of the data fields in the sample. |
| expressionParameters | A collection of strings with the parameter value used in the SQL expression (i.e., the number of n tokens in the expression). The number of values in expressionParameters must be equal or greater than the highest referenced n token in the filterExpression (e.g. if %1 and %8 are used as parameter in the filterExpression, the expressionParameters should at least contain n+1 = 9 values). |
| 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. |
|
inherited |
This operation creates a MultiTopic.
A MultiTopic can be used to subscribe to multiple topics and combine/filter the received data into a resulting type. In particular, MultiTopic provides a content-based subscription mechanism.
NOTE: MultiTopics are currently not supported by OpenSplice!
| <TYPE> | The type of all samples subscribed to with the new MultiTopic. |
| name | The name of the new MultiTopic. |
| type | The resulting type. The Service will attempt to locate an appropriate org.omg.dds.type.TypeSupport instance based on this type. |
| subscriptionExpression | The list of topics and the logic used to combine filter and re-arrange the information from each Topic. |
| expressionParameters | Parameters to the filterExpression. |
| 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. |
|
inherited |
This operation creates a MultiTopic.
A MultiTopic can be used to subscribe to multiple topics and combine/filter the received data into a resulting type. In particular, MultiTopic provides a content-based subscription mechanism.
NOTE: MultiTopics are currently not supported by OpenSplice!
| <TYPE> | The type of all samples subscribed to with the new MultiTopic. |
| name | The name of the new MultiTopic. |
| type | The resulting type. The Service will attempt to locate an appropriate org.omg.dds.type.TypeSupport instance based on this type. |
| subscriptionExpression | The list of topics and the logic used to combine filter and re-arrange the information from each Topic. |
| expressionParameters | Parameters to the filterExpression. |
| 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. |
|
inherited |
This operation creates a MultiTopic.
A MultiTopic can be used to subscribe to multiple topics and combine/filter the received data into a resulting type. In particular, MultiTopic provides a content-based subscription mechanism.
NOTE: MultiTopics are currently not supported by OpenSplice!
| <TYPE> | The type of all samples subscribed to with the new MultiTopic. |
| name | The name of the new MultiTopic. |
| type | A org.omg.dds.type.TypeSupport representing the resulting type. |
| subscriptionExpression | The list of topics and the logic used to combine filter and re-arrange the information from each Topic. |
| expressionParameters | Parameters to the filterExpression. |
| 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. |
|
inherited |
This operation creates a MultiTopic.
A MultiTopic can be used to subscribe to multiple topics and combine/filter the received data into a resulting type. In particular, MultiTopic provides a content-based subscription mechanism.
NOTE: MultiTopics are currently not supported by OpenSplice!
| <TYPE> | The type of all samples subscribed to with the new MultiTopic. |
| name | The name of the new MultiTopic. |
| type | A org.omg.dds.type.TypeSupport representing the resulting type. |
| subscriptionExpression | The list of topics and the logic used to combine filter and re-arrange the information from each Topic. |
| expressionParameters | Parameters to the filterExpression. |
| 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. |
| void org.opensplice.dds.domain.DomainParticipant.createPersistentSnapshot | ( | String | partitionExpression, |
| String | topicExpression, | ||
| String | uri | ||
| ) |
This operation will create a snapshot of all persistent data matching the provided partition and topic expressions and store the snapshot at the location indicated by the URI.
Only persistent data available on the local node is considered. This operation will fire an event to trigger the snapshot creation by the durability service and then return while the durability service fulfills the snapshot request; if no durability service is available then there is no persistent data available and the operation will return OK as a snapshot of an empty store is an empty store.
The created snapshot can then be used as the persistent store for the durability service next time it starts up by configuring the location of the snapshot as the persistent store in the configuration file. The durability service will then use the snapshot as the regular store (and can thus also alter its contents).
| partitionExpression | The expression of all partitions involved in the snapshot; this may contain wildcards |
| topicExpression | The expression of all topics involved in the snapshot; this may contain wildcards. |
| uri | The location where to store the snapshot. Currently only directories are supported. |
| IllegalArgumentException | if partitionExpression, topicExpression or uri is null. |
| org.omg.dds.core.DDSException | An internal error has occurred. |
|
inherited |
This operation creates a Publisher with default QoS policies and no PublisherListener.
The created Publisher belongs to the DomainParticipant that is its factory.
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
This operation creates a Publisher.
The created Publisher belongs to the DomainParticipant that is its factory.
| qos | The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Publisher will be created. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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:
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.
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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:
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.
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
This operation creates a Subscriber with default QoS policies and no SubscriberListener.
The created Subscriber belongs to the DomainParticipant that is its factory.
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
This operation creates a Subscriber.
The created Subscriber belongs to the DomainParticipant that is its factory.
| qos | The desired QoS policies. If the specified QoS policies are not consistent, the operation will fail and no Subscriber will be created. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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:
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.
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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:
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.
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
This operation creates a Topic with default QoS policies and no TopicListener.
The created Topic belongs to the DomainParticipant that is its factory.
| topicName | The name of the new Topic. |
| type | The type 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. |
| 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. |
|
inherited |
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.
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:
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.
| topicName | The name of the new Topic. |
| type | The type 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. |
| 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. |
|
inherited |
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.
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:
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.
| topicName | The name of the new Topic. |
| type | The type 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. |
| 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. |
|
inherited |
This operation creates a Topic with default QoS policies and no TopicListener.
The created Topic belongs to the DomainParticipant that is its factory.
| topicName | The name of the new Topic. |
| type | A org.omg.dds.type.TypeSupport representing the type of all samples to be published and subscribed over the new Topic. |
| 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. |
|
inherited |
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.
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:
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.
| topicName | The name of the new Topic. |
| type | A org.omg.dds.type.TypeSupport representing the type of all samples to be published and subscribed over the new Topic. |
| 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. |
| 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. |
|
inherited |
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.
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:
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.
| topicName | The name of the new Topic. |
| type | A org.omg.dds.type.TypeSupport representing the type of all samples to be published and subscribed over the new Topic. |
| 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. |
| 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. |
|
inherited |
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!
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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:
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.
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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:
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.
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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!
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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:
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.
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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:
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.
| 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. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
| void org.opensplice.dds.domain.DomainParticipant.deleteHistoricalData | ( | String | partitionExpression, |
| String | topicExpression | ||
| ) |
This operation deletes all historical TRANSIENT and PERSISTENT data that is stored by the durability service that is configured to support this DomainParticipant.
It only deletes the samples stored in the transient and persistent store, samples stored in individual application DataReaders is spared and remains available to these readers. However, late-joiners will no longer be able to obtain the deleted samples.
The partition_expression and topic_expression strings can be used to specify selection criteria for the topic and/or partition in which the data will be deleted. Wildcards are supported. Note that these parameters are mandatory and cannot be empty. The "*" expression can be used to match all partitions and/or topics. Only data that exists prior to this method invocation is deleted. Data that is still being inserted during this method invocation will not be removed.
| partitionExpression | An expression to define a filter on partitions. |
| topicExpression | An expression to define a filter on topic names. |
| IllegalArgumentException | if partitionExpression or topicExpression is null. |
| org.omg.dds.core.DDSException | An internal error has occurred. |
|
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:
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)
|
inherited |
This operation gives access to an existing (or ready to exist) enabled Topic, based on its name.
The operation takes as arguments the name of the Topic and a timeout.
If a Topic of the same name already exists, it gives access to it, otherwise it waits (blocks the caller) until another mechanism creates it (or the specified timeout occurs). This other mechanism can be another thread, a configuration tool, or some other middleware service. Note that the Topic is a local object that acts as a 'proxy' to designate the global concept of topic. Middleware implementations could choose to propagate topics and make remotely created topics locally available.
A Topic obtained by means of findTopic must also be closed by means of org.omg.dds.topic.Topic#close() so that the local resources can be released. If a Topic is obtained multiple times by means of findTopic or createTopic(String, Class), it must also be closed that same number of times.
Regardless of whether the middleware chooses to propagate topics, the org.omg.dds.topic.Topic#close() operation disposes of only the local proxy.
| TimeoutException | if the specified timeout elapses and no suitable Topic could be found. |
|
inherited |
This operation gives access to an existing (or ready to exist) enabled Topic, based on its name.
The operation takes as arguments the name of the Topic and a timeout.
If a Topic of the same name already exists, it gives access to it, otherwise it waits (blocks the caller) until another mechanism creates it (or the specified timeout occurs). This other mechanism can be another thread, a configuration tool, or some other middleware service. Note that the Topic is a local object that acts as a 'proxy' to designate the global concept of topic. Middleware implementations could choose to propagate topics and make remotely created topics locally available.
A Topic obtained by means of findTopic must also be closed by means of org.omg.dds.topic.Topic#close() so that the local resources can be released. If a Topic is obtained multiple times by means of findTopic or createTopic(String, Class), it must also be closed that same number of times.
Regardless of whether the middleware chooses to propagate topics, the org.omg.dds.topic.Topic#close() operation disposes of only the local proxy.
| TimeoutException | if the specified timeout elapses and no suitable Topic could be found. |
|
inherited |
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.
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| participantHandle | a handle to the participant, the data of which is to be retrieved. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| UnsupportedOperationException | If the infrastructure does not locally maintain the connectivity information. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| topicHandle | a handle to the topic, the data of which is to be retrieved. |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| UnsupportedOperationException | If the infrastructure does not locally maintain the connectivity information. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
Implemented in org.omg.dds.core.ServiceEnvironment, org.opensplice.dds.sub.ReflectionDataReader< TYPE, OUT_TYPE >, org.opensplice.dds.core.ModifiableTimeImpl, org.opensplice.dds.pub.ReflectionDataWriter< TYPE >, org.opensplice.dds.core.DurationImpl, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >, org.opensplice.dds.type.TypeSupportImpl< TYPE >, org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl, org.opensplice.dds.topic.SubscriptionBuiltinTopicDataImpl, org.opensplice.dds.topic.TopicBuiltinTopicDataImpl, org.opensplice.dds.domain.DomainParticipantFactoryImpl, org.opensplice.dds.core.QosProviderImpl, org.opensplice.dds.core.status.OfferedIncompatibleQosStatusImpl, org.opensplice.dds.core.status.RequestedIncompatibleQosStatusImpl, org.opensplice.dds.core.InstanceHandleImpl, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, org.opensplice.dds.core.status.LivelinessChangedStatusImpl, org.opensplice.dds.core.status.PublicationMatchedStatusImpl, org.opensplice.dds.core.status.SubscriptionMatchedStatusImpl, org.opensplice.dds.sub.SampleImpl< TYPE >, org.opensplice.dds.core.policy.ShareImpl, org.opensplice.dds.core.status.OfferedDeadlineMissedStatusImpl, org.opensplice.dds.core.status.SampleRejectedStatusImpl, org.opensplice.dds.core.WaitSetImpl, org.opensplice.dds.topic.ParticipantBuiltinTopicDataImpl, org.opensplice.dds.core.status.RequestedDeadlineMissedStatusImpl, org.opensplice.dds.topic.BuiltinTopicKeyImpl, org.opensplice.dds.core.GuardConditionImpl, org.opensplice.dds.core.event.AllDataDisposedEventImpl< TYPE >, org.opensplice.dds.core.policy.QosPolicyCountImpl, org.opensplice.dds.core.status.InconsistentTopicStatusImpl, org.opensplice.dds.core.status.LivelinessLostStatusImpl, org.opensplice.dds.core.status.SampleLostStatusImpl, org.opensplice.dds.core.policy.QosPolicyImpl, org.opensplice.dds.core.status.AllDataDisposedStatusImpl, org.opensplice.dds.core.IllegalArgumentExceptionImpl, org.opensplice.dds.core.InconsistentPolicyExceptionImpl, org.opensplice.dds.core.policy.PolicyFactoryImpl, org.opensplice.dds.core.policy.TypeConsistencyEnforcementImpl, org.opensplice.dds.core.PreconditionNotMetExceptionImpl, org.opensplice.dds.core.AlreadyClosedExceptionImpl, org.opensplice.dds.core.IllegalOperationExceptionImpl, org.opensplice.dds.core.ImmutablePolicyExceptionImpl, org.opensplice.dds.core.NotEnabledExceptionImpl, org.opensplice.dds.core.OutOfResourcesExceptionImpl, org.opensplice.dds.core.DDSExceptionImpl, org.opensplice.dds.core.status.DataAvailableStatusImpl, and org.opensplice.dds.core.status.DataOnReadersStatusImpl.
|
inherited |
|
inherited |
This operation allows access to the existing Listener attached to the Entity.
| String org.opensplice.dds.domain.DomainParticipant.getProperty | ( | String | key | ) |
This operation looks up the property for a given key in the DomainParticipant, returning the value belonging to this key If the property has not been set using setProperty, the default value of the property is returned.
| key | The name of the property to request the value from |
| IllegalArgumentException | if an invalid key has been specified |
| UnsupportedOperationException | if the key specifies an undefined property or the operation is not supported in this version. |
| org.omg.dds.core.DDSException | An internal error has occurred. |
| org.omg.dds.core.AlreadyClosedException | The corresponding DomainParticipant has been closed. |
| org.omg.dds.core.OutOfResourcesException | The Data Distribution Service ran out of resources to complete this operation. |
|
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.
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
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.
|
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.
Implements org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| handle | the instance handle of the entity which needs to be ignored |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| handle | the instance handle of the entity which needs to be ignored |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| handle | the instance handle of the entity which needs to be ignored |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| handle | the instance handle of the entity which needs to be ignored |
| 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. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
This operation gives access to an existing locally-created TopicDescription based on its name.
The operation takes as argument the name of the TopicDescription.
If a TopicDescription of the same name already exists, it gives access to it, otherwise it returns null. The operation never blocks.
The operation may be used to locate any locally-created org.omg.dds.topic.Topic, org.omg.dds.topic.ContentFilteredTopic, or org.omg.dds.topic.MultiTopic object.
Unlike findTopic(String, Duration), the operation searches only among the locally created topics. Therefore, it should never create a new TopicDescription. The TopicDescription returned does not require an extra org.omg.dds.topic.TopicDescription#close(). It is still possible to close the TopicDescription returned by this method, provided it has no readers or writers, but then it is really closed and subsequent lookups will fail.
If the operation fails to locate a TopicDescription, it returns null.
| <TYPE> | The type of all samples subscribed to with the TopicDescription. |
| name | The name of the TopicDescription to look up. |
|
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.
|
inherited |
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.
| qos | the new publisher qos. |
| org.omg.dds.core.InconsistentPolicyException | if the resulting policies are not self consistent; in that case, the operation will have no effect. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| qos | the new subscriber qos. |
| org.omg.dds.core.InconsistentPolicyException | if the resulting policies are not self consistent; in that case, the operation will have no effect. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
inherited |
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.
| qos | the new topic qos. |
| org.omg.dds.core.InconsistentPolicyException | if the resulting policies are not self consistent; in that case, the operation will have no effect. |
Implemented in org.opensplice.dds.domain.DomainParticipantImpl.
|
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.
| listener | the listener to attach. |
|
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.
|
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.
| void org.opensplice.dds.domain.DomainParticipant.setProperty | ( | String | key, |
| String | value | ||
| ) |
This operation sets the property specified by a key value pair.
Currently, the following property is defined:
isolateNode The isolateNode property allows applications to isolate the federation from the rest of the Domain, i.e. at network level disconnect the node from the rest of the system. Additionally, they also need to be able to issue a request to reconnect their federation to the domain again after which the durability merge-policy that is configured needs to be applied.
To isolate a federation, the application needs to set the isolateNode property value to 'true' and to (de)isolate the federation the same property needs to set to 'false'. The default value of the isolateNode property is 'false'.
All data that is published after isolateNode is set to true will not be sent to the network and any data received from the network will be ignored. Be aware that data being processed by the network service at time of isolating a node may still be sent to the network due to asynchronous nature of network service internals.
The value is interpreted as a boolean (i.e., it must be either 'true' or 'false'). false (default): The federation is connected to the domain. true: The federation is disconnected from the domain meaning that data is not published on the network and data from the network is ignored.
| key | The name of the property |
| value | The value of the property |
| IllegalArgumentException | if an invalid value has been specified |
| UnsupportedOperationException | if the key specifies an undefined property or the operation is not supported in this version. |
| org.omg.dds.core.DDSException | An internal error has occurred. |
| org.omg.dds.core.AlreadyClosedException | The corresponding DomainParticipant has been closed. |
| org.omg.dds.core.OutOfResourcesException | The Data Distribution Service ran out of resources to complete this operation. |
|
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.
| 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. |
1.8.13