This policy allows the introduction of a logical partition concept inside the "physical" partition induced by a domain. More...

Inheritance diagram for org.omg.dds.core.policy.Partition:

Collaboration diagram for org.omg.dds.core.policy.Partition:

Public Member Functions
ServiceEnvironment	getEnvironment ()

Set< String >	getName ()

Partition	withName (Collection< String > name)
	Copy this policy and override the value of the property. More...

Partition	withName (String name)
	Copy this policy and override the value of the property. More...

Partition	withName (String... names)
	Copy this policy and override the value of the property. More...

Detailed Description

This policy allows the introduction of a logical partition concept inside the "physical" partition induced by a domain.

It consists of a set of strings that introduces a logical partition among the topics visible by the org.omg.dds.pub.Publisher and org.omg.dds.sub.Subscriber.

Concerns: org.omg.dds.pub.Publisher, org.omg.dds.sub.Subscriber

RxO: No

Changeable: Yes

A org.omg.dds.pub.DataWriter within a Publisher only communicates with a org.omg.dds.sub.DataReader in a Subscriber if (in addition to matching the Topic and having compatible QoS) the Publisher and Subscriber have a common partition name string. Each string in the collection that defines this QoS policy defines a partition name. A partition name may contain wild cards. Sharing a common partition means that one of the partition names matches.

Failure to match partitions is not considered an "incompatible" QoS and does not trigger any listeners nor conditions.

This policy is changeable. A change of this policy can potentially modify the "match" of existing DataReader and DataWriter entities. It may establish new "matches" that did not exist before, or break existing matches.

The empty string ("") is considered a valid partition that is matched with other partition names using the same rules of string matching and regular expression matching used for any other partition name.

The default value for is a zero-size collection. The zero-size collection is treated as a special value equivalent to a collection containing a single element consisting of the empty string.

This policy is changeable. A change of this policy can potentially modify the "match" of existing DataReader and DataWriter entities. It may establish new "matches" that did not exist before, or break existing matches.

PARTITION names can be regular expressions and include wild cards as defined by the POSIX fnmatch API (1003.2-1992 section B.6). Either org.omg.dds.pub.Publisher or org.omg.dds.sub.Subscriber may include regular expressions in partition names, but no two names that both contain wild cards will ever be considered to match. This means that although regular expressions may be used both at publisher as well as subscriber side, the service will not try to match two regular expressions (between publishers and subscribers).

Partitions are different from creating org.omg.dds.core.Entity objects in different domains in several ways. First, entities belonging to different domains are completely isolated from each other; there is no traffic, meta-traffic or any other way for an application or the Service itself to see entities in a domain it does not belong to. Second, an Entity can only belong to one domain whereas an Entity can be in multiple partitions. Finally, as far as the DDS Service is concerned, each unique data instance is identified by the tuple (domainId, Topic, key). Therefore two Entity objects in different domains cannot refer to the same data instance. On the other hand, the same data instance can be made available (published) or requested (subscribed) on one or more partitions.

Definition at line 86 of file Partition.java.

Member Function Documentation

◆ getEnvironment()

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.

◆ getName()

Set<String> org.omg.dds.core.policy.Partition.getName ( )

Returns: an unmodifiable collection of partition names.

Implemented in org.opensplice.dds.core.policy.PartitionImpl.

◆ withName() [1/3]

Partition org.omg.dds.core.policy.Partition.withName ( Collection< String > name )

Copy this policy and override the value of the property.

Parameters

name	A Collection of strings, which specifies the partitions.

Returns: a new Partition policy

Implemented in org.opensplice.dds.core.policy.PartitionImpl.

◆ withName() [2/3]

Partition org.omg.dds.core.policy.Partition.withName ( String name )

Copy this policy and override the value of the property.

Parameters

name	A name string , which specifies the partition.

Returns: a new Partition policy

Implemented in org.opensplice.dds.core.policy.PartitionImpl.

◆ withName() [3/3]

Partition org.omg.dds.core.policy.Partition.withName ( String... names )

Copy this policy and override the value of the property.

Parameters

names An arbitrary number of name strings , which specifies the partitions.

Returns: a new Partition policy

Implemented in org.opensplice.dds.core.policy.PartitionImpl.

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

java5/common/java/code/org/omg/dds/core/policy/Partition.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ getEnvironment()

◆ getName()

◆ withName() [1/3]

◆ withName() [2/3]

◆ withName() [3/3]