DomainParticipant Class Reference

Container for all other Entity objects. More...

Inheritance diagram for DomainParticipant:

Public Member Functions
Topic< T >	CreateTopic< T > (string name)
	Creates a Topic<T> with default Qos. More...
Topic< T >	CreateTopic< T > (string name, string typeName)
	Creates a Topic<T> with a different registered type name and default Qos. More...
Topic< T >	CreateTopic< T > (string name, TopicQos qos)
	Creates a Topic<T> with the given Qos. More...
Topic< T >	CreateTopic< T > (string name, string typeName, TopicQos qos)
	Creates a Topic<T> with a different registered type name and the given Qos. More...
Topics.IAnyTopic	CreateTopic (string name, Type topicType)
	Creates a Topic<T> specifying its type reflectively More...
Topic< DynamicData >	CreateTopic (string name, DynamicType type)
	Creates a dynamically-typed Topic with default qos More...
Topic< DynamicData >	CreateTopic (string name, DynamicType type, TopicQos qos)
	Creates a dynamically-typed Topic with default qos More...
void	RegisterType (string name, DynamicType type)
	Allows registering a dynamic type with a name different than DynamicType.Name More...
void	RegisterType (string name, DynamicType type, TypeSerializationProperty serializationProperty)
	Allows registering a dynamic type with a name different than DynamicType.Name and with additional serialization properties More...
ContentFilteredTopic< T >	CreateContentFilteredTopic< T > (string name, Topic< T > relatedTopic, Filter filter)
	Creates a ContentFilteredTopic<T> which can be used to do content-based subscriptions. More...
AnyContentFilteredTopic	CreateContentFilteredTopic (string name, Topics.IAnyTopic relatedTopic, Filter filter)
	Creates a ContentFilteredTopic<T> reflectively using the type of the relatedTopic. More...
ITopicDescription	LookupTopicDescription (string name)
	Looks up an existing, locally created TopicDescription, based on its name. More...
Publisher	LookupPublisher (string name)
	Looks up a Publisher by its PublisherQos.PublisherName within this DomainParticipant. More...
Subscriber	LookupSubscriber (string name)
	Looks up a Subscriber by its SubscriberQos.SubscriberName within this DomainParticipant. More...
DataReader< T >	LookupDataReader< T > (string name)
	Looks up a DataReader<T> by its DataReaderQos.SubscriptionName within this DomainParticipant. More...
AnyDataReader	LookupDataReader (string name)
	Looks up a AnyDataReader by its DataReaderQos.SubscriptionName within this DomainParticipant. More...
DataWriter< T >	LookupDataWriter< T > (string name)
	Looks up a DataWriter<T> by its DataWriterQos.PublicationName within this DomainParticipant. More...
AnyDataWriter	LookupDataWriter (string name)
	Looks up a AnyDataWriter by its DataWriterQos.PublicationName within this DomainParticipant. More...
bool	IsTypeRegistered (string typeName)
	Checks if the DynamicType associated with the provided typeName is registered with this DomainParticipant. More...
DynamicType	GetDynamicType (string typeName)
	Returns the DynamicType registered with the provided typeName. More...
void	ResumeEndpointDiscovery (InstanceHandle remoteParticipantHandle)
	Initiates endpoint discovery with the DomainParticipant identified by the provided InstanceHandle. More...
TopicBuiltinTopicData	GetDiscoveredTopicData (in InstanceHandle topicHandle)
	Retrieves information on a Topic<T> that has been discovered. More...
IEnumerable< TopicBuiltinTopicData >	GetDiscoveredTopicData ()
	Retrieves the information on all Topic<T>s that have been discovered. More...
ParticipantBuiltinTopicData	GetDiscoveredParticipantData (in InstanceHandle participantHandle)
	Retrieves information on a DomainParticipant that has been discovered. More...
IEnumerable< ParticipantBuiltinTopicData >	GetDiscoveredParticipantData ()
	Retrieves the information on all DomainParticipants that have been discovered. More...
Publisher	CreatePublisher ()
	Creates a Publisher using the default PublisherQos that will be attached and belong to this DomainParticipant. More...
Publisher	CreatePublisher (PublisherQos qos)
	Creates a Publisher using the provided PublisherQos that will be attached and belong to this DomainParticipant. More...
Subscriber	CreateSubscriber ()
	Creates a Subscriber using the default SubscriberQos that will be attached and belong to this DomainParticipant. More...
Subscriber	CreateSubscriber (SubscriberQos qos)
	Creates a Subscriber using the provided SubscriberQos that will be attached and belong to this DomainParticipant. More...
void	AssertLiveliness ()
	Manually asserts liveliness on this DomainParticipant. More...
void	AddPeer (string peer)
	Add the peer, described by the provided string, to the list of peers that this DomainParticipant will try to contact. More...
void	RemovePeer (string peer)
	Remove the peer, described by the provided string, from the list of peers that this DomainParticipant will try to contact. More...
void	IgnoreParticipant (in InstanceHandle handle)
	Ignore the remote DomainParticipant corresponding to the provided InstanceHandle. More...
void	IgnorePublication (in InstanceHandle handle)
	Ignore the remote publication corresponding to the provided InstanceHandle. More...
void	IgnoreSubscription (in InstanceHandle handle)
	Ignore the remote subscription corresponding to the provided InstanceHandle. More...
void	IgnoreTopic (in InstanceHandle handle)
	Ignore the remote Topic<T> corresponding to the provided InstanceHandle. More...
bool	ContainsEntity (in InstanceHandle handle)
	Check if the Entity described by the provided InstanceHandle belongs to this DomainParticipant. More...
void	DisposeContainedEntities ()
	Dispose all of the entities created by this DomainParticipant. More...
override void	ResetEvents (StatusMask newMask)
	Stop notifying of events not selected in the newMask and remove their event handlers. More...
override string	ToString ()
	Provides a short string representation of the DomainParticipant, including its domain ID and ParticipantName (if set). More...
Public Member Functions inherited from Entity
void	Enable ()
	Enables this Entity (by default entities are automatically enabled after creation) More...
EntityLock	Lock ()
	Locks the Entity using its internal lock. More...
void	Dispose ()
	Releases the resources used by this Entity and disposes its contained entities as well (if any). More...

Properties
WaitSetAsyncDispatcher	InternalTaskDispatcher [get]
	For internal use only. More...
Subscriber	ImplicitSubscriber [get]
	Returns the implicit Subscriber. If an implicit Subscriber does not already exist, this creates one. More...
Publisher	ImplicitPublisher [get]
	Returns the implicit Publisher. If an implicit Publisher does not already exist, this creates one. More...
Subscriber	BuiltinSubscriber [get]
	Returns the built-in Subscriber. More...
int	DomainId [get]
	Gets this participant's domain id More...
DomainParticipantQos	Qos [get, set]
	Get or change the QoS of this DomainParticipant. More...
PublisherQos	DefaultPublisherQos [get, set]
	Get or change the default PublisherQos. More...
SubscriberQos	DefaultSubscriberQos [get, set]
	Get or change the default SubscriberQos. More...
TopicQos	DefaultTopicQos [get, set]
	Get or change the default TopicQos. More...
DataReaderQos	DefaultDataReaderQos [get, set]
	Get or change the default DataReaderQos. More...
DataWriterQos	DefaultDataWriterQos [get, set]
	Get or change the default DataWriterQos. More...
Time	CurrentTime [get]
	Returns the current time using this DomainParticipant's clock More...
IEnumerable< ITopicDescription >	Topics [get]
	Retrieve all the Topics created from this DomainParticipant More...
IEnumerable< AnyContentFilteredTopic >	ContentFilteredTopics [get]
	Retrieve all the ContentFilteredTopics created from this DomainParticipant More...
IEnumerable< Subscriber >	Subscribers [get]
	Retrieve all the Subscriber created from this DomainParticipant More...
IEnumerable< Publisher >	Publishers [get]
	Retrieve all the Publisher created from this DomainParticipant More...
IEnumerable< InstanceHandle >	DiscoveredParticipants [get]
	Retrieve all the DomainParticipant that have been discovered by this DomainParticipant More...
IEnumerable< InstanceHandle >	DiscoveredTopics [get]
	Retrieve all the topics that have been discovered by this DomainParticipant. The returned instance handles can be passed to GetDiscoveredTopicData(in InstanceHandle). More...
DomainParticipantProtocolStatus	DomainParticipantProtocolStatus [get]
	Returns the DomainParticipantProtocolStatus. More...
Properties inherited from Entity
InstanceHandle	InstanceHandle [get]
	Gets the InstanceHandle that identifies this Entity More...
StatusMask	StatusChanges [get]
	Retrieves the list of communication statuses in this Entity that are triggered. More...
StatusCondition	StatusCondition [get]
	Gets the StatusCondition associated with this Entity. More...
bool	Enabled [get]
	Indicates whether this Entity is enabled. More...
bool	Disposed [get]
	Indicates whether this Entity has already been disposed. More...

Detailed Description

Container for all other Entity objects.

The full documentation is available in the C API: DDS_DomainParticipant

Member Function Documentation

AddPeer()

void AddPeer

(

string

peer

)

Add the peer, described by the provided string, to the list of peers that this DomainParticipant will try to contact.

The full documentation is available in the C API: DDS_DomainParticipant_add_peer

AssertLiveliness()

void AssertLiveliness

(

)

Manually asserts liveliness on this DomainParticipant.

The full documentation is available in the C API: DDS_DomainParticipant_assert_liveliness

ContainsEntity()

bool ContainsEntity

(

in InstanceHandle

handle

)

Check if the Entity described by the provided InstanceHandle belongs to this DomainParticipant.

Returns

True if the Entity was created by this DomainParticipant.

The full documentation is available in the C API: DDS_DomainParticipant_contains_entity

CreateContentFilteredTopic()

AnyContentFilteredTopic CreateContentFilteredTopic	(	string	name,
		Topics.IAnyTopic	relatedTopic,
		Filter	filter
	)

Creates a ContentFilteredTopic<T> reflectively using the type of the relatedTopic.

The full documentation is available in the C API: DDS_DomainParticipant_create_contentfilteredtopic

CreateContentFilteredTopic< T >()

ContentFilteredTopic<T> CreateContentFilteredTopic< T >	(	string	name,
		Topic< T >	relatedTopic,
		Filter	filter
	)

Creates a ContentFilteredTopic<T> which can be used to do content-based subscriptions.

The full documentation is available in the C API: DDS_DomainParticipant_create_contentfilteredtopic

CreatePublisher() [1/2]

Publisher CreatePublisher

(

)

Creates a Publisher using the default PublisherQos that will be attached and belong to this DomainParticipant.

Returns

The created Publisher.

The full documentation is available in the C API: DDS_DomainParticipant_create_publisher

CreatePublisher() [2/2]

Publisher CreatePublisher

(

PublisherQos

qos

)

Creates a Publisher using the provided PublisherQos that will be attached and belong to this DomainParticipant.

Returns

The created Publisher.

The full documentation is available in the C API: DDS_DomainParticipant_create_publisher

CreateSubscriber() [1/2]

Subscriber CreateSubscriber

(

)

Creates a Subscriber using the default SubscriberQos that will be attached and belong to this DomainParticipant.

Returns

The created Subscriber.

The full documentation is available in the C API: DDS_DomainParticipant_create_subscriber

CreateSubscriber() [2/2]

Subscriber CreateSubscriber

(

SubscriberQos

qos

)

Creates a Subscriber using the provided SubscriberQos that will be attached and belong to this DomainParticipant.

Returns

The created Subscriber

.

The full documentation is available in the C API: DDS_DomainParticipant_create_subscriber

CreateTopic() [1/3]

Topic<DynamicData> CreateTopic	(	string	name,
		DynamicType	type
	)

Creates a dynamically-typed Topic with default qos

The full documentation is available in the C API: DDS_DomainParticipant_create_topic

CreateTopic() [2/3]

Topic<DynamicData> CreateTopic	(	string	name,
		DynamicType	type,
		TopicQos	qos
	)

Creates a dynamically-typed Topic with default qos

The full documentation is available in the C API: DDS_DomainParticipant_create_topic

CreateTopic() [3/3]

Topics.IAnyTopic CreateTopic	(	string	name,
		Type	topicType
	)

Creates a Topic<T> specifying its type reflectively

The full documentation is available in the C API: DDS_DomainParticipant_create_topic

CreateTopic< T >() [1/4]

Topic<T> CreateTopic< T >

(

string

name

)

Creates a Topic<T> with default Qos.

The full documentation is available in the C API: DDS_DomainParticipant_create_topic

CreateTopic< T >() [2/4]

Topic<T> CreateTopic< T >	(	string	name,
		string	typeName
	)

Creates a Topic<T> with a different registered type name and default Qos.

The full documentation is available in the C API: DDS_DomainParticipant_create_topic

CreateTopic< T >() [3/4]

Topic<T> CreateTopic< T >	(	string	name,
		string	typeName,
		TopicQos	qos
	)

Creates a Topic<T> with a different registered type name and the given Qos.

The full documentation is available in the C API: DDS_DomainParticipant_create_topic

CreateTopic< T >() [4/4]

Topic<T> CreateTopic< T >	(	string	name,
		TopicQos	qos
	)

Creates a Topic<T> with the given Qos.

The full documentation is available in the C API: DDS_DomainParticipant_create_topic

DisposeContainedEntities()

void DisposeContainedEntities

(

)

Dispose all of the entities created by this DomainParticipant.

The full documentation is available in the C API: DDS_DomainParticipant_delete_contained_entities

GetDiscoveredParticipantData() [1/2]

IEnumerable<ParticipantBuiltinTopicData> GetDiscoveredParticipantData

(

)

Retrieves the information on all DomainParticipants that have been discovered.

GetDiscoveredParticipantData() [2/2]

ParticipantBuiltinTopicData GetDiscoveredParticipantData

(

in InstanceHandle

participantHandle

)

Retrieves information on a DomainParticipant that has been discovered.

The full documentation is available in the C API: DDS_DomainParticipant_get_discovered_participant_data

GetDiscoveredTopicData() [1/2]

IEnumerable<TopicBuiltinTopicData> GetDiscoveredTopicData

(

)

Retrieves the information on all Topic<T>s that have been discovered.

GetDiscoveredTopicData() [2/2]

TopicBuiltinTopicData GetDiscoveredTopicData

(

in InstanceHandle

topicHandle

)

Retrieves information on a Topic<T> that has been discovered.

The full documentation is available in the C API: DDS_DomainParticipant_get_discovered_topic_data

GetDynamicType()

DynamicType GetDynamicType

(

string

typeName

)

Returns the DynamicType registered with the provided typeName.

Returns

The corresponding DynamicType, or null if no type with that typeName is registered.

The full documentation is available in the C API: DDS_DomainParticipant_get_typecode

IgnoreParticipant()

void IgnoreParticipant

(

in InstanceHandle

handle

)

Ignore the remote DomainParticipant corresponding to the provided InstanceHandle.

The full documentation is available in the C API: DDS_DomainParticipant_ignore_participant

IgnorePublication()

void IgnorePublication

(

in InstanceHandle

handle

)

Ignore the remote publication corresponding to the provided InstanceHandle.

The full documentation is available in the C API: DDS_DomainParticipant_ignore_publication

IgnoreSubscription()

void IgnoreSubscription

(

in InstanceHandle

handle

)

Ignore the remote subscription corresponding to the provided InstanceHandle.

The full documentation is available in the C API: DDS_DomainParticipant_ignore_subscription

IgnoreTopic()

void IgnoreTopic

(

in InstanceHandle

handle

)

Ignore the remote Topic<T> corresponding to the provided InstanceHandle.

The full documentation is available in the C API: DDS_DomainParticipant_ignore_topic

IsTypeRegistered()

bool IsTypeRegistered

(

string

typeName

)

Checks if the DynamicType associated with the provided typeName is registered with this DomainParticipant.

Returns

True if the DynamicType is registered

LookupDataReader()

AnyDataReader LookupDataReader

(

string

name

)

Looks up a AnyDataReader by its DataReaderQos.SubscriptionName within this DomainParticipant.

Returns

The DataReader if it exists or null otherwise

The full documentation is available in the C API: DDS_DomainParticipant_lookup_datareader_by_name

LookupDataReader< T >()

DataReader<T> LookupDataReader< T >

(

string

name

)

Looks up a DataReader<T> by its DataReaderQos.SubscriptionName within this DomainParticipant.

Returns

The DataReader if it exists or null otherwise

The full documentation is available in the C API: DDS_DomainParticipant_lookup_datareader_by_name

LookupDataWriter()

AnyDataWriter LookupDataWriter

(

string

name

)

Looks up a AnyDataWriter by its DataWriterQos.PublicationName within this DomainParticipant.

Returns

The DataWriter if it exists or null otherwise

The full documentation is available in the C API: DDS_DomainParticipant_lookup_datawriter_by_name

LookupDataWriter< T >()

DataWriter<T> LookupDataWriter< T >

(

string

name

)

Looks up a DataWriter<T> by its DataWriterQos.PublicationName within this DomainParticipant.

Returns

The DataWriter if it exists or null otherwise

The full documentation is available in the C API: DDS_DomainParticipant_lookup_datawriter_by_name

LookupPublisher()

Publisher LookupPublisher

(

string

name

)

Looks up a Publisher by its PublisherQos.PublisherName within this DomainParticipant.

Returns

The publisher if it exists or null otherwise

The full documentation is available in the C API: DDS_DomainParticipant_lookup_publisher_by_name

LookupSubscriber()

Subscriber LookupSubscriber

(

string

name

)

Looks up a Subscriber by its SubscriberQos.SubscriberName within this DomainParticipant.

Returns

The subscriber if it exists or null otherwise

The full documentation is available in the C API: DDS_DomainParticipant_lookup_subscriber_by_name

LookupTopicDescription()

ITopicDescription LookupTopicDescription

(

string

name

)

Looks up an existing, locally created TopicDescription, based on its name.

Returns

The topic description if it exists or null otherwise

The full documentation is available in the C API: DDS_DomainParticipant_lookup_topicdescription

RegisterType() [1/2]

void RegisterType	(	string	name,
		DynamicType	type
	)

Allows registering a dynamic type with a name different than DynamicType.Name

RegisterType() [2/2]

void RegisterType	(	string	name,
		DynamicType	type,
		TypeSerializationProperty	serializationProperty
	)

Allows registering a dynamic type with a name different than DynamicType.Name and with additional serialization properties

RemovePeer()

void RemovePeer

(

string

peer

)

Remove the peer, described by the provided string, from the list of peers that this DomainParticipant will try to contact.

The full documentation is available in the C API: DDS_DomainParticipant_remove_peer

ResetEvents()

override void ResetEvents ( StatusMask  newMask )

virtual

Stop notifying of events not selected in the newMask and remove their event handlers.

Parameters

newMask

Selects which events will continue to receive notifications. Events not included in the status mask will no longer be notified. Use StatusMask.None to remove all event handlers.

Warning

This method has no effect on a DomainParticipant.

Implements Entity.

ResumeEndpointDiscovery()

void ResumeEndpointDiscovery

(

InstanceHandle

remoteParticipantHandle

)

Initiates endpoint discovery with the DomainParticipant identified by the provided InstanceHandle.

The full documentation is available in the C API: DDS_DomainParticipant_resume_endpoint_discovery

ToString()

override string ToString

(

)

Provides a short string representation of the DomainParticipant, including its domain ID and ParticipantName (if set).

Property Documentation

BuiltinSubscriber

Subscriber BuiltinSubscriber

get

Returns the built-in Subscriber.

The built-in Subscriber contains the following DataReaders used for discovery:

• DataReader<Rti.Dds.Topics.SubscriptionBuiltinTopicData> (topic name: Rti.Dds.Subscription.Subscriber.SubscriptionBuiltinTopicName)
• DataReader<Rti.Dds.Topics.PublicationBuiltinTopicData> (topic name: Rti.Dds.Subscription.Subscriber.PublicationBuiltinTopicName)
• DataReader<Rti.Dds.Topics.TopicBuiltinTopicData> (topic name: Rti.Dds.Subscription.Subscriber.TopicBuiltinTopicName)
• DataReader<Rti.Dds.Topics.ParticipantBuiltinTopicData> (topic name: Rti.Dds.Subscription.Subscriber.ParticipantBuiltinTopicName)

Use Rti.Dds.Subscription.Subscriber.LookupDataReader(string) to get access to these readers.

See Entity Discovery

The full documentation is available in the C API: DDS_DomainParticipant_get_builtin_subscriber

ContentFilteredTopics

IEnumerable<AnyContentFilteredTopic> ContentFilteredTopics

get

Retrieve all the ContentFilteredTopics created from this DomainParticipant

CurrentTime

Time CurrentTime

get

Returns the current time using this DomainParticipant's clock

The full documentation is available in the C API: DDS_DomainParticipant_get_current_time

DefaultDataReaderQos

DataReaderQos DefaultDataReaderQos

getset

Get or change the default DataReaderQos.

The full documentation is available in the C API: DDS_DomainParticipant_get_default_datareader_qos

DefaultDataWriterQos

DataWriterQos DefaultDataWriterQos

getset

Get or change the default DataWriterQos.

The full documentation is available in the C API: DDS_DomainParticipant_get_default_datawriter_qos

DefaultPublisherQos

PublisherQos DefaultPublisherQos

getset

Get or change the default PublisherQos.

The full documentation is available in the C API: DDS_DomainParticipant_get_default_publisher_qos

DefaultSubscriberQos

SubscriberQos DefaultSubscriberQos

getset

Get or change the default SubscriberQos.

The full documentation is available in the C API: DDS_DomainParticipant_get_default_subscriber_qos

DefaultTopicQos

TopicQos DefaultTopicQos

getset

Get or change the default TopicQos.

The full documentation is available in the C API: DDS_DomainParticipant_get_default_topic_qos

DiscoveredParticipants

IEnumerable<InstanceHandle> DiscoveredParticipants

get

Retrieve all the DomainParticipant that have been discovered by this DomainParticipant

Returns

An iterable list of all of the discovered DomainParticipants

The full documentation is available in the C API: DDS_DomainParticipant_get_discovered_participants

DiscoveredTopics

IEnumerable<InstanceHandle> DiscoveredTopics

get

Retrieve all the topics that have been discovered by this DomainParticipant. The returned instance handles can be passed to GetDiscoveredTopicData(in InstanceHandle).

Returns

The instance handles identifying the discovered topics.

The full documentation is available in the C API: DDS_DomainParticipant_get_discovered_topics

DomainId

int DomainId

get

Gets this participant's domain id

DomainParticipantProtocolStatus

DomainParticipantProtocolStatus DomainParticipantProtocolStatus

get

Returns the DomainParticipantProtocolStatus.

Returns

The DomainParticipantProtocolStatus of this DomainParticipant.

The full documentation is available in the C API: DDS_DomainParticipant_get_participant_protocol_status

ImplicitPublisher

Publisher ImplicitPublisher

get

Returns the implicit Publisher. If an implicit Publisher does not already exist, this creates one.

The full documentation is available in the C API: DDS_DomainParticipant_get_implicit_publisher

ImplicitSubscriber

Subscriber ImplicitSubscriber

get

Returns the implicit Subscriber. If an implicit Subscriber does not already exist, this creates one.

The full documentation is available in the C API: DDS_DomainParticipant_get_implicit_subscriber

InternalTaskDispatcher

WaitSetAsyncDispatcher InternalTaskDispatcher

get

For internal use only.

Publishers

IEnumerable<Publisher> Publishers

get

Retrieve all the Publisher created from this DomainParticipant

Returns

An iterable list of all of the Publishers created from the DomainParticipant

The full documentation is available in the C API: DDS_DomainParticipant_get_publishers

Qos

DomainParticipantQos Qos

getset

Get or change the QoS of this DomainParticipant.

The full documentation is available in the C API: DDS_DomainParticipant_set_qos

Subscribers

IEnumerable<Subscriber> Subscribers

get

Retrieve all the Subscriber created from this DomainParticipant

Returns

An iterable list of all of the Subscribers created from the DomainParticipant

The full documentation is available in the C API: DDS_DomainParticipant_get_subscribers

Topics

IEnumerable<ITopicDescription> Topics

get

Retrieve all the Topics created from this DomainParticipant