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.
Namespace: OpenDDSharp.DDS
The DomainParticipant type exposes the following members.
Name | Description | |
---|---|---|
DomainId |
Gets the domain id used to create the DomainParticipant.
The domain id identifies the DDS domain to which the DomainParticipant belongs.
| |
InstanceHandle |
Gets the InstanceHandle that represents the Entity.
(Inherited from Entity.) | |
StatusChanges |
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.) | |
StatusCondition |
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.) |
Name | Description | |
---|---|---|
AssertLiveliness |
Manually asserts the liveliness of the DomainParticipant. This is used in combination with the LivelinessQosPolicy to indicate to DDS that
the entity remains active.
| |
ContainsEntity |
Checks whether or not the given handle represents an Entity that was created from the DomainParticipant.
| |
CreateContentFilteredTopic |
Creates a ContentFilteredTopic. The ContentFilteredTopic can be used to do content-based subscriptions.
| |
CreateMultiTopic |
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.
| |
CreatePublisher |
Creates a new Publisher with the default QoS policies and without listener attached.
| |
CreatePublisher(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.
| |
CreatePublisher(PublisherQos) |
Creates a new Publisher with the desired QoS policies and without listener attached.
| |
CreatePublisher(PublisherListener, StatusMask) |
Creates a new Publisher with the default QoS policies and attaches to it the specified PublisherListener.
| |
CreatePublisher(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.
| |
CreatePublisher(PublisherQos, PublisherListener, StatusMask) |
Creates a new Publisher with the desired QoS policies and attaches to it the specified PublisherListener.
| |
CreateSubscriber |
Creates a new Subscriber with the default QoS policies and without listener attached.
| |
CreateSubscriber(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.
| |
CreateSubscriber(SubscriberQos) |
Creates a new Subscriber with the desired QoS policies and without listener attached.
| |
CreateSubscriber(SubscriberListener, StatusMask) |
Creates a new Subscriber with the default QoS policies and attaches to it the specified SubscriberListener.
| |
CreateSubscriber(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.
| |
CreateSubscriber(SubscriberQos, SubscriberListener, StatusMask) |
Creates a new Subscriber with the desired QoS policies and attaches to it the specified PublisherListener.
| |
CreateTopic(String, String) |
Creates a new Topic with the default QoS policies and without listener attached.
| |
CreateTopic(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.
| |
CreateTopic(String, String, TopicQos) |
Creates a Topic with the desired QoS policies and without listener attached.
| |
CreateTopic(String, String, TopicListener, StatusMask) |
Creates a Topic with the default QoS policies and attaches to it the specified TopicListener.
| |
CreateTopic(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.
| |
CreateTopic(String, String, TopicQos, TopicListener, StatusMask) |
Creates a new Topic with the desired QoS policies and attaches to it the specified TopicListener.
| |
DeleteContainedEntities |
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.
| |
DeleteContentFilteredTopic |
Deletes an existing ContentFilteredTopic.
| |
DeleteMultiTopic |
Deletes an existing MultiTopic.
| |
DeletePublisher |
Deletes an existing Publisher.
| |
DeleteSubscriber |
Deletes an existing Subscriber.
| |
DeleteTopic |
Deletes an existing Topic.
| |
Enable |
Enables the Entity. The enable operation is idempotent. Calling enable on an already enabled Entity returns
Ok and has no effect.
(Inherited from Entity.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
FindTopic |
Looks for an existing (or ready to exist) enabled Topic, based on its name.
| |
GetBuiltinSubscriber |
Allows access to the built-in Subscriber.
| |
GetCurrentTimestamp |
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.
| |
GetDefaultPublisherQos | ||
GetDefaultSubscriberQos |
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.
| |
GetDefaultTopicQos | ||
GetDiscoveredParticipantData |
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.
| |
GetDiscoveredParticipants |
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.
| |
GetDiscoveredTopicData |
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.
| |
GetDiscoveredTopics |
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.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetListener |
Allows access to the attached DomainParticipantListener.
| |
GetQos |
Gets the DomainParticipant QoS policies.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IgnoreParticipant |
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.
| |
IgnorePublication |
Instructs DDS to locally ignore a remote publication. After this call, any data written related to that publication will be ignored.
| |
IgnoreSubscription |
Instructs DDS to locally ignore a remote subscription. After this call, any data received related to that subscription will be ignored.
| |
IgnoreTopic | ||
LookupTopicDescription |
Looks up an existing ITopicDescription, based on its name. The operation never blocks.
| |
SetDefaultPublisherQos | ||
SetDefaultSubscriberQos |
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.
| |
SetDefaultTopicQos | ||
SetListener(DomainParticipantListener) |
Sets the DomainParticipantListener using the DefaultStatusMask.
| |
SetListener(DomainParticipantListener, StatusMask) |
Sets the DomainParticipantListener.
| |
SetQos |
Sets the DomainParticipant QoS policies.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |