org.omg.dds.domain
Interface DomainParticipant

All Superinterfaces:

DDSObject, Entity<DomainParticipant,DomainParticipantListener,DomainParticipantQos>

public interface DomainParticipant
extends Entity<DomainParticipant,DomainParticipantListener,DomainParticipantQos>

The DomainParticipant object plays several roles:

• It acts as a container for all other Entity objects.
• It acts as factory for the Publisher, Subscriber, Topic, ContentFilteredTopic, and MultiTopic objects.
• It represents the participation of the application on a communication plane that isolates applications running on the same set of physical computers from each other. A domain establishes a "virtual network" linking all applications that share the same domainId and isolating them from applications running on different domains. In this way, several independent distributed applications can coexist in the same physical network without interfering, or even being aware of each other.
• It provides administration services in the domain, offering operations that allow the application to "ignore" locally any information about a given participant (ignoreParticipant(InstanceHandle)), publication (ignorePublication(InstanceHandle)), subscription (ignoreSubscription(InstanceHandle)), or topic (ignoreTopic(InstanceHandle)).

Method Summary

void	assertLiveliness()
void	closeContainedEntities()
boolean	containsEntity(InstanceHandle handle)
<TYPE> ContentFilteredTopic<TYPE>	createContentFilteredTopic(java.lang.String name, Topic<? extends TYPE> relatedTopic, java.lang.String filterExpression, java.util.List<java.lang.String> expressionParameters)
<TYPE> MultiTopic<TYPE>	createMultiTopic(java.lang.String name, java.lang.String typeName, java.lang.String subscriptionExpression, java.util.List<java.lang.String> expressionParameters)
Publisher	createPublisher()
Publisher	createPublisher(PublisherQos qos, PublisherListener listener, java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses) Create a new publisher.
Publisher	createPublisher(java.lang.String qosLibraryName, java.lang.String qosProfileName, PublisherListener listener, java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses) Create a new publisher.
Subscriber	createSubscriber()
Subscriber	createSubscriber(java.lang.String qosLibraryName, java.lang.String qosProfileName, SubscriberListener listener, java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses) Create a new subscriber.
Subscriber	createSubscriber(SubscriberQos qos, SubscriberListener listener, java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses) Create a new subscriber.
<TYPE> Topic<TYPE>	createTopic(java.lang.String topicName, java.lang.Class<TYPE> type)
<TYPE> Topic<TYPE>	createTopic(java.lang.String topicName, java.lang.Class<TYPE> type, java.lang.String qosLibraryName, java.lang.String qosProfileName, TopicListener<TYPE> listener, java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses) Create a new topic.
<TYPE> Topic<TYPE>	createTopic(java.lang.String topicName, java.lang.Class<TYPE> type, TopicQos qos, TopicListener<TYPE> listener, java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses) Create a new topic.
<TYPE> Topic<TYPE>	createTopic(java.lang.String topicName, TypeSupport<TYPE> type)
<TYPE> Topic<TYPE>	createTopic(java.lang.String topicName, TypeSupport<TYPE> type, java.lang.String qosLibraryName, java.lang.String qosProfileName, TopicListener<TYPE> listener, java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses) Create a new topic.
<TYPE> Topic<TYPE>	createTopic(java.lang.String topicName, TypeSupport<TYPE> type, TopicQos qos, TopicListener<TYPE> listener, java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses) Create a new topic.
<TYPE> Topic<TYPE>	findTopic(java.lang.String topicName, Duration timeout)
<TYPE> Topic<TYPE>	findTopic(java.lang.String topicName, long timeout, java.util.concurrent.TimeUnit unit)
Subscriber	getBuiltinSubscriber()
ModifiableTime	getCurrentTime(ModifiableTime currentTime)
PublisherQos	getDefaultPublisherQos()
SubscriberQos	getDefaultSubscriberQos()
TopicQos	getDefaultTopicQos()
ParticipantBuiltinTopicData	getDiscoveredParticipantData(ParticipantBuiltinTopicData participantData, InstanceHandle participantHandle)
java.util.Collection<InstanceHandle>	getDiscoveredParticipants(java.util.Collection<InstanceHandle> participantHandles)
TopicBuiltinTopicData	getDiscoveredTopicData(TopicBuiltinTopicData topicData, InstanceHandle topicHandle)
java.util.Collection<InstanceHandle>	getDiscoveredTopics(java.util.Collection<InstanceHandle> topicHandles)
int	getDomainId()
void	ignoreParticipant(InstanceHandle handle)
void	ignorePublication(InstanceHandle handle)
void	ignoreSubscription(InstanceHandle handle)
void	ignoreTopic(InstanceHandle handle)
<TYPE> TopicDescription<TYPE>	lookupTopicDescription(java.lang.String name)
void	setDefaultPublisherQos(PublisherQos qos)
void	setDefaultPublisherQos(java.lang.String qosLibraryName, java.lang.String qosProfileName)
void	setDefaultSubscriberQos(java.lang.String qosLibraryName, java.lang.String qosProfileName)
void	setDefaultSubscriberQos(SubscriberQos qos)
void	setDefaultTopicQos(java.lang.String qosLibraryName, java.lang.String qosProfileName)
void	setDefaultTopicQos(TopicQos qos)

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

close, enable, getInstanceHandle, getListener, getQos, getStatusChanges, getStatusCondition, retain, setListener, setQos, setQos

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

getBootstrap

Method Detail

createPublisher

Publisher createPublisher()

createPublisher

Publisher createPublisher(PublisherQos qos,
                          PublisherListener listener,
                          java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)

Create a new publisher.

Parameters:

statuses - Of which status changes the listener should be notified. A null collection signifies all status changes.

createPublisher

Publisher createPublisher(java.lang.String qosLibraryName,
                          java.lang.String qosProfileName,
                          PublisherListener listener,
                          java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)

Create a new publisher.

Parameters:

statuses - Of which status changes the listener should be notified. A null collection signifies all status changes.

createSubscriber

Subscriber createSubscriber()

createSubscriber

Subscriber createSubscriber(SubscriberQos qos,
                            SubscriberListener listener,
                            java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)

Create a new subscriber.

Parameters:

statuses - Of which status changes the listener should be notified. A null collection signifies all status changes.

createSubscriber

Subscriber createSubscriber(java.lang.String qosLibraryName,
                            java.lang.String qosProfileName,
                            SubscriberListener listener,
                            java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)

Create a new subscriber.

Parameters:

statuses - Of which status changes the listener should be notified. A null collection signifies all status changes.

getBuiltinSubscriber

Subscriber getBuiltinSubscriber()

createTopic

<TYPE> Topic<TYPE> createTopic(java.lang.String topicName,
                               java.lang.Class<TYPE> type)

createTopic

<TYPE> Topic<TYPE> createTopic(java.lang.String topicName,
                               java.lang.Class<TYPE> type,
                               TopicQos qos,
                               TopicListener<TYPE> listener,
                               java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)

Create a new topic.

Parameters:

statuses - Of which status changes the listener should be notified. A null collection signifies all status changes.

createTopic

<TYPE> Topic<TYPE> createTopic(java.lang.String topicName,
                               java.lang.Class<TYPE> type,
                               java.lang.String qosLibraryName,
                               java.lang.String qosProfileName,
                               TopicListener<TYPE> listener,
                               java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)

Create a new topic.

Parameters:

statuses - Of which status changes the listener should be notified. A null collection signifies all status changes.

createTopic

<TYPE> Topic<TYPE> createTopic(java.lang.String topicName,
                               TypeSupport<TYPE> type)

createTopic

<TYPE> Topic<TYPE> createTopic(java.lang.String topicName,
                               TypeSupport<TYPE> type,
                               TopicQos qos,
                               TopicListener<TYPE> listener,
                               java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)

Create a new topic.

Parameters:

statuses - Of which status changes the listener should be notified. A null collection signifies all status changes.

createTopic

<TYPE> Topic<TYPE> createTopic(java.lang.String topicName,
                               TypeSupport<TYPE> type,
                               java.lang.String qosLibraryName,
                               java.lang.String qosProfileName,
                               TopicListener<TYPE> listener,
                               java.util.Collection<java.lang.Class<? extends Status<?,?>>> statuses)

Create a new topic.

Parameters:

statuses - Of which status changes the listener should be notified. A null collection signifies all status changes.

findTopic

<TYPE> Topic<TYPE> findTopic(java.lang.String topicName,
                             Duration timeout)
                      throws java.util.concurrent.TimeoutException

Throws:

java.util.concurrent.TimeoutException

findTopic

<TYPE> Topic<TYPE> findTopic(java.lang.String topicName,
                             long timeout,
                             java.util.concurrent.TimeUnit unit)
                      throws java.util.concurrent.TimeoutException

Throws:

java.util.concurrent.TimeoutException

lookupTopicDescription

<TYPE> TopicDescription<TYPE> lookupTopicDescription(java.lang.String name)

createContentFilteredTopic

<TYPE> ContentFilteredTopic<TYPE> createContentFilteredTopic(java.lang.String name,
                                                             Topic<? extends TYPE> relatedTopic,
                                                             java.lang.String filterExpression,
                                                             java.util.List<java.lang.String> expressionParameters)

createMultiTopic

<TYPE> MultiTopic<TYPE> createMultiTopic(java.lang.String name,
                                         java.lang.String typeName,
                                         java.lang.String subscriptionExpression,
                                         java.util.List<java.lang.String> expressionParameters)

closeContainedEntities

void closeContainedEntities()

ignoreParticipant

void ignoreParticipant(InstanceHandle handle)

ignoreTopic

void ignoreTopic(InstanceHandle handle)

ignorePublication

void ignorePublication(InstanceHandle handle)

ignoreSubscription

void ignoreSubscription(InstanceHandle handle)

getDomainId

int getDomainId()

assertLiveliness

void assertLiveliness()

getDefaultPublisherQos

PublisherQos getDefaultPublisherQos()

setDefaultPublisherQos

void setDefaultPublisherQos(PublisherQos qos)

setDefaultPublisherQos

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

getDefaultSubscriberQos

SubscriberQos getDefaultSubscriberQos()

setDefaultSubscriberQos

void setDefaultSubscriberQos(SubscriberQos qos)

setDefaultSubscriberQos

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

getDefaultTopicQos

TopicQos getDefaultTopicQos()

setDefaultTopicQos

void setDefaultTopicQos(TopicQos qos)

setDefaultTopicQos

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

getDiscoveredParticipants

java.util.Collection<InstanceHandle> getDiscoveredParticipants(java.util.Collection<InstanceHandle> participantHandles)

getDiscoveredParticipantData

ParticipantBuiltinTopicData getDiscoveredParticipantData(ParticipantBuiltinTopicData participantData,
                                                         InstanceHandle participantHandle)

getDiscoveredTopics

java.util.Collection<InstanceHandle> getDiscoveredTopics(java.util.Collection<InstanceHandle> topicHandles)

getDiscoveredTopicData

TopicBuiltinTopicData getDiscoveredTopicData(TopicBuiltinTopicData topicData,
                                             InstanceHandle topicHandle)

containsEntity

boolean containsEntity(InstanceHandle handle)

getCurrentTime

ModifiableTime getCurrentTime(ModifiableTime currentTime)