Click or drag to resize

DomainParticipant Class

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

Inheritance Hierarchy

Namespace:  OpenDDSharp.DDS
Assembly:  OpenDDSharp (in OpenDDSharp.dll) Version: 0.4.1.0
Syntax
public class DomainParticipant : Entity

The DomainParticipant type exposes the following members.

Properties
  NameDescription
Public propertyDomainId
Gets the domain id used to create the DomainParticipant. The domain id identifies the DDS domain to which the DomainParticipant belongs.
Public propertyInstanceHandle
Gets the InstanceHandle that represents the Entity.
(Inherited from Entity.)
Public propertyStatusChanges
Gets 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.
(Inherited from Entity.)
Public propertyStatusCondition
Allows access to the StatusCondition associated with the Entity. The returned condition can then be added to a WaitSet so that the application can wait for specific status changes that affect the Entity.
(Inherited from Entity.)
Top
Methods
  NameDescription
Public methodAssertLiveliness
Manually asserts the liveliness of the DomainParticipant. This is used in combination with the LivelinessQosPolicy to indicate to DDS that the entity remains active.
Public methodContainsEntity
Checks whether or not the given handle represents an Entity that was created from the DomainParticipant.
Public methodCreateContentFilteredTopic
Creates a ContentFilteredTopic. The ContentFilteredTopic can be used to do content-based subscriptions.
Public methodCreateMultiTopic
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.
Public methodCreatePublisher
Creates a new Publisher with the default QoS policies and without listener attached.
Public methodCreatePublisher(PublisherListener)
Creates a Publisher with the default QoS policies and attaches to it the specified PublisherListener. The specified PublisherListener will be attached with the default StatusMask.
Public methodCreatePublisher(PublisherQos)
Creates a new Publisher with the desired QoS policies and without listener attached.
Public methodCreatePublisher(PublisherListener, StatusMask)
Creates a new Publisher with the default QoS policies and attaches to it the specified PublisherListener.
Public methodCreatePublisher(PublisherQos, PublisherListener)
Creates a new Publisher with the desired QoS policies and attaches to it the specified PublisherListener. The specified PublisherListener will be attached with the default StatusMask.
Public methodCreatePublisher(PublisherQos, PublisherListener, StatusMask)
Creates a new Publisher with the desired QoS policies and attaches to it the specified PublisherListener.
Public methodCreateSubscriber
Creates a new Subscriber with the default QoS policies and without listener attached.
Public methodCreateSubscriber(SubscriberListener)
Creates a Subscriber with the default QoS policies and attaches to it the specified SubscriberListener. The specified SubscriberListener will be attached with the default StatusMask.
Public methodCreateSubscriber(SubscriberQos)
Creates a new Subscriber with the desired QoS policies and without listener attached.
Public methodCreateSubscriber(SubscriberListener, StatusMask)
Creates a new Subscriber with the default QoS policies and attaches to it the specified SubscriberListener.
Public methodCreateSubscriber(SubscriberQos, SubscriberListener)
Creates a new Subscriber with the desired QoS policies and attaches to it the specified SubscriberListener. The specified SubscriberListener will be attached with the default StatusMask.
Public methodCreateSubscriber(SubscriberQos, SubscriberListener, StatusMask)
Creates a new Subscriber with the desired QoS policies and attaches to it the specified PublisherListener.
Public methodCreateTopic(String, String)
Creates a new Topic with the default QoS policies and without listener attached.
Public methodCreateTopic(String, String, TopicListener)
Creates a new Topic with the default QoS policies and attaches to it the specified TopicListener. The specified TopicListener will be attached with the default StatusMask.
Public methodCreateTopic(String, String, TopicQos)
Creates a Topic with the desired QoS policies and without listener attached.
Public methodCreateTopic(String, String, TopicListener, StatusMask)
Creates a Topic with the default QoS policies and attaches to it the specified TopicListener.
Public methodCreateTopic(String, String, TopicQos, TopicListener)
Creates a new Topic with the desired QoS policies and attaches to it the specified TopicListener. The specified TopicListener will be attached with the default StatusMask.
Public methodCreateTopic(String, String, TopicQos, TopicListener, StatusMask)
Creates a new Topic with the desired QoS policies and attaches to it the specified TopicListener.
Public methodDeleteContainedEntities
Deletes all the entities that were created by means of the “create” operations on the DomainParticipant. That is, it deletes all contained Publisher, Subscriber, Topic, ContentFilteredTopic, and MultiTopic. This method is applied recursively to the deleted entities.
Public methodDeleteContentFilteredTopic
Deletes an existing ContentFilteredTopic.
Public methodDeleteMultiTopic
Deletes an existing MultiTopic.
Public methodDeletePublisher
Deletes an existing Publisher.
Public methodDeleteSubscriber
Deletes an existing Subscriber.
Public methodDeleteTopic
Deletes an existing Topic.
Public methodEnable
Enables the Entity. The enable operation is idempotent. Calling enable on an already enabled Entity returns Ok and has no effect.
(Inherited from Entity.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFindTopic
Looks for an existing (or ready to exist) enabled Topic, based on its name.
Public methodGetBuiltinSubscriber
Allows access to the built-in Subscriber.
Public methodGetCurrentTimestamp
Gets the current value of the timestamp that DDS uses to time-stamp data-writes and to set the reception timestamp for the data-updates it receives.
Public methodGetDefaultPublisherQos
Gets the default value of the Publisher QoS, that is, the QoS policies which will be used for newly created Publisher entities in the case where the QoS policies are defaulted in the CreatePublisher operation.
Public methodGetDefaultSubscriberQos
Gets the default value of the Subscriber QoS, that is, the QoS policies which will be used for newly created Subscriber entities in the case where the QoS policies are defaulted in the CreateSubscriber operation.
Public methodGetDefaultTopicQos
Gets the default value of the Topic QoS, that is, the QoS policies that will be used for newly created Topic entities in the case where the QoS policies are defaulted in the CreateTopic operation.
Public methodGetDiscoveredParticipantData
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 DomainParticipantIgnoreParticipant(InstanceHandle) operation.
Public methodGetDiscoveredParticipants
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 DomainParticipantIgnoreParticipant(InstanceHandle) operation.
Public methodGetDiscoveredTopicData
Retrieves information on a Topic that has been discovered on the network. The topic must have been created by a participant in the same domain as the participant on which this operation is invoked and must not have been “ignored” by means of the DomainParticipantIgnoreTopic(InstanceHandle) operation.
Public methodGetDiscoveredTopics
Retrieves the list of Topics that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the DomainParticipantIgnoreTopic(InstanceHandle) operation.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetListener
Allows access to the attached DomainParticipantListener.
Public methodGetQos
Gets the DomainParticipant QoS policies.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIgnoreParticipant
Instructs DDS to locally ignore a remote DomainParticipant. From that point onwards the local DomainParticipant will behave as if the remote DomainParticipant did not exist. This means it will ignore any topic, publication, or subscription that originates on that DomainParticipant.
Public methodIgnorePublication
Instructs DDS to locally ignore a remote publication. After this call, any data written related to that publication will be ignored.
Public methodIgnoreSubscription
Instructs DDS to locally ignore a remote subscription. After this call, any data received related to that subscription will be ignored.
Public methodIgnoreTopic
Instructs DDS to locally ignore a Topic. This means it will locally ignore any publication or subscription to the Topic.
Public methodLookupTopicDescription
Looks up an existing ITopicDescription, based on its name. The operation never blocks.
Public methodSetDefaultPublisherQos
Sets a default value of the Publisher QoS policies which will be used for newly created Publisher entities in the case where the QoS policies are defaulted in the CreatePublisher operation.
Public methodSetDefaultSubscriberQos
Sets a default value of the Subscriber QoS policies which will be used for newly created Subscriber entities in the case where the QoS policies are defaulted in the CreateSubscriber operation.
Public methodSetDefaultTopicQos
Sets a default value of the Topic QoS policies which will be used for newly created Topic entities in the case where the QoS policies are defaulted in the CreateTopic operation.
Public methodSetListener(DomainParticipantListener)
Public methodSetListener(DomainParticipantListener, StatusMask)
Public methodSetQos
Sets the DomainParticipant QoS policies.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
The DomainParticipant also acts as a container for all other Entity objects and as factory for the Publisher, Subscriber, Topic, and MultiTopicEntity objects. In addition, the Domain Participant provides administration services in the domain, offering operations that allow the application to ‘ignore’ locally any information about a given participant, publication, subscription, or topic.
See Also