<<interface>> Container for all com.rti.dds.infrastructure.DomainEntity objects. More...

Inheritance diagram for DomainParticipant:

Public Member Functions
void	get_default_flowcontroller_property (FlowControllerProperty_t prop)
	<<eXtension>> Copies the default com.rti.dds.publication.FlowControllerProperty_t values for this domain participant into the given com.rti.dds.publication.FlowControllerProperty_t instance.

void	set_default_flowcontroller_property (FlowControllerProperty_t prop)
	<<eXtension>> Set the default com.rti.dds.publication.FlowControllerProperty_t values for this domain participant.

void	get_default_topic_qos (TopicQos qos)
	Copies the default com.rti.dds.topic.TopicQos values for this domain participant into the given com.rti.dds.topic.TopicQos instance.

void	set_default_topic_qos (TopicQos qos)
	Set the default com.rti.dds.topic.TopicQos values for this domain participant.

void	set_default_topic_qos_with_profile (String library_name, String profile_name)
	<<eXtension>> Set the default com.rti.dds.topic.TopicQos values for this domain participant based on the input XML QoS profile.

void	get_default_publisher_qos (PublisherQos qos)
	Copy the default com.rti.dds.publication.PublisherQos values into the provided com.rti.dds.publication.PublisherQos instance.

void	set_default_publisher_qos (PublisherQos qos)
	Set the default com.rti.dds.publication.PublisherQos values for this DomainParticipant.

void	set_default_publisher_qos_with_profile (String library_name, String profile_name)
	<<eXtension>> Set the default com.rti.dds.publication.PublisherQos values for this DomainParticipant based on the input XML QoS profile.

void	get_default_datawriter_qos (DataWriterQos qos)
	<<eXtension>> Copy the default com.rti.dds.publication.DataWriterQos values into the provided com.rti.dds.publication.DataWriterQos instance.

void	set_default_datawriter_qos (DataWriterQos qos)
	<<eXtension>> Set the default DataWriterQos values for this DomainParticipant.

void	set_default_datawriter_qos_with_profile (String library_name, String profile_name)
	<<eXtension>> Set the default com.rti.dds.publication.DataWriterQos values for this domain participant based on the input XML QoS profile.

void	get_default_datareader_qos (DataReaderQos qos)
	<<eXtension>> Copy the default com.rti.dds.subscription.DataReaderQos values into the provided com.rti.dds.subscription.DataReaderQos instance.

void	set_default_subscriber_qos (SubscriberQos qos)
	Set the default com.rti.dds.subscription.SubscriberQos values for this Domain{articipant.

void	set_default_subscriber_qos_with_profile (String library_name, String profile_name)
	<<eXtension>> Set the default com.rti.dds.subscription.SubscriberQos values for this DomainParticipant based on the input XML QoS profile.

void	get_default_subscriber_qos (SubscriberQos qos)
	Copy the default com.rti.dds.subscription.SubscriberQos values into the provided com.rti.dds.subscription.SubscriberQos instance.

void	set_default_datareader_qos (DataReaderQos qos)
	<<eXtension>> Set the default com.rti.dds.subscription.DataReaderQos values for this domain participant.

void	set_default_datareader_qos_with_profile (String library_name, String profile_name)
	<<eXtension>> Set the default com.rti.dds.subscription.DataReaderQos values for this DomainParticipant based on the input XML QoS profile.

FlowController	create_flowcontroller (String name, FlowControllerProperty_t prop)
	<<eXtension>> Creates a com.rti.dds.publication.FlowController with the desired property.

void	delete_flowcontroller (FlowController fc)
	<<eXtension>> Deletes an existing com.rti.dds.publication.FlowController.

Publisher	create_publisher (PublisherQos qos, PublisherListener listener, int mask)
	Creates a com.rti.dds.publication.Publisher with the desired QoS policies and attaches to it the specified com.rti.dds.publication.PublisherListener.

Publisher	create_publisher_with_profile (String library_name, String profile_name, PublisherListener listener, int mask)
	<<eXtension>> Creates a new com.rti.dds.publication.Publisher object using the com.rti.dds.publication.PublisherQos associated with the input XML QoS profile.

void	delete_publisher (Publisher p)
	Deletes an existing com.rti.dds.publication.Publisher.

Subscriber	create_subscriber (SubscriberQos qos, SubscriberListener listener, int mask)
	Creates a com.rti.dds.subscription.Subscriber with the desired QoS policies and attaches to it the specified com.rti.dds.subscription.SubscriberListener.

Subscriber	create_subscriber_with_profile (String library_name, String profile_name, SubscriberListener listener, int mask)
	<<eXtension>> Creates a new com.rti.dds.subscription.Subscriber object using the com.rti.dds.publication.PublisherQos associated with the input XML QoS profile.

void	delete_subscriber (Subscriber s)
	Deletes an existing com.rti.dds.subscription.Subscriber.

DataWriter	create_datawriter (Topic topic, DataWriterQos qos, DataWriterListener listener, int mask)
	<<eXtension>> Creates a com.rti.dds.publication.DataWriter that will be attached and belong to the implicit com.rti.dds.publication.Publisher.

DataWriter	create_datawriter_with_profile (Topic topic, String library_name, String profile_name, DataWriterListener listener, int mask)
	<<eXtension>> Creates a com.rti.dds.publication.DataWriter using a XML QoS profile that will be attached and belong to the implicit com.rti.dds.publication.Publisher.

void	delete_datawriter (DataWriter a_datawriter)
	<<eXtension>> Deletes a com.rti.dds.publication.DataWriter that belongs to the implicit com.rti.dds.publication.Publisher.

DataReader	create_datareader (TopicDescription topic, DataReaderQos qos, DataReaderListener listener, int mask)
	<<eXtension>> Creates a com.rti.dds.subscription.DataReader that will be attached and belong to the implicit com.rti.dds.subscription.Subscriber.

DataReader	create_datareader_with_profile (TopicDescription topic, String library_name, String profile_name, DataReaderListener listener, int mask)
	<<eXtension>> Creates a com.rti.dds.subscription.DataReader using a XML QoS profile that will be attached and belong to the implicit com.rti.dds.subscription.Subscriber.

void	delete_datareader (DataReader a_datareader)
	<<eXtension>> Deletes a com.rti.dds.subscription.DataReader that belongs to the implicit com.rti.dds.subscription.Subscriber.

Topic	create_topic (String topic_name, String type_name, TopicQos qos, TopicListener listener, int mask)
	Creates a com.rti.dds.topic.Topic with the desired QoS policies and attaches to it the specified com.rti.dds.topic.TopicListener.

Topic	create_topic_with_profile (String topic_name, String type_name, String library_name, String profile_name, TopicListener listener, int mask)
	<<eXtension>> Creates a new com.rti.dds.topic.Topic object using the com.rti.dds.publication.PublisherQos associated with the input XML QoS profile.

void	delete_topic (Topic topic)
	Deletes a com.rti.dds.topic.Topic.

ContentFilteredTopic	create_contentfilteredtopic (String name, Topic related_topic, String filter_expression, StringSeq expression_parameters)
	Creates a com.rti.dds.topic.ContentFilteredTopic, that can be used to do content-based subscriptions.

ContentFilteredTopic	create_contentfilteredtopic_with_filter (String name, Topic related_topic, String filter_expression, StringSeq expression_parameters, String filter_name)
	<<eXtension>> Creates a com.rti.dds.topic.ContentFilteredTopic using the specified filter to do content-based subscriptions.

void	delete_contentfilteredtopic (ContentFilteredTopic a_contentfilteredtopic)
	Deletes a com.rti.dds.topic.ContentFilteredTopic.

MultiTopic	create_multitopic (String name, String type_name, String subscription_expression, StringSeq expression_parameters)
	[Not supported (optional)] Creates a MultiTopic that can be used to subscribe to multiple topics and combine/filter the received data into a resulting type.

void	delete_multitopic (MultiTopic a_multitopic)
	[Not supported (optional)] Deletes a com.rti.dds.topic.MultiTopic.

void	set_qos (DomainParticipantQos qos)
	Change the QoS of this DomainParticipant.

void	set_qos_with_profile (String library_name, String profile_name)
	<<eXtension>> Change the QoS of this domain participant using the input XML QoS profile.

void	get_qos (DomainParticipantQos qos)
	Get the participant QoS.

String	get_default_library ()
	<<eXtension>> Gets the default XML library associated with a com.rti.dds.domain.DomainParticipant.

void	set_default_library (String library_name)
	<<eXtension>> Sets the default XML library for a com.rti.dds.domain.DomainParticipant.

String	get_default_profile ()
	<<eXtension>> Gets the default XML profile associated with a com.rti.dds.domain.DomainParticipant.

void	set_default_profile (String library_name, String profile_name)
	<<eXtension>> Sets the default XML profile for a com.rti.dds.domain.DomainParticipant.

String	get_default_profile_library ()
	<<eXtension>> Gets the library where the default XML QoS profile is contained for a com.rti.dds.domain.DomainParticipant.

void	set_listener (DomainParticipantListener l, int mask)
	Sets the participant listener.

DomainParticipantListener	get_listener ()
	Get the participant listener.

void	get_publishers (PublisherSeq publishers)
	<<eXtension>> Allows the application to access all the publishers the participant has.

void	get_subscribers (SubscriberSeq subscribers)
	<<eXtension>> Allows the application to access all the subscribers the participant has.

Subscriber	get_builtin_subscriber ()
	Accesses the built-in com.rti.dds.subscription.Subscriber.

FlowController	lookup_flowcontroller (String name)
	<<eXtension>> Looks up an existing locally-created com.rti.dds.publication.FlowController, based on its name.

Topic	find_topic (String topic_name, Duration_t timeout)
	Finds an existing (or ready to exist) com.rti.dds.topic.Topic, based on its name.

TopicDescription	lookup_topicdescription (String topic_name)
	Looks up an existing, locally created com.rti.dds.topic.TopicDescription, based on its name.

void	ignore_participant (InstanceHandle_t handle)
	Instructs RTI Connext to locally ignore a remote com.rti.dds.domain.DomainParticipant.

void	ignore_topic (InstanceHandle_t handle)
	Instructs RTI Connext to locally ignore a com.rti.dds.topic.Topic.

void	ignore_publication (InstanceHandle_t handle)
	Instructs RTI Connext to locally ignore a publication.

void	ignore_subscription (InstanceHandle_t handle)
	Instructs RTI Connext to locally ignore a subscription.

int	get_domain_id ()
	Get the unique domain identifier.

void	assert_liveliness ()
	Manually asserts the liveliness of this com.rti.dds.domain.DomainParticipant.

void	delete_contained_entities ()
	Delete all the entities that were created by means of the "create" operations on the com.rti.dds.domain.DomainParticipant.

void	add_peer (String peer_desc_string)
	<<eXtension>> Attempt to contact one or more additional peer participants.

void	remove_peer (String peer_desc_string)
	<<eXtension>> Remove one or more peer participants from the list of peers with which this com.rti.dds.domain.DomainParticipant will try to communicate.

void	get_current_time (Time_t current_time)
	Returns the current value of the time.

void	get_discovered_participants (InstanceHandleSeq participant_handles)
	Returns list of discovered com.rti.dds.domain.DomainParticipant s.

void	get_discovered_participant_data (ParticipantBuiltinTopicData participant_data, InstanceHandle_t participant_handle)
	Returns builtin.ParticipantBuiltinTopicData for the specified com.rti.dds.domain.DomainParticipant .

void	get_discovered_topics (InstanceHandleSeq topic_handles)
	Returns list of discovered com.rti.dds.topic.Topic objects.

void	get_discovered_topic_data (TopicBuiltinTopicData topic_data, InstanceHandle_t topic_handle)
	Returns builtin.TopicBuiltinTopicData for the specified com.rti.dds.topic.Topic.

boolean	contains_entity (InstanceHandle_t a_handle)
	Completes successfully with com.rti.dds.infrastructure.true if the referenced com.rti.dds.infrastructure.Entity is contained by the com.rti.dds.domain.DomainParticipant.

void	register_durable_subscription (EndpointGroup_t group, String topic_name)
	Registers a Durable Subscription on the specified com.rti.dds.topic.Topic on all Persistence Services.

void	delete_durable_subscription (EndpointGroup_t group)
	Deletes an existing Durable Subscription on all Persistence Services.

void	register_contentfilter (String filter_name, ContentFilter contentfilter)
	<<eXtension>> Register a content filter which can be used to create a com.rti.dds.topic.ContentFilteredTopic.

ContentFilter	lookup_contentfilter (String filter_name)
	<<eXtension>> Lookup a content filter previously registered with com.rti.dds.domain.DomainParticipant.register_contentfilter.

void	unregister_contentfilter (String filter_name)
	<<eXtension>> Unregister a content filter previously registered with com.rti.dds.domain.DomainParticipant.register_contentfilter.

Publisher	get_implicit_publisher ()
	<<eXtension>> Returns the implicit com.rti.dds.publication.Publisher. If an implicit Publisher does not already exist, this creates one.

Subscriber	get_implicit_subscriber ()
	<<eXtension>> Returns the implicit com.rti.dds.subscription.Subscriber. If an implicit Subscriber does not already exist, this creates one.

abstract Publisher	lookup_publisher_by_name_exp (String publisher_name)
	<<experimental>> <<eXtension>> Looks up a com.rti.dds.publication.Publisher by its entity name within this com.rti.dds.domain.DomainParticipant.

abstract Subscriber	lookup_subscriber_by_name_exp (String subscriber_name)
	<<experimental>> <<eXtension>> Retrieves a com.rti.dds.subscription.Subscriber by its entity name within this com.rti.dds.domain.DomainParticipant.

abstract DataWriter	lookup_datawriter_by_name_exp (String datawriter_full_name)
	<<experimental>> <<eXtension>> Looks up a com.rti.dds.publication.DataWriter by its entity name within this com.rti.dds.domain.DomainParticipant.

abstract DataReader	lookup_datareader_by_name_exp (String datareder_full_name)
	<<experimental>> <<eXtension>> Retrieves up a com.rti.dds.subscription.DataReader by its entity name in this com.rti.dds.domain.DomainParticipant.

Public Member Functions inherited from Entity
void	enable ()
	Enables the com.rti.dds.infrastructure.Entity.

StatusCondition	get_statuscondition ()
	Allows access to the com.rti.dds.infrastructure.StatusCondition associated with the com.rti.dds.infrastructure.Entity.

int	get_status_changes ()
	Retrieves the list of communication statuses in the com.rti.dds.infrastructure.Entity that are triggered.

InstanceHandle_t	get_instance_handle ()
	Allows access to the com.rti.dds.infrastructure.InstanceHandle_t associated with the com.rti.dds.infrastructure.Entity.

Static Public Attributes
static final TopicQos	TOPIC_QOS_DEFAULT = new TopicQos()
	Special value for creating a com.rti.dds.topic.Topic with default QoS.

static final PublisherQos	PUBLISHER_QOS_DEFAULT = new PublisherQos()
	Special value for creating a com.rti.dds.publication.Publisher with default QoS.

static final SubscriberQos	SUBSCRIBER_QOS_DEFAULT
	Special value for creating a com.rti.dds.subscription.Subscriber with default QoS.

static final FlowControllerProperty_t	FLOW_CONTROLLER_PROPERTY_DEFAULT
	<<eXtension>> Special value for creating a com.rti.dds.publication.FlowController with default property.

static final String	SQLFILTER_NAME
	<<eXtension>> The name of the built-in SQL filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.

static final String	STRINGMATCHFILTER_NAME
	<<eXtension>> The name of the built-in StringMatch filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.

Detailed Description

<<interface>> Container for all com.rti.dds.infrastructure.DomainEntity objects.

The DomainParticipant object plays several roles:

- It acts as a container for all other com.rti.dds.infrastructure.Entity objects.

- It acts as factory for the com.rti.dds.publication.Publisher, com.rti.dds.subscription.Subscriber, com.rti.dds.topic.Topic and com.rti.dds.topic.MultiTopic com.rti.dds.infrastructure.Entity 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 (ignore_participant()), publication (ignore_publication()), subscription (ignore_subscription()) or topic (ignore_topic()).

The following operations may be called even if the com.rti.dds.domain.DomainParticipant is not enabled. (Operations NOT in this list will fail with the value com.rti.dds.infrastructure.RETCODE_NOT_ENABLED if called on a disabled DomainParticipant).

Operations defined at the base-class level: set_qos(), set_qos_with_profile(), get_qos(), set_listener(), get_listener(), enable();

Factory operations: create_flowcontroller(), create_topic(), create_topic_with_profile(), create_publisher(), create_publisher_with_profile(), create_subscriber(), create_subscriber_with_profile(), delete_flowcontroller(), delete_topic(), delete_publisher(), delete_subscriber(), set_default_flowcontroller_property(), get_default_flowcontroller_property(), set_default_topic_qos(), set_default_topic_qos_with_profile(), get_default_topic_qos(), set_default_publisher_qos(), set_default_publisher_qos_with_profile(), get_default_publisher_qos(), set_default_subscriber_qos(), set_default_subscriber_qos_with_profile(), get_default_subscriber_qos(), delete_contained_entities(), set_default_datareader_qos(), set_default_datareader_qos_with_profile(), get_default_datareader_qos(), set_default_datawriter_qos(), set_default_datawriter_qos_with_profile(), get_default_datawriter_qos(), set_default_library(), set_default_profile();

Operations for looking up topics: lookup_topicdescription();

Operations that access status: get_statuscondition(), get_status_changes().

QoS:: com.rti.dds.domain.DomainParticipantQos

Status:: Status Kinds

Listener:: com.rti.dds.domain.DomainParticipantListener

See Also: Operations Allowed in Listener Callbacks

Member Function Documentation

void get_default_flowcontroller_property ( FlowControllerProperty_t prop )

<<eXtension>> Copies the default com.rti.dds.publication.FlowControllerProperty_t values for this domain participant into the given com.rti.dds.publication.FlowControllerProperty_t instance.

The retrieved property will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property, or else, if the call was never made, the default values listed in com.rti.dds.publication.FlowControllerProperty_t.

MT Safety:: UNSAFE. It is not safe to retrieve the default flow controller properties from a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property

Parameters

prop	<<in>> Default property to be retrieved. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See Also: com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT; com.rti.dds.domain.DomainParticipant.create_flowcontroller

void set_default_flowcontroller_property ( FlowControllerProperty_t prop )

<<eXtension>> Set the default com.rti.dds.publication.FlowControllerProperty_t values for this domain participant.

This default value will be used for newly created com.rti.dds.publication.FlowController if com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT is specified as the property parameter when com.rti.dds.domain.DomainParticipant.create_flowcontroller is called.

Precondition: The specified property values must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default flow controller properties for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property , com.rti.dds.domain.DomainParticipant.get_default_flowcontroller_property or calling com.rti.dds.domain.DomainParticipant.create_flowcontroller with com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT as the qos parameter.

Parameters

prop <<in>> Default property to be set. The special value com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT may be passed as property to indicate that the default property should be reset to the default values the factory would use if com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property had never been called. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

See Also: com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT; com.rti.dds.domain.DomainParticipant.create_flowcontroller

void get_default_topic_qos ( TopicQos qos )

Copies the default com.rti.dds.topic.TopicQos values for this domain participant into the given com.rti.dds.topic.TopicQos instance.

The retrieved qos will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_topic_qos, or else, if the call was never made, the default values listed in com.rti.dds.topic.TopicQos.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

MT Safety:: UNSAFE. It is not safe to retrieve the default Topic QoS from a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_topic_qos

Parameters

qos	<<in>> Default qos to be retrieved. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See Also: com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_topic

void set_default_topic_qos ( TopicQos qos )

Set the default com.rti.dds.topic.TopicQos values for this domain participant.

This default value will be used for newly created com.rti.dds.topic.Topic if com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT is specified as the qos parameter when com.rti.dds.domain.DomainParticipant.create_topic is called.

Precondition: The specified QoS policies must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default topic QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_topic_qos, com.rti.dds.domain.DomainParticipant.get_default_topic_qos or calling com.rti.dds.domain.DomainParticipant.create_topic with com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT as the qos parameter.

Parameters

qos <<in>> Default qos to be set. The special value com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if com.rti.dds.domain.DomainParticipant.set_default_topic_qos had never been called. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

See Also: com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_topic

void set_default_topic_qos_with_profile	(	String	library_name,
		String	profile_name
	)

<<eXtension>> Set the default com.rti.dds.topic.TopicQos values for this domain participant based on the input XML QoS profile.

This default value will be used for newly created com.rti.dds.topic.Topic if com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT is specified as the qos parameter when com.rti.dds.domain.DomainParticipant.create_topic is called.

Precondition: The com.rti.dds.topic.TopicQos contained in the specified XML QoS profile must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default topic QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_topic_qos, com.rti.dds.domain.DomainParticipant.get_default_topic_qos or calling com.rti.dds.domain.DomainParticipant.create_topic with com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT as the qos parameter.

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).

If the input profile cannot be found the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

See Also: com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_topic_with_profile

void get_default_publisher_qos ( PublisherQos qos )

Copy the default com.rti.dds.publication.PublisherQos values into the provided com.rti.dds.publication.PublisherQos instance.

The retrieved qos will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_publisher_qos, or com.rti.dds.domain.DomainParticipant.set_default_publisher_qos_with_profile, or else, if the call was never made, the default values listed in com.rti.dds.publication.PublisherQos.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

If com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT is specified as the qos parameter when com.rti.dds.domain.DomainParticipant.create_topic is called, the default value of the QoS set in the factory, equivalent to the value obtained by calling com.rti.dds.domain.DomainParticipant.get_default_publisher_qos, will be used to create the com.rti.dds.publication.Publisher.

MT Safety:: UNSAFE. It is not safe to retrieve the default publisher QoS from a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_publisher_qos

Parameters

qos	<<inout>> Qos to be filled up. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See Also: com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_publisher

void set_default_publisher_qos ( PublisherQos qos )

Set the default com.rti.dds.publication.PublisherQos values for this DomainParticipant.

This set of default values will be used for a newly created com.rti.dds.publication.Publisher if com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT is specified as the qos parameter when com.rti.dds.domain.DomainParticipant.create_publisher is called.

Precondition: The specified QoS policies must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default publisher QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_publisher_qos, com.rti.dds.domain.DomainParticipant.get_default_publisher_qos or calling com.rti.dds.domain.DomainParticipant.create_publisher with com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT as the qos parameter.

Parameters

qos <<in>> Default qos to be set. The special value com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if com.rti.dds.domain.DomainParticipant.set_default_publisher_qos had never been called. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

See Also: com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_publisher

void set_default_publisher_qos_with_profile	(	String	library_name,
		String	profile_name
	)

<<eXtension>> Set the default com.rti.dds.publication.PublisherQos values for this DomainParticipant based on the input XML QoS profile.

This set of default values will be used for a newly created com.rti.dds.publication.Publisher if com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT is specified as the qos parameter when com.rti.dds.domain.DomainParticipant.create_publisher is called.

Precondition: The com.rti.dds.publication.PublisherQos contained in the specified XML QoS profile must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default publisher QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_publisher_qos, com.rti.dds.domain.DomainParticipant.get_default_publisher_qos or calling com.rti.dds.domain.DomainParticipant.create_publisher with com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT as the qos parameter.

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).

If the input profile cannot be found, the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

See Also: com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_publisher_with_profile

void get_default_datawriter_qos ( DataWriterQos qos )

<<eXtension>> Copy the default com.rti.dds.publication.DataWriterQos values into the provided com.rti.dds.publication.DataWriterQos instance.

The retrieved qos will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos, or com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos_with_profile, or else, if the call was never made, the default values listed in com.rti.dds.publication.DataWriterQos.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

MT Safety:: UNSAFE. It is not safe to retrieve the default DataWriter QoS from a DomainPartipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos.

Parameters

qos	<<inout>> Qos to be filled up. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

void set_default_datawriter_qos ( DataWriterQos qos )

<<eXtension>> Set the default DataWriterQos values for this DomainParticipant.

This set of default values will be inherited for a newly created com.rti.dds.publication.Publisher.

Precondition: The specified QoS policies must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default DataWriter QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos or com.rti.dds.domain.DomainParticipant.get_default_datawriter_qos.

Parameters

qos <<in>> Default qos to be set. The special value com.rti.dds.publication.Publisher.DATAWRITER_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos had never been called. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

void set_default_datawriter_qos_with_profile	(	String	library_name,
		String	profile_name
	)

<<eXtension>> Set the default com.rti.dds.publication.DataWriterQos values for this domain participant based on the input XML QoS profile.

This set of default values will be inherited for a newly created com.rti.dds.publication.Publisher.

Precondition: The com.rti.dds.publication.DataWriterQos contained in the specified XML QoS profile must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default DataWriter QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos or com.rti.dds.domain.DomainParticipant.get_default_datawriter_qos

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).

If the input profile cannot be found, the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

void get_default_datareader_qos ( DataReaderQos qos )

<<eXtension>> Copy the default com.rti.dds.subscription.DataReaderQos values into the provided com.rti.dds.subscription.DataReaderQos instance.

The retrieved qos will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_datareader_qos, or com.rti.dds.domain.DomainParticipant.set_default_datareader_qos_with_profile, or else, if the call was never made, the default values listed in com.rti.dds.subscription.DataReaderQos.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

MT Safety:: UNSAFE. It is not safe to retrieve the default DataReader QoS from a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datareader_qos.

Parameters

qos	<<inout>> Qos to be filled up. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

void set_default_subscriber_qos ( SubscriberQos qos )

Set the default com.rti.dds.subscription.SubscriberQos values for this Domain{articipant.

This set of default values will be used for a newly created com.rti.dds.subscription.Subscriber if com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT is specified as the qos parameter when com.rti.dds.domain.DomainParticipant.create_subscriber is called.

Precondition: The specified QoS policies must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default Subscriber QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos, com.rti.dds.domain.DomainParticipant.get_default_subscriber_qos or calling com.rti.dds.domain.DomainParticipant.create_subscriber with com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT as the qos parameter.

Parameters

qos <<in>> Default qos to be set. The special value com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos had never been called. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

void set_default_subscriber_qos_with_profile	(	String	library_name,
		String	profile_name
	)

<<eXtension>> Set the default com.rti.dds.subscription.SubscriberQos values for this DomainParticipant based on the input XML QoS profile.

This set of default values will be used for a newly created com.rti.dds.subscription.Subscriber if com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT is specified as the qos parameter when com.rti.dds.domain.DomainParticipant.create_subscriber is called.

Precondition: The com.rti.dds.subscription.SubscriberQos contained in the specified XML QoS profile must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default Subscriber QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos, com.rti.dds.domain.DomainParticipant.get_default_subscriber_qos or calling com.rti.dds.domain.DomainParticipant.create_subscriber with com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT as the qos parameter.

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).

If the input profile cannot be found, the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

See Also: com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_subscriber_with_profile

void get_default_subscriber_qos ( SubscriberQos qos )

Copy the default com.rti.dds.subscription.SubscriberQos values into the provided com.rti.dds.subscription.SubscriberQos instance.

The retrieved qos will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos, or com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos_with_profile, or else, if the call was never made, the default values listed in com.rti.dds.subscription.SubscriberQos.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

If com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT is specified as the qos parameter when com.rti.dds.domain.DomainParticipant.create_subscriber is called, the default value of the QoS set in the factory, equivalent to the value obtained by calling com.rti.dds.domain.DomainParticipant.get_default_subscriber_qos, will be used to create the com.rti.dds.subscription.Subscriber.

MT Safety:: UNSAFE. It is not safe to retrieve the default Subscriber QoS from a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos.

Parameters

qos	<<inout>> Qos to be filled up. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See Also: com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_subscriber

void set_default_datareader_qos ( DataReaderQos qos )

<<eXtension>> Set the default com.rti.dds.subscription.DataReaderQos values for this domain participant.

This set of default values will be inherited for a newly created com.rti.dds.subscription.Subscriber.

Precondition: The specified QoS policies must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default DataReader QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datareader_qos or com.rti.dds.domain.DomainParticipant.get_default_datareader_qos.

Parameters

qos <<in>> Default qos to be set. The special value com.rti.dds.subscription.Subscriber.DATAREADER_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if com.rti.dds.domain.DomainParticipant.set_default_datareader_qos had never been called. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

void set_default_datareader_qos_with_profile	(	String	library_name,
		String	profile_name
	)

<<eXtension>> Set the default com.rti.dds.subscription.DataReaderQos values for this DomainParticipant based on the input XML QoS profile.

This set of default values will be inherited for a newly created com.rti.dds.subscription.Subscriber.

Precondition: The com.rti.dds.subscription.DataReaderQos contained in the specified XML QoS profile must be consistent, or else the operation will have no effect and fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

MT Safety:: UNSAFE. It is not safe to set the default DataReader QoS for a DomainParticipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datareader_qos or com.rti.dds.domain.DomainParticipant.get_default_datareader_qos.

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).

If the input profile cannot be found, the method fails with com.rti.dds.infrastructure.RETCODE_ERROR.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY

FlowController create_flowcontroller	(	String	name,
		FlowControllerProperty_t	prop
	)

<<eXtension>> Creates a com.rti.dds.publication.FlowController with the desired property.

The created com.rti.dds.publication.FlowController is associated with a com.rti.dds.publication.DataWriter via com.rti.dds.infrastructure.PublishModeQosPolicy.flow_controller_name. A single com.rti.dds.publication.FlowController may service multiple com.rti.dds.publication.DataWriter instances, even if they belong to a different com.rti.dds.publication.Publisher. The property determines how the com.rti.dds.publication.FlowController shapes the network traffic.

Precondition: The specified property must be consistent, or the operation will fail and no com.rti.dds.publication.FlowController will be created.

MT Safety:: UNSAFE. If com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT is used for property, it is not safe to create the flow controller while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property or trying to lookup that flow controller with com.rti.dds.domain.DomainParticipant.lookup_flowcontroller.

Parameters

name	<<in>> name of the com.rti.dds.publication.FlowController to create. A com.rti.dds.publication.DataWriter is associated with a com.rti.dds.publication.FlowController by name. Limited to 255 characters.
prop	<<in>> property to be used for creating the new com.rti.dds.publication.FlowController. The special value com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT can be used to indicate that the com.rti.dds.publication.FlowController should be created with the default com.rti.dds.publication.FlowControllerProperty_t set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL.

Returns: Newly created flow controller object or NULL on failure.

See Also: com.rti.dds.publication.FlowControllerProperty_t for rules on consistency among property; com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT; com.rti.dds.domain.DomainParticipant.get_default_flowcontroller_property

void delete_flowcontroller ( FlowController fc )

<<eXtension>> Deletes an existing com.rti.dds.publication.FlowController.

Precondition: The com.rti.dds.publication.FlowController must not have any attached com.rti.dds.publication.DataWriter objects. If there are any attached com.rti.dds.publication.DataWriter objects, it will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.; The com.rti.dds.publication.FlowController must have been created by this com.rti.dds.domain.DomainParticipant, or else it will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Postcondition: The com.rti.dds.publication.FlowController is deleted if this method completes successfully.

Parameters

fc	<<in>> The com.rti.dds.publication.FlowController to be deleted.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Publisher create_publisher	(	PublisherQos	qos,
		PublisherListener	listener,
		int	mask
	)

Creates a com.rti.dds.publication.Publisher with the desired QoS policies and attaches to it the specified com.rti.dds.publication.PublisherListener.

Precondition: The specified QoS policies must be consistent, or the operation will fail and no com.rti.dds.publication.Publisher will be created.

MT Safety:: UNSAFE. If com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT is used for qos, it is not safe to create the publisher while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_publisher_qos.

Parameters

qos	<<in>> QoS to be used for creating the new com.rti.dds.publication.Publisher. The special value com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT can be used to indicate that the com.rti.dds.publication.Publisher should be created with the default com.rti.dds.publication.PublisherQos set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL.
listener	<<in>>. Listener to be attached to the newly created com.rti.dds.publication.Publisher.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: newly created publisher object or NULL on failure.

See Also: Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.publication.PublisherQos for rules on consistency among QoS; com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_publisher_with_profile; com.rti.dds.domain.DomainParticipant.get_default_publisher_qos; com.rti.dds.publication.Publisher.set_listener

Publisher create_publisher_with_profile	(	String	library_name,
		String	profile_name,
		PublisherListener	listener,
		int	mask
	)

<<eXtension>> Creates a new com.rti.dds.publication.Publisher object using the com.rti.dds.publication.PublisherQos associated with the input XML QoS profile.

Precondition: The com.rti.dds.publication.PublisherQos in the input profile must be consistent, or the operation will fail and no com.rti.dds.publication.Publisher will be created.

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).
listener	<<in>>. Listener to be attached to the newly created com.rti.dds.publication.Publisher.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: newly created publisher object or NULL on failure.

See Also: Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.publication.PublisherQos for rules on consistency among QoS; com.rti.dds.domain.DomainParticipant.create_publisher; com.rti.dds.domain.DomainParticipant.get_default_publisher_qos; com.rti.dds.publication.Publisher.set_listener

void delete_publisher ( Publisher p )

Deletes an existing com.rti.dds.publication.Publisher.

Precondition: The com.rti.dds.publication.Publisher must not have any attached com.rti.dds.publication.DataWriter objects. If there are existing com.rti.dds.publication.DataWriter objects, it will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.; com.rti.dds.publication.Publisher must have been created by this com.rti.dds.domain.DomainParticipant, or else it will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Postcondition: Listener installed on the com.rti.dds.publication.Publisher will not be called after this method completes successfully.

Parameters

p	<<in>> com.rti.dds.publication.Publisher to be deleted.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Subscriber create_subscriber	(	SubscriberQos	qos,
		SubscriberListener	listener,
		int	mask
	)

Creates a com.rti.dds.subscription.Subscriber with the desired QoS policies and attaches to it the specified com.rti.dds.subscription.SubscriberListener.

Precondition: The specified QoS policies must be consistent, or the operation will fail and no com.rti.dds.subscription.Subscriber will be created.

MT Safety:: UNSAFE. If com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT is used for qos, it is not safe to create the subscriber while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos.

Parameters

qos	<<in>> QoS to be used for creating the new com.rti.dds.subscription.Subscriber. The special value com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT can be used to indicate that the com.rti.dds.subscription.Subscriber should be created with the default com.rti.dds.subscription.SubscriberQos set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL.
listener	<<in>>. Listener to be attached to the newly created com.rti.dds.subscription.Subscriber.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: newly created subscriber object or NULL on failure.

See Also: Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.subscription.SubscriberQos for rules on consistency among QoS; com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_subscriber_with_profile; com.rti.dds.domain.DomainParticipant.get_default_subscriber_qos; com.rti.dds.subscription.Subscriber.set_listener

Subscriber create_subscriber_with_profile	(	String	library_name,
		String	profile_name,
		SubscriberListener	listener,
		int	mask
	)

<<eXtension>> Creates a new com.rti.dds.subscription.Subscriber object using the com.rti.dds.publication.PublisherQos associated with the input XML QoS profile.

Precondition: The com.rti.dds.subscription.SubscriberQos in the input profile must be consistent, or the operation will fail and no com.rti.dds.subscription.Subscriber will be created.

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).
listener	<<in>>. Listener to be attached to the newly created com.rti.dds.subscription.Subscriber.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: newly created subscriber object or NULL on failure.

See Also: Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.subscription.SubscriberQos for rules on consistency among QoS; com.rti.dds.domain.DomainParticipant.create_subscriber; com.rti.dds.domain.DomainParticipant.get_default_subscriber_qos; com.rti.dds.subscription.Subscriber.set_listener

void delete_subscriber ( Subscriber s )

Deletes an existing com.rti.dds.subscription.Subscriber.

Precondition: The com.rti.dds.subscription.Subscriber must not have any attached com.rti.dds.subscription.DataReader objects. If there are existing com.rti.dds.subscription.DataReader objects, it will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET; The com.rti.dds.subscription.Subscriber must have been created by this com.rti.dds.domain.DomainParticipant, or else it will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Postcondition: A Listener installed on the com.rti.dds.subscription.Subscriber will not be called after this method completes successfully.

Parameters

s	<<in>> com.rti.dds.subscription.Subscriber to be deleted.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

DataWriter create_datawriter	(	Topic	topic,
		DataWriterQos	qos,
		DataWriterListener	listener,
		int	mask
	)

<<eXtension>> Creates a com.rti.dds.publication.DataWriter that will be attached and belong to the implicit com.rti.dds.publication.Publisher.

Precondition: The given com.rti.dds.topic.Topic must have been created from the same DomainParticipant as the implicit Publisher. If it was created from a different DomainParticipant, this method will fail.

The com.rti.dds.publication.DataWriter created using this method will be associated with the implicit Publisher. This Publisher is automatically created (if it does not exist) using com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT when the following methods are called: com.rti.dds.domain.DomainParticipant.create_datawriter, com.rti.dds.domain.DomainParticipant.create_datawriter_with_profile, or com.rti.dds.domain.DomainParticipant.get_implicit_publisher.

MT Safety:: UNSAFE. If com.rti.dds.publication.Publisher.DATAWRITER_QOS_DEFAULT is used for the qos parameter, it is not safe to create the DataWriter while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datawriter_qos.

Parameters

topic	<<in>> The com.rti.dds.topic.Topic that the com.rti.dds.publication.DataWriter will be associated with. Cannot be NULL.
qos	<<in>> QoS to be used for creating the new com.rti.dds.publication.DataWriter. The special value com.rti.dds.publication.Publisher.DATAWRITER_QOS_DEFAULT can be used to indicate that the com.rti.dds.publication.DataWriter should be created with the default com.rti.dds.publication.DataWriterQos set in the implicit com.rti.dds.publication.Publisher. The special value com.rti.dds.publication.Publisher.DATAWRITER_QOS_USE_TOPIC_QOS can be used to indicate that the com.rti.dds.publication.DataWriter should be created with the combination of the default com.rti.dds.publication.DataWriterQos set on the com.rti.dds.publication.Publisher and the com.rti.dds.topic.TopicQos of the com.rti.dds.topic.Topic. Cannot be NULL.
listener	<<in>> The listener of the com.rti.dds.publication.DataWriter.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: A com.rti.dds.publication.DataWriter of a derived class specific to the data type associated with the com.rti.dds.topic.Topic or NULL if an error occurred.

See Also: com.rti.ndds.example.FooDataWriter; Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.publication.DataWriterQos for rules on consistency among QoS; com.rti.dds.publication.Publisher.DATAWRITER_QOS_DEFAULT; com.rti.dds.publication.Publisher.DATAWRITER_QOS_USE_TOPIC_QOS; com.rti.dds.domain.DomainParticipant.create_datawriter_with_profile; com.rti.dds.domain.DomainParticipant.get_default_datawriter_qos; com.rti.dds.domain.DomainParticipant.get_implicit_publisher; com.rti.dds.topic.Topic.set_qos; com.rti.dds.publication.DataWriter.set_listener

DataWriter create_datawriter_with_profile	(	Topic	topic,
		String	library_name,
		String	profile_name,
		DataWriterListener	listener,
		int	mask
	)

<<eXtension>> Creates a com.rti.dds.publication.DataWriter using a XML QoS profile that will be attached and belong to the implicit com.rti.dds.publication.Publisher.

Precondition: The given com.rti.dds.topic.Topic must have been created from the same DomainParticipant as the implicit Publisher. If it was created from a different DomainParticipant, this method will return NULL.

The com.rti.dds.publication.DataWriter created using this method will be associated with the implicit Publisher. This Publisher is automatically created (if it does not exist) using com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT when the following methods are called: com.rti.dds.domain.DomainParticipant.create_datawriter, com.rti.dds.domain.DomainParticipant.create_datawriter_with_profile, or com.rti.dds.domain.DomainParticipant.get_implicit_publisher

Parameters

topic	<<in>> The com.rti.dds.topic.Topic that the com.rti.dds.publication.DataWriter will be associated with. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).
listener	<<in>> The listener of the com.rti.dds.publication.DataWriter.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: A com.rti.dds.publication.DataWriter of a derived class specific to the data type associated with the com.rti.dds.topic.Topic or NULL if an error occurred.

See Also: com.rti.ndds.example.FooDataWriter; Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.publication.DataWriterQos for rules on consistency among QoS; com.rti.dds.domain.DomainParticipant.create_datawriter; com.rti.dds.domain.DomainParticipant.get_default_datawriter_qos; com.rti.dds.domain.DomainParticipant.get_implicit_publisher; com.rti.dds.topic.Topic.set_qos; com.rti.dds.publication.DataWriter.set_listener

void delete_datawriter ( DataWriter a_datawriter )

<<eXtension>> Deletes a com.rti.dds.publication.DataWriter that belongs to the implicit com.rti.dds.publication.Publisher.

The deletion of the com.rti.dds.publication.DataWriter will automatically unregister all instances. Depending on the settings of the WRITER_DATA_LIFECYCLE QosPolicy, the deletion of the com.rti.dds.publication.DataWriter may also dispose all instances.

Special Instructions if Using 'Timestamp' APIs and BY_SOURCE_TIMESTAMP Destination Ordering:

If the DataWriter's com.rti.dds.infrastructure.DestinationOrderQosPolicy.kind is com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS, calls to delete_datawriter() may fail if your application has previously used the 'with timestamp' APIs (write_w_timestamp(), register_instance_w_timestamp(), unregister_instance_w_timestamp(), or dispose_w_timestamp()) with a timestamp larger (later) than the time at which delete_datawriter() is called. To prevent delete_datawriter() from failing in this situation, either:

Change the WRITER_DATA_LIFECYCLE QosPolicy so that RTI Connext will not autodispose unregistered instances (set com.rti.dds.infrastructure.WriterDataLifecycleQosPolicy.autodispose_unregistered_instances to com.rti.dds.infrastructure.false.) or
Explicitly call unregister_instance_w_timestamp() for all instances modified with the *_w_timestamp() APIs before calling delete_datawriter().

Precondition: If the com.rti.dds.publication.DataWriter does not belong to the implicit com.rti.dds.publication.Publisher, the operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Postcondition: Listener installed on the com.rti.dds.publication.DataWriter will not be called after this method completes successfully.

Parameters

a_datawriter <<in>> The com.rti.dds.publication.DataWriter to be deleted.

Exceptions

One	of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

See Also: com.rti.dds.domain.DomainParticipant.get_implicit_publisher

DataReader create_datareader	(	TopicDescription	topic,
		DataReaderQos	qos,
		DataReaderListener	listener,
		int	mask
	)

<<eXtension>> Creates a com.rti.dds.subscription.DataReader that will be attached and belong to the implicit com.rti.dds.subscription.Subscriber.

Precondition: The given com.rti.dds.topic.TopicDescription must have been created from the same DomainParticipant as the implicit Subscriber. If it was created from a different DomainParticipant, this method will return NULL.

The com.rti.dds.subscription.DataReader created using this method will be associated with the implicit Subscriber. This Subscriber is automatically created (if it does not exist) using com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT when the following methods are called: com.rti.dds.domain.DomainParticipant.create_datareader, com.rti.dds.domain.DomainParticipant.create_datareader_with_profile, or com.rti.dds.domain.DomainParticipant.get_implicit_subscriber.

MT Safety:: UNSAFE. If com.rti.dds.subscription.Subscriber.DATAREADER_QOS_DEFAULT is used for the qos parameter, it is not safe to create the datareader while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_datareader_qos.

Parameters

topic	<<in>> The com.rti.dds.topic.TopicDescription that the com.rti.dds.subscription.DataReader will be associated with. Cannot be NULL.
qos	<<in>> The qos of the com.rti.dds.subscription.DataReader. The special value com.rti.dds.subscription.Subscriber.DATAREADER_QOS_DEFAULT can be used to indicate that the com.rti.dds.subscription.DataReader should be created with the default com.rti.dds.subscription.DataReaderQos set in the implicit com.rti.dds.subscription.Subscriber. If com.rti.dds.topic.TopicDescription is of type com.rti.dds.topic.Topic or com.rti.dds.topic.ContentFilteredTopic, the special value com.rti.dds.subscription.Subscriber.DATAREADER_QOS_USE_TOPIC_QOS can be used to indicate that the com.rti.dds.subscription.DataReader should be created with the combination of the default com.rti.dds.subscription.DataReaderQos set on the implicit com.rti.dds.subscription.Subscriber and the com.rti.dds.topic.TopicQos (in the case of a com.rti.dds.topic.ContentFilteredTopic, the com.rti.dds.topic.TopicQos of the related com.rti.dds.topic.Topic). if com.rti.dds.subscription.Subscriber.DATAREADER_QOS_USE_TOPIC_QOS is used, `topic` cannot be a com.rti.dds.topic.MultiTopic. Cannot be NULL.
listener	<<in>> The listener of the com.rti.dds.subscription.DataReader.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: A com.rti.dds.subscription.DataReader of a derived class specific to the data-type associated with the com.rti.dds.topic.Topic or NULL if an error occurred.

See Also: com.rti.ndds.example.FooDataReader; Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.subscription.DataReaderQos for rules on consistency among QoS; com.rti.dds.domain.DomainParticipant.create_datareader_with_profile; com.rti.dds.domain.DomainParticipant.get_default_datareader_qos; com.rti.dds.domain.DomainParticipant.get_implicit_subscriber; com.rti.dds.topic.Topic.set_qos; com.rti.dds.subscription.DataReader.set_listener

DataReader create_datareader_with_profile	(	TopicDescription	topic,
		String	library_name,
		String	profile_name,
		DataReaderListener	listener,
		int	mask
	)

<<eXtension>> Creates a com.rti.dds.subscription.DataReader using a XML QoS profile that will be attached and belong to the implicit com.rti.dds.subscription.Subscriber.

Precondition: The given com.rti.dds.topic.TopicDescription must have been created from the same DomainParticipant as the implicit subscriber. If it was created from a different DomainParticipant, this method will return NULL.

The com.rti.dds.subscription.DataReader created using this method will be associated with the implicit Subscriber. This Subscriber is automatically created (if it does not exist) using com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT when the following methods are called: com.rti.dds.domain.DomainParticipant.create_datareader, com.rti.dds.domain.DomainParticipant.create_datareader_with_profile, or com.rti.dds.domain.DomainParticipant.get_implicit_subscriber

Parameters

topic	<<in>> The com.rti.dds.topic.TopicDescription that the com.rti.dds.subscription.DataReader will be associated with. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).
listener	<<in>> The listener of the com.rti.dds.subscription.DataReader.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: A com.rti.dds.subscription.DataReader of a derived class specific to the data-type associated with the com.rti.dds.topic.Topic or NULL if an error occurred.

See Also: com.rti.ndds.example.FooDataReader; Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.subscription.DataReaderQos for rules on consistency among QoS; com.rti.dds.domain.DomainParticipant.create_datareader; com.rti.dds.domain.DomainParticipant.get_default_datareader_qos; com.rti.dds.domain.DomainParticipant.get_implicit_subscriber; com.rti.dds.topic.Topic.set_qos; com.rti.dds.subscription.DataReader.set_listener

void delete_datareader ( DataReader a_datareader )

<<eXtension>> Deletes a com.rti.dds.subscription.DataReader that belongs to the implicit com.rti.dds.subscription.Subscriber.

Precondition: If the com.rti.dds.subscription.DataReader does not belong to the implicit com.rti.dds.subscription.Subscriber, or if ther are any existing com.rti.dds.subscription.ReadCondition or com.rti.dds.subscription.QueryCondition objects that are attached to the com.rti.dds.subscription.DataReader, or if there are outstanding loans on samples (as a result of a call to read(), take(), or one of the variants thereof), the operation fails with the error com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Postcondition: Listener installed on the com.rti.dds.subscription.DataReader will not be called after this method completes successfully.

Parameters

a_datareader <<in>> The com.rti.dds.subscription.DataReader to be deleted.

Exceptions

One	of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

See Also: com.rti.dds.domain.DomainParticipant.get_implicit_subscriber

Topic create_topic	(	String	topic_name,
		String	type_name,
		TopicQos	qos,
		TopicListener	listener,
		int	mask
	)

Creates a com.rti.dds.topic.Topic with the desired QoS policies and attaches to it the specified com.rti.dds.topic.TopicListener.

Precondition: The application is not allowed to create two com.rti.dds.topic.Topic objects with the same topic_name attached to the same com.rti.dds.domain.DomainParticipant. If the application attempts this, this method will fail and return a NULL topic.; The specified QoS policies must be consistent, or the operation will fail and no com.rti.dds.topic.Topic will be created.; Prior to creating a com.rti.dds.topic.Topic, the type must have been registered with RTI Connext. This is done using the com.rti.ndds.example.FooTypeSupport.register_type operation on a derived class of the com.rti.dds.topic.TypeSupport interface.

MT Safety:: UNSAFE. It is not safe to create a topic while another thread is trying to lookup that topic description with com.rti.dds.domain.DomainParticipant.lookup_topicdescription.

MT Safety:: UNSAFE. If com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT is used for qos, it is not safe to create the topic while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_topic_qos.

Parameters

topic_name	<<in>> Name for the new topic, must not exceed 255 characters. Cannot be NULL.
type_name	<<in>> The type to which the new com.rti.dds.topic.Topic will be bound. Cannot be NULL.
qos	<<in>> QoS to be used for creating the new com.rti.dds.topic.Topic. The special value com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT can be used to indicate that the com.rti.dds.topic.Topic should be created with the default com.rti.dds.topic.TopicQos set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL.
listener	<<in>>. Listener to be attached to the newly created com.rti.dds.topic.Topic.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: newly created topic, or NULL on failure

See Also: Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.topic.TopicQos for rules on consistency among QoS; com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_topic_with_profile; com.rti.dds.domain.DomainParticipant.get_default_topic_qos; com.rti.dds.topic.Topic.set_listener

Topic create_topic_with_profile	(	String	topic_name,
		String	type_name,
		String	library_name,
		String	profile_name,
		TopicListener	listener,
		int	mask
	)

<<eXtension>> Creates a new com.rti.dds.topic.Topic object using the com.rti.dds.publication.PublisherQos associated with the input XML QoS profile.

Precondition: The application is not allowed to create two com.rti.dds.topic.TopicDescription objects with the same topic_name attached to the same com.rti.dds.domain.DomainParticipant. If the application attempts this, this method will fail and return a NULL topic.; The com.rti.dds.topic.TopicQos in the input profile must be consistent, or the operation will fail and no com.rti.dds.topic.Topic will be created.; Prior to creating a com.rti.dds.topic.Topic, the type must have been registered with RTI Connext. This is done using the com.rti.ndds.example.FooTypeSupport.register_type operation on a derived class of the com.rti.dds.topic.TypeSupport interface.

MT Safety:: UNSAFE. It is not safe to create a topic while another thread is trying to lookup that topic description with com.rti.dds.domain.DomainParticipant.lookup_topicdescription.

Parameters

topic_name	<<in>> Name for the new topic, must not exceed 255 characters. Cannot be NULL.
type_name	<<in>> The type to which the new com.rti.dds.topic.Topic will be bound. Cannot be NULL.
library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).
listener	<<in>>. Listener to be attached to the newly created com.rti.dds.topic.Topic.
mask	<<in>>. Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Returns: newly created topic, or NULL on failure

See Also: Specifying QoS on entities for information on setting QoS before entity creation; com.rti.dds.topic.TopicQos for rules on consistency among QoS; com.rti.dds.domain.DomainParticipant.create_topic; com.rti.dds.domain.DomainParticipant.get_default_topic_qos; com.rti.dds.topic.Topic.set_listener

void delete_topic ( Topic topic )

Deletes a com.rti.dds.topic.Topic.

Precondition: If the com.rti.dds.topic.Topic does not belong to the application's com.rti.dds.domain.DomainParticipant, this operation fails with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.; Make sure no objects are using the topic. More specifically, there must be no existing com.rti.dds.subscription.DataReader, com.rti.dds.publication.DataWriter, com.rti.dds.topic.ContentFilteredTopic, or com.rti.dds.topic.MultiTopic objects belonging to the same com.rti.dds.domain.DomainParticipant that are using the com.rti.dds.topic.Topic. If delete_topic is called on a com.rti.dds.topic.Topic with any of these existing objects attached to it, it will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Postcondition: Listener installed on the com.rti.dds.topic.Topic will not be called after this method completes successfully.

Parameters

topic <<in>> com.rti.dds.topic.Topic to be deleted.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET

ContentFilteredTopic create_contentfilteredtopic	(	String	name,
		Topic	related_topic,
		String	filter_expression,
		StringSeq	expression_parameters
	)

Creates a com.rti.dds.topic.ContentFilteredTopic, that can be used to do content-based subscriptions.

The com.rti.dds.topic.ContentFilteredTopic only relates to samples published under that com.rti.dds.topic.Topic, filtered according to their content. The filtering is done by means of evaluating a logical expression that involves the values of some of the data-fields in the sample. The logical expression derived from the filter_expression and expression_parameters arguments.

Queries and Filters Syntax describes the syntax of filter_expression and expression_parameters.

Precondition: The application is not allowed to create two com.rti.dds.topic.ContentFilteredTopic objects with the same topic_name attached to the same com.rti.dds.domain.DomainParticipant. If the application attempts this, this method will fail and returns NULL.; If related_topic does not belong to this com.rti.dds.domain.DomainParticipant, this operation returns NULL.; This function will create a content filter using the builtin SQL filter which implements a superset of the DDS specification. This filter requires that all IDL types have been compiled with typecodes. If this precondition is not met, this operation returns NULL. Do not use rtiddsgen's -notypecode option if you want to use the builtin SQL filter.

Parameters

name	<<in>> Name for the new content filtered topic, must not exceed 255 characters. Cannot be NULL.
related_topic	<<in>> com.rti.dds.topic.Topic to be filtered. Cannot be NULL.
filter_expression	<<in>> Cannot be NULL
expression_parameters	<<in>> Cannot be NULL.An empty sequence must be used if the filter expression does not contain any parameters. Length of sequence cannot be greater than 100.

Returns: newly created com.rti.dds.topic.ContentFilteredTopic, or NULL on failure

ContentFilteredTopic create_contentfilteredtopic_with_filter	(	String	name,
		Topic	related_topic,
		String	filter_expression,
		StringSeq	expression_parameters,
		String	filter_name
	)

<<eXtension>> Creates a com.rti.dds.topic.ContentFilteredTopic using the specified filter to do content-based subscriptions.

Parameters

name	<<in>> Name for the new content filtered topic. Cannot exceed 255 characters. Cannot be NULL.
related_topic	<<in>> com.rti.dds.topic.Topic to be filtered. Cannot be NULL.
filter_expression	<<in>> Cannot be NULL.
expression_parameters	<<in>> Cannot be NULL.. An empty sequence must be used if the filter expression does not contain any parameters. Length of the sequence cannot be greater than 100.
filter_name	<<in>> Name of content filter to use. Must previously have been registered with com.rti.dds.domain.DomainParticipant.register_contentfilter on the same com.rti.dds.domain.DomainParticipant. Cannot be NULL.

Builtin filter names are com.rti.dds.domain.DomainParticipant.SQLFILTER_NAME and com.rti.dds.domain.DomainParticipant.STRINGMATCHFILTER_NAME

Returns: newly created com.rti.dds.topic.ContentFilteredTopic, or NULL on failure

void delete_contentfilteredtopic ( ContentFilteredTopic a_contentfilteredtopic )

Deletes a com.rti.dds.topic.ContentFilteredTopic.

Precondition: The deletion of a com.rti.dds.topic.ContentFilteredTopic is not allowed if there are any existing com.rti.dds.subscription.DataReader objects that are using the com.rti.dds.topic.ContentFilteredTopic. If the operation is called on a com.rti.dds.topic.ContentFilteredTopic with existing com.rti.dds.subscription.DataReader objects attached to it, it will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.; The com.rti.dds.topic.ContentFilteredTopic must be created by this com.rti.dds.domain.DomainParticipant, or else this operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Parameters

a_contentfilteredtopic <<in>>

Exceptions

One	of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET

MultiTopic create_multitopic	(	String	name,
		String	type_name,
		String	subscription_expression,
		StringSeq	expression_parameters
	)

[Not supported (optional)] Creates a MultiTopic that can be used to subscribe to multiple topics and combine/filter the received data into a resulting type.

The resulting type is specified by the type_name argument. The list of topics and the logic used to combine, filter, and rearrange the information from each com.rti.dds.topic.Topic are specified using the subscription_expression and expression_parameters arguments.

Queries and Filters Syntax describes the syntax of subscription_expression and expression_parameters.

Precondition: The application is not allowed to create two com.rti.dds.topic.TopicDescription objects with the same name attached to the same com.rti.dds.domain.DomainParticipant. If the application attempts this, this method will fail and return NULL.; Prior to creating a com.rti.dds.topic.MultiTopic, the type must have been registered with RTI Connext. This is done using the com.rti.ndds.example.FooTypeSupport.register_type operation on a derived class of the com.rti.dds.topic.TypeSupport interface. Otherwise, this method will return NULL.

Parameters

name	<<in>> Name of the newly create com.rti.dds.topic.MultiTopic. Cannot be NULL.
type_name	<<in>> Cannot be NULL.
subscription_expression	<<in>> Cannot be NULL.
expression_parameters	<<in>> Cannot be NULL.

Returns: NULL

void delete_multitopic ( MultiTopic a_multitopic )

[Not supported (optional)] Deletes a com.rti.dds.topic.MultiTopic.

Precondition: The deletion of a com.rti.dds.topic.MultiTopic is not allowed if there are any existing com.rti.dds.subscription.DataReader objects that are using the com.rti.dds.topic.MultiTopic. If the delete_multitopic operation is called on a com.rti.dds.topic.MultiTopic with existing com.rti.dds.subscription.DataReader objects attached to it, it will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.; The com.rti.dds.topic.MultiTopic must be created by this com.rti.dds.domain.DomainParticipant, or else this operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

Parameters

a_multitopic <<in>>

Exceptions

com.rti.dds.infrastructure.RETCODE_UNSUPPORTED

void set_qos ( DomainParticipantQos qos )

Change the QoS of this DomainParticipant.

The com.rti.dds.domain.DomainParticipantQos.user_data and com.rti.dds.domain.DomainParticipantQos.entity_factory can be changed. The other policies are immutable.

Parameters

qos <<in>> Set of policies to be applied to com.rti.dds.domain.DomainParticipant. Policies must be consistent. Immutable policies cannot be changed after com.rti.dds.domain.DomainParticipant is enabled. The special value com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT_QOS_DEFAULT can be used to indicate that the QoS of the com.rti.dds.domain.DomainParticipant should be changed to match the current default com.rti.dds.domain.DomainParticipantQos set in the com.rti.dds.domain.DomainParticipantFactory. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_IMMUTABLE_POLICY if immutable policy is changed, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY if policies are inconsistent

See Also: com.rti.dds.domain.DomainParticipantQos for rules on consistency among QoS; set_qos (abstract)

void set_qos_with_profile	(	String	library_name,
		String	profile_name
	)

<<eXtension>> Change the QoS of this domain participant using the input XML QoS profile.

The com.rti.dds.domain.DomainParticipantQos.user_data and com.rti.dds.domain.DomainParticipantQos.entity_factory can be changed. The other policies are immutable.

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipantFactory.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipantFactory.set_default_profile).

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_IMMUTABLE_POLICY if immutable policy is changed, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY if policies are inconsistent

See Also: com.rti.dds.domain.DomainParticipantQos for rules on consistency among QoS

void get_qos ( DomainParticipantQos qos )

Get the participant QoS.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

Parameters

qos	<<inout>> QoS to be filled up. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See Also: get_qos (abstract)

String get_default_library ( )

<<eXtension>> Gets the default XML library associated with a com.rti.dds.domain.DomainParticipant.

Returns: The default library or null if the default library was not set.

See Also: com.rti.dds.domain.DomainParticipant.set_default_library

void set_default_library ( String library_name )

<<eXtension>> Sets the default XML library for a com.rti.dds.domain.DomainParticipant.

This method specifies the library that will be used as the default the next time a default library is needed during a call to one of this DomainParticipant's operations.

Any API requiring a library_name as a parameter can use null to refer to the default library.

If the default library is not set, the com.rti.dds.domain.DomainParticipant inherits the default from the com.rti.dds.domain.DomainParticipantFactory (see com.rti.dds.domain.DomainParticipantFactory.set_default_library).

Parameters

library_name <<in>> Library name. If library_name is null any previous default is unset.

Exceptions

One	of the Standard Return Codes

See Also: com.rti.dds.domain.DomainParticipant.get_default_library

String get_default_profile ( )

<<eXtension>> Gets the default XML profile associated with a com.rti.dds.domain.DomainParticipant.

Returns: The default profile or null if the default profile was not set.

See Also: com.rti.dds.domain.DomainParticipant.set_default_profile

void set_default_profile	(	String	library_name,
		String	profile_name
	)

<<eXtension>> Sets the default XML profile for a com.rti.dds.domain.DomainParticipant.

This method specifies the profile that will be used as the default the next time a default DomainParticipant profile is needed during a call to one of this DomainParticipant's operations. When calling a com.rti.dds.domain.DomainParticipant method that requires a profile_name parameter, you can use NULL to refer to the default profile. (This same information applies to setting a default library.)

If the default profile is not set, the com.rti.dds.domain.DomainParticipant inherits the default from the com.rti.dds.domain.DomainParticipantFactory (see com.rti.dds.domain.DomainParticipantFactory.set_default_profile).

This method does not set the default QoS for entities created by the com.rti.dds.domain.DomainParticipant; for this functionality, use the methods set_default_<entity>_qos_with_profile (you may pass in NULL after having called set_default_profile()).

This method does not set the default QoS for newly created DomainParticipants; for this functionality, use com.rti.dds.domain.DomainParticipantFactory.set_default_participant_qos_with_profile.

Parameters

library_name	<<in>> The library name containing the profile.
profile_name	<<in>> The profile name. If profile_name is null any previous default is unset.

Exceptions

One	of the Standard Return Codes

See Also: com.rti.dds.domain.DomainParticipant.get_default_profile; com.rti.dds.domain.DomainParticipant.get_default_profile_library

String get_default_profile_library ( )

<<eXtension>> Gets the library where the default XML QoS profile is contained for a com.rti.dds.domain.DomainParticipant.

The default profile library is automatically set when com.rti.dds.domain.DomainParticipant.set_default_profile is called.

This library can be different than the com.rti.dds.domain.DomainParticipant default library (see com.rti.dds.domain.DomainParticipant.get_default_library).

Returns: The default profile library or null if the default profile was not set.

See Also: com.rti.dds.domain.DomainParticipant.set_default_profile

void set_listener	(	DomainParticipantListener	l,
		int	mask
	)

Sets the participant listener.

Parameters

l	<<in>> Listener to be installed on entity.
mask	<<in>> Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

MT Safety:: Unsafe. This method is not synchronized with the listener callbacks, so it is possible to set a new listener on a participant when the old listener is in a callback.

Exceptions

One	of the Standard Return Codes

See Also: set_listener (abstract)

DomainParticipantListener get_listener ( )

Get the participant listener.

Returns: Existing listener attached to the com.rti.dds.domain.DomainParticipant.

See Also: get_listener (abstract)

void get_publishers ( PublisherSeq publishers )

<<eXtension>> Allows the application to access all the publishers the participant has.

If the sequence doesn't own its buffer, and its maximum is less than the total number of publishers, it will be filled up to its maximum, and fail with com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES.

MT Safety:: Safe.

Parameters

publishers <<inout>> a PublisherSeq object where the set or list of publishers will be returned

Returns: One of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES

void get_subscribers ( SubscriberSeq subscribers )

<<eXtension>> Allows the application to access all the subscribers the participant has.

If the sequence doesn't own its buffer, and its maximum is less than the total number of subscribers, it will be filled up to its maximum, and fail with com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES.

MT Safety:: Safe.

Parameters

subscribers <<inout>> a SubscriberSeq object where the set or list of subscribers will be returned

Returns: One of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES

Subscriber get_builtin_subscriber ( )

Accesses the built-in com.rti.dds.subscription.Subscriber.

Each com.rti.dds.domain.DomainParticipant contains several built-in com.rti.dds.topic.Topic objects as well as corresponding com.rti.dds.subscription.DataReader objects to access them. All of these com.rti.dds.subscription.DataReader objects belong to a single built-in com.rti.dds.subscription.Subscriber.

The built-in Topics are used to communicate information about other com.rti.dds.domain.DomainParticipant, com.rti.dds.topic.Topic, com.rti.dds.subscription.DataReader, and com.rti.dds.publication.DataWriter objects.

The built-in subscriber is created when this operation is called for the first time. The built-in subscriber is deleted automatically when the com.rti.dds.domain.DomainParticipant is deleted.

Returns: The built-in com.rti.dds.subscription.Subscriber singleton.

See Also: builtin.SubscriptionBuiltinTopicData; builtin.PublicationBuiltinTopicData; builtin.ParticipantBuiltinTopicData; builtin.TopicBuiltinTopicData

FlowController lookup_flowcontroller ( String name )

<<eXtension>> Looks up an existing locally-created com.rti.dds.publication.FlowController, based on its name.

Looks up a previously created com.rti.dds.publication.FlowController, including the built-in ones. Once a com.rti.dds.publication.FlowController has been deleted, subsequent lookups will fail.

MT Safety:: UNSAFE. It is not safe to lookup a flow controller description while another thread is creating that flow controller.

Parameters

name	<<in>> Name of com.rti.dds.publication.FlowController to search for. Limited to 255 characters. Cannot be NULL.

Returns: The flow controller if it has already been created locally, or NULL otherwise.

Topic find_topic	(	String	topic_name,
		Duration_t	timeout
	)

Finds an existing (or ready to exist) com.rti.dds.topic.Topic, based on its name.

This call can be used to block for a specified duration to wait for the com.rti.dds.topic.Topic to be created.

If the requested com.rti.dds.topic.Topic already exists, it is returned. Otherwise, find_topic() waits until another thread creates it or else returns when the specified timeout occurs.

find_topic() is useful when multiple threads are concurrently creating and looking up topics. In that case, one thread can call find_topic() and, if another thread has not yet created the topic being looked up, it can wait for some period of time for it to do so. In almost all other cases, it is more straightforward to call com.rti.dds.domain.DomainParticipant.lookup_topicdescription.

The com.rti.dds.domain.DomainParticipant must already be enabled.

Note: Each com.rti.dds.topic.Topic obtained by com.rti.dds.domain.DomainParticipant.find_topic must also be deleted by means of com.rti.dds.domain.DomainParticipant.delete_topic. If com.rti.dds.topic.Topic is obtained multiple times by means of com.rti.dds.domain.DomainParticipant.find_topic or com.rti.dds.domain.DomainParticipant.create_topic, it must also be deleted that same number of times using com.rti.dds.domain.DomainParticipant.delete_topic.

Parameters

topic_name	<<in>> Name of the com.rti.dds.topic.Topic to search for. Cannot be NULL.
timeout	<<in>> The time to wait if the com.rti.dds.topic.Topic does not exist already. Cannot be NULL.

Returns: the topic, if it exists, or NULL

TopicDescription lookup_topicdescription ( String topic_name )

Looks up an existing, locally created com.rti.dds.topic.TopicDescription, based on its name.

com.rti.dds.topic.TopicDescription is the base class for com.rti.dds.topic.Topic, com.rti.dds.topic.MultiTopic and com.rti.dds.topic.ContentFilteredTopic. So you can narrow the com.rti.dds.topic.TopicDescription returned from this operation to a com.rti.dds.topic.Topic or com.rti.dds.topic.ContentFilteredTopic as appropriate.

Unlike com.rti.dds.domain.DomainParticipant.find_topic, which logically returns a new com.rti.dds.topic.Topic object that must be independently deleted, this operation returns a reference to the original local object.

The com.rti.dds.domain.DomainParticipant does not have to be enabled when you call lookup_topicdescription().

The returned topic may be either enabled or disabled.

MT Safety:: UNSAFE. It is not safe to lookup a topic description while another thread is creating that topic.

Parameters

topic_name <<in>> Name of com.rti.dds.topic.TopicDescription to search for. This string must be no more than 255 characters; it cannot be NULL.

Returns: The topic description, if it has already been created locally, otherwise it returns NULL.

void ignore_participant ( InstanceHandle_t handle )

Instructs RTI Connext to locally ignore a remote com.rti.dds.domain.DomainParticipant.

From the time of this call onwards, RTI Connext will locally behave as if the remote participant did not exist. This means it will ignore any topic, publication, or subscription that originates on that com.rti.dds.domain.DomainParticipant.

There is no way to reverse this operation.

This operation can be used in conjunction with the discovery of remote participants offered by means of the builtin.ParticipantBuiltinTopicData to provide access control.

Application data can be associated with a com.rti.dds.domain.DomainParticipant by means of the USER_DATA policy. This application data is propagated as a field in the built-in topic and can be used by an application to implement its own access control policy.

The com.rti.dds.domain.DomainParticipant to ignore is identified by the handle argument. This handle is the one that appears in the com.rti.dds.subscription.SampleInfo retrieved when reading the data-samples available for the built-in com.rti.dds.subscription.DataReader to the com.rti.dds.domain.DomainParticipant topic. The built-in com.rti.dds.subscription.DataReader is read with the same com.rti.ndds.example.FooDataReader.read and com.rti.ndds.example.FooDataReader.take operations used for any com.rti.dds.subscription.DataReader.

Parameters

handle <<in>> com.rti.dds.infrastructure.InstanceHandle_t of the com.rti.dds.domain.DomainParticipant to be ignored. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES, com.rti.dds.infrastructure.RETCODE_NOT_ENABLED

See Also: builtin.ParticipantBuiltinTopicData; builtin.ParticipantBuiltinTopicDataTypeSupport.PARTICIPANT_TOPIC_NAME; com.rti.dds.domain.DomainParticipant.get_builtin_subscriber

void ignore_topic ( InstanceHandle_t handle )

Instructs RTI Connext to locally ignore a com.rti.dds.topic.Topic.

This means it will locally ignore any publication, or subscription to the com.rti.dds.topic.Topic.

There is no way to reverse this operation.

This operation can be used to save local resources when the application knows that it will never publish or subscribe to data under certain topics.

The com.rti.dds.topic.Topic to ignore is identified by the handle argument. This is the handle of a com.rti.dds.topic.Topic that appears in the com.rti.dds.subscription.SampleInfo retrieved when reading data samples from the built-in com.rti.dds.subscription.DataReader for the com.rti.dds.topic.Topic.

Parameters

handle <<in>> Handle of the com.rti.dds.topic.Topic to be ignored. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED

See Also: builtin.TopicBuiltinTopicData; builtin.TopicBuiltinTopicDataTypeSupport.TOPIC_TOPIC_NAME; com.rti.dds.domain.DomainParticipant.get_builtin_subscriber

void ignore_publication ( InstanceHandle_t handle )

Instructs RTI Connext to locally ignore a publication.

A publication is defined by the association of a topic name, user data, and partition set on the com.rti.dds.publication.Publisher (see builtin.PublicationBuiltinTopicData). After this call, any data written by that publication's com.rti.dds.publication.DataWriter will be ignored.

This operation can be used to ignore local and remote DataWriters.

The publication (DataWriter) to ignore is identified by the handle argument.

To ignore a remote DataWriter, the handle can be obtained from the com.rti.dds.subscription.SampleInfo retrieved when reading data samples from the built-in com.rti.dds.subscription.DataReader for the com.rti.dds.publication topic.

To ignore a local DataWriter, the handle can be obtained by calling com.rti.dds.infrastructure.Entity.get_instance_handle for the local DataWriter.

There is no way to reverse this operation.

Parameters

handle <<in>> Handle of the com.rti.dds.publication.DataWriter to be ignored. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED

See Also: builtin.PublicationBuiltinTopicData; builtin.PublicationBuiltinTopicDataTypeSupport.PUBLICATION_TOPIC_NAME; com.rti.dds.domain.DomainParticipant.get_builtin_subscriber

void ignore_subscription ( InstanceHandle_t handle )

Instructs RTI Connext to locally ignore a subscription.

A subscription is defined by the association of a topic name, user data, and partition set on the com.rti.dds.subscription.Subscriber (see builtin.SubscriptionBuiltinTopicData). After this call, any data received related to that subscription's com.rti.dds.subscription.DataReader will be ignored.

This operation can be used to ignore local and remote DataReaders.

The subscription to ignore is identified by the handle argument.

To ignore a remote DataReader, the handle can be obtained from the com.rti.dds.subscription.SampleInfo retrieved when reading data samples from the built-in com.rti.dds.subscription.DataReader for the com.rti.dds.subscription topic.

To ignore a local DataReader, the handle can be obtained by calling com.rti.dds.infrastructure.Entity.get_instance_handle for the local DataReader.

There is no way to reverse this operation.

Parameters

handle <<in>> Handle of the com.rti.dds.subscription.DataReader to be ignored. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED

See Also: builtin.SubscriptionBuiltinTopicData; builtin.SubscriptionBuiltinTopicDataTypeSupport.SUBSCRIPTION_TOPIC_NAME; com.rti.dds.domain.DomainParticipant.get_builtin_subscriber

int get_domain_id ( )

Get the unique domain identifier.

This operation retrieves the domain_id used to create the com.rti.dds.domain.DomainParticipant. The domain_id identifies the DDS domain to which the com.rti.dds.domain.DomainParticipant belongs. Each DDS domain represents a separate data 'communication plane' isolated from other domains.

Returns: the unique domainId that was used to create the domain

See Also: com.rti.dds.domain.DomainParticipantFactory.create_participant; com.rti.dds.domain.DomainParticipantFactory.create_participant_with_profile

void assert_liveliness ( )

Manually asserts the liveliness of this com.rti.dds.domain.DomainParticipant.

This is used in combination with the com.rti.dds.infrastructure.LivelinessQosPolicy to indicate to RTI Connext that the entity remains active.

You need to use this operation if the com.rti.dds.domain.DomainParticipant conatins com.rti.dds.publication.DataWriter entities with the com.rti.dds.infrastructure.LivelinessQosPolicy.kind set to com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANUAL_BY_PARTICIPANT_LIVELINESS_QOS and it only affects the liveliness of those com.rti.dds.publication.DataWriter entities. Otherwise, it has no effect.

Note: writing data via the com.rti.ndds.example.FooDataWriter.write or com.rti.ndds.example.FooDataWriter.write_w_timestamp operation asserts liveliness on the com.rti.dds.publication.DataWriter itself and its com.rti.dds.domain.DomainParticipant. Consequently the use of assert_liveliness() is only needed if the application is not writing data regularly.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED

See Also: com.rti.dds.infrastructure.LivelinessQosPolicy

void delete_contained_entities ( )

Delete all the entities that were created by means of the "create" operations on the com.rti.dds.domain.DomainParticipant.

This operation deletes all contained com.rti.dds.publication.Publisher (including an implicit Publisher, if one exists), com.rti.dds.subscription.Subscriber (including implicit subscriber), com.rti.dds.topic.Topic, com.rti.dds.topic.ContentFilteredTopic, and com.rti.dds.topic.MultiTopic objects.

Prior to deleting each contained entity, this operation will recursively call the corresponding delete_contained_entities operation on each contained entity (if applicable). This pattern is applied recursively. In this manner the operation delete_contained_entities() on the com.rti.dds.domain.DomainParticipant will end up deleting all the entities recursively contained in the com.rti.dds.domain.DomainParticipant, that is also the com.rti.dds.publication.DataWriter, com.rti.dds.subscription.DataReader, as well as the com.rti.dds.subscription.QueryCondition and com.rti.dds.subscription.ReadCondition objects belonging to the contained com.rti.dds.subscription.DataReader.

The operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET if any of the contained entities is in a state where it cannot be deleted.

If delete_contained_entities() completes successfully, the application may delete the com.rti.dds.domain.DomainParticipant knowing that it has no contained entities.

Exceptions

One	of the Standard Return Codes, or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

void add_peer ( String peer_desc_string )

<<eXtension>> Attempt to contact one or more additional peer participants.

Add the given peer description to the list of peers with which this com.rti.dds.domain.DomainParticipant will try to communicate.

This method may be called at any time after this com.rti.dds.domain.DomainParticipant has been created (before or after it has been enabled).

If this method is called after com.rti.dds.infrastructure.Entity.enable, an attempt will be made to contact the new peer(s) immediately.

If this method is called before the DomainParticipant is enabled, the peer description will simply be added to the list that was populated by com.rti.dds.infrastructure.DiscoveryQosPolicy.initial_peers; the first attempted contact will take place after this com.rti.dds.domain.DomainParticipant is enabled.

Adding a peer description with this method does not guarantee that any peer(s) discovered as a result will exactly correspond to those described:

This com.rti.dds.domain.DomainParticipant will attempt to discover peer participants at the given locations but may not succeed if no such participants are available. In this case, this method will not wait for contact attempt(s) to be made and it will not report an error.

If remote participants described by the given peer description are discovered, the distributed application is configured with asymmetric peer lists, and com.rti.dds.infrastructure.DiscoveryQosPolicy.accept_unknown_peers is set to com.rti.dds.infrastructure.true. Thus, this com.rti.dds.domain.DomainParticipant may actually discover more peers than are described in the given peer description.

To be informed of the exact remote participants that are discovered, regardless of which peers this com.rti.dds.domain.DomainParticipant attempts to discover, use the built-in participant topic: builtin.ParticipantBuiltinTopicDataTypeSupport.PARTICIPANT_TOPIC_NAME.

To remove specific peer locators, you may use com.rti.dds.domain.DomainParticipant.remove_peer. If a peer is removed, the add_peer operation will add it back to the list of peers.

To stop communicating with a peer com.rti.dds.domain.DomainParticipant that has been discovered, use com.rti.dds.domain.DomainParticipant.ignore_participant.

Adding a peer description with this method has no effect on the com.rti.dds.infrastructure.DiscoveryQosPolicy.initial_peers that may be subsequently retrieved with com.rti.dds.domain.DomainParticipant.get_qos() (because com.rti.dds.infrastructure.DiscoveryQosPolicy is immutable).

Parameters

peer_desc_string <<in>> New peer descriptor to be added. The format is specified in Peer Descriptor Format. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See Also: Peer Descriptor Format; com.rti.dds.infrastructure.DiscoveryQosPolicy.initial_peers; builtin.ParticipantBuiltinTopicDataTypeSupport.PARTICIPANT_TOPIC_NAME; com.rti.dds.domain.DomainParticipant.get_builtin_subscriber

void remove_peer ( String peer_desc_string )

<<eXtension>> Remove one or more peer participants from the list of peers with which this com.rti.dds.domain.DomainParticipant will try to communicate.

This method may be called any time after this com.rti.dds.domain.DomainParticipant has been enabled

Calling this method has the following effects:

If a com.rti.dds.domain.DomainParticipant was already discovered, it will be locally removed along with all its entities.
Any further requests coming from a com.rti.dds.domain.DomainParticipant located on any of the removed peers will be ignored.
All the locators contained in the peer description will be removed from the peer list. The local com.rti.dds.domain.DomainParticipant will stop sending announcement to those locators.

If remote participants located on a peer that was previously removed are discovered, they will be ignored untill the related peer is added back by using com.rti.dds.domain.DomainParticipant.add_peer.

Removing a peer description with this method has no effect on the com.rti.dds.infrastructure.DiscoveryQosPolicy.initial_peers that may be subsequently retrieved with com.rti.dds.domain.DomainParticipant.get_qos() (because com.rti.dds.infrastructure.DiscoveryQosPolicy is immutable).

Parameters

peer_desc_string <<in>> Peer descriptor to be removed. The format is specified in Peer Descriptor Format. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See Also: Peer Descriptor Format; com.rti.dds.infrastructure.DiscoveryQosPolicy.initial_peers; com.rti.dds.domain.DomainParticipant.add_peer

void get_current_time ( Time_t current_time )

Returns the current value of the time.

The current value of the time that RTI Connext uses to time-stamp com.rti.dds.publication.DataWriter and to set the reception-timestamp for the data updates that it receives.

Parameters

current_time <<inout>> Current time to be filled up. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

void get_discovered_participants ( InstanceHandleSeq participant_handles )

Returns list of discovered com.rti.dds.domain.DomainParticipant s.

This operation retrieves the list of com.rti.dds.domain.DomainParticipant s that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_participant operation.

Parameters

participant_handles <<inout>> com.rti.dds.infrastructure.InstanceHandleSeq to be filled with handles of the discovered com.rti.dds.domain.DomainParticipant s

Exceptions

One	of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED

void get_discovered_participant_data	(	ParticipantBuiltinTopicData	participant_data,
		InstanceHandle_t	participant_handle
	)

Returns builtin.ParticipantBuiltinTopicData for the specified com.rti.dds.domain.DomainParticipant .

This operation retrieves information on a com.rti.dds.domain.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 com.rti.dds.domain.DomainParticipant.ignore_participant operation.

The participant_handle must correspond to such a DomainParticipant. Otherwise, the operation will fail with PRECONDITION_NOT_MET.

Use the operation com.rti.dds.domain.DomainParticipant.get_discovered_participants to find the com.rti.dds.domain.DomainParticipant s that are currently discovered.

Note: This operation does not retrieve the builtin.ParticipantBuiltinTopicData.property. This information is available through com.rti.dds.subscription.DataReaderListener::on_data_available() (if a reader listener is installed on the builtin.ParticipantBuiltinTopicDataDataReader).

Parameters

participant_data	<<inout>> builtin.ParticipantBuiltinTopicData to be filled with the specified com.rti.dds.domain.DomainParticipant 's data.
participant_handle	<<in>> com.rti.dds.infrastructure.InstanceHandle_t of com.rti.dds.domain.DomainParticipant.

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED

See Also: builtin.ParticipantBuiltinTopicData; com.rti.dds.domain.DomainParticipant.get_discovered_participants

void get_discovered_topics ( InstanceHandleSeq topic_handles )

Returns list of discovered com.rti.dds.topic.Topic objects.

This operation retrieves the list of com.rti.dds.topic.Topic s that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_topic operation.

Parameters

topic_handles <<inout>> com.rti.dds.infrastructure.InstanceHandleSeq to be filled with handles of the discovered com.rti.dds.topic.Topic objects

Exceptions

One	of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED

void get_discovered_topic_data	(	TopicBuiltinTopicData	topic_data,
		InstanceHandle_t	topic_handle
	)

Returns builtin.TopicBuiltinTopicData for the specified com.rti.dds.topic.Topic.

This operation retrieves information on a com.rti.dds.topic.Topic that has been discovered by the local Participant and must not have been "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_topic operation.

The topic_handle must correspond to such a topic. Otherwise, the operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

This call is not supported for remote topics. If a remote topic_handle is used, the operation will fail with com.rti.dds.infrastructure.RETCODE_UNSUPPORTED.

Use the operation com.rti.dds.domain.DomainParticipant.get_discovered_topics to find the topics that are currently discovered.

Parameters

topic_data	<<inout>> builtin.TopicBuiltinTopicData to be filled with the specified com.rti.dds.topic.Topic's data.
topic_handle	<<in>> com.rti.dds.infrastructure.InstanceHandle_t of com.rti.dds.topic.Topic.

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET or com.rti.dds.infrastructure.RETCODE_NOT_ENABLED

See Also: builtin.TopicBuiltinTopicData; com.rti.dds.domain.DomainParticipant.get_discovered_topics

boolean contains_entity ( InstanceHandle_t a_handle )

Completes successfully with com.rti.dds.infrastructure.true if the referenced com.rti.dds.infrastructure.Entity is contained by the com.rti.dds.domain.DomainParticipant.

This operation checks whether or not the given a_handle represents an com.rti.dds.infrastructure.Entity that was created from the com.rti.dds.domain.DomainParticipant. The containment applies recursively. That is, it applies both to entities (com.rti.dds.topic.TopicDescription, com.rti.dds.publication.Publisher, or com.rti.dds.subscription.Subscriber) created directly using the com.rti.dds.domain.DomainParticipant as well as entities created using a contained com.rti.dds.publication.Publisher, or com.rti.dds.subscription.Subscriber as the factory, and so forth.

The instance handle for an com.rti.dds.infrastructure.Entity may be obtained from built-in topic data, from various statuses, or from the operation com.rti.dds.infrastructure.Entity.get_instance_handle.

Parameters

a_handle <<in>> com.rti.dds.infrastructure.InstanceHandle_t of the com.rti.dds.infrastructure.Entity to be checked.

Returns: com.rti.dds.infrastructure.true if com.rti.dds.infrastructure.Entity is contained by the com.rti.dds.domain.DomainParticipant, or com.rti.dds.infrastructure.false otherwise.

void register_durable_subscription	(	EndpointGroup_t	group,
		String	topic_name
	)

Registers a Durable Subscription on the specified com.rti.dds.topic.Topic on all Persistence Services.

If you need to receive all samples published on a com.rti.dds.topic.Topic, including the ones published while a com.rti.dds.subscription.DataReader is inactive or before it may be created, create a Durable Subscription using this method.

In this way, the Persistence Service will ensure that all the samples on that com.rti.dds.topic.Topic are retained until they are acknowledged by at least N DataReaders belonging to the Durable Subscription where N is the quorum count.

If the same Durable Subscription is created on a different com.rti.dds.topic.Topic, the Persistence Service will implicitly delete the previous Durable Subscription and create a new one on the new com.rti.dds.topic.Topic.

Parameters

group	<<in>> com.rti.dds.infrastructure.EndpointGroup_t The Durable Subscription name and quorum.
topic_name	<<in>> The topic name for which the Durable Subscription is created.

Exceptions

One	of the Standard Return Codes

void delete_durable_subscription ( EndpointGroup_t group )

Deletes an existing Durable Subscription on all Persistence Services.

The Persistence Service will delete the Durable Subscription and the quorum of the existing samples will be considered satisfied.

Parameters

group <<in>> com.rti.dds.infrastructure.EndpointGroup_t specifying the Durable Subscription name. Quorum is not required for this operation.

Exceptions

One	of the Standard Return Codes

void register_contentfilter	(	String	filter_name,
		ContentFilter	contentfilter
	)

<<eXtension>> Register a content filter which can be used to create a com.rti.dds.topic.ContentFilteredTopic.

DDS specifies a SQL-like content filter for use by content filtered topics. If this filter does not meet your filtering requirements, you can register a custom filter.

To use a custom filter, it must be registered in the following places:

In any application that uses the custom filter to create a com.rti.dds.topic.ContentFilteredTopic and the corresponding com.rti.dds.subscription.DataReader.
In each application that writes the data to the applications mentioned above.

For example, suppose Application A on the subscription side creates a Topic named X and a ContentFilteredTopic named filteredX (and a corresponding DataReader), using a previously registered content filter, myFilter. With only that, you will have filtering at the subscription side. If you also want to perform filtering in any application that publishes Topic X, then you also need to register the same definition of the ContentFilter myFilter in that application.

Each filter_name can only be used to registered a content filter once with a com.rti.dds.domain.DomainParticipant.

Parameters

filter_name	<<in>> Name of the filter. The name must be unique within the com.rti.dds.domain.DomainParticipant and must not exceed 255 characters. Cannot be NULL.
contentfilter	<<in>> Content filter to be registered. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See Also: com.rti.dds.domain.DomainParticipant.unregister_contentfilter

ContentFilter lookup_contentfilter ( String filter_name )

<<eXtension>> Lookup a content filter previously registered with com.rti.dds.domain.DomainParticipant.register_contentfilter.

Parameters

filter_name <<in>> Name of the filter. Cannot be NULL.

Returns: NULL if the given filter_name has not been previously registered to the com.rti.dds.domain.DomainParticipant with com.rti.dds.domain.DomainParticipant.register_contentfilter. Otherwise, return the com.rti.dds.topic.ContentFilter that has been previosuly registered with the given filter_name.

See Also: com.rti.dds.domain.DomainParticipant.register_contentfilter

void unregister_contentfilter ( String filter_name )

<<eXtension>> Unregister a content filter previously registered with com.rti.dds.domain.DomainParticipant.register_contentfilter.

A filter_name can be unregistered only if it has been previously registered to the com.rti.dds.domain.DomainParticipant with com.rti.dds.domain.DomainParticipant.register_contentfilter.

The unregistration of filter is not allowed if there are any existing com.rti.dds.topic.ContentFilteredTopic objects that are using the filter. If the operation is called on a filter with existing com.rti.dds.topic.ContentFilteredTopic objects attached to it, this operation will fail with com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET.

If there are still existing discovered com.rti.dds.subscription.DataReader s with the same filter_name and the filter's compile method of the filter have previously been called on the discovered com.rti.dds.subscription.DataReader s, finalize method of the filter will be called on those discovered com.rti.dds.subscription.DataReader s before the content filter is unregistered. This means filtering will now be performed on the application that is creating the com.rti.dds.subscription.DataReader.

Parameters

filter_name <<in>> Name of the filter. Cannot be NULL.

Exceptions

One	of the Standard Return Codes or com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET

See Also: com.rti.dds.domain.DomainParticipant.register_contentfilter

Publisher get_implicit_publisher ( )

<<eXtension>> Returns the implicit com.rti.dds.publication.Publisher. If an implicit Publisher does not already exist, this creates one.

There can only be one implicit Publisher per DomainParticipant.

The implicit Publisher is created with com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT and no Listener.

This implicit Publisher will be deleted automatically when the following methods are called: com.rti.dds.domain.DomainParticipant.delete_contained_entities, or com.rti.dds.domain.DomainParticipant.delete_publisher with the implicit publisher as a parameter. Additionally, when a DomainParticipant is deleted, if there are no attached DataWriters that belong to the implicit Publisher, the implicit Publisher will be implicitly deleted.

MT Safety:: UNSAFE. It is not safe to create an implicit Publisher while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_publisher_qos.

Returns: The implicit publisher

See Also: com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_publisher

Subscriber get_implicit_subscriber ( )

<<eXtension>> Returns the implicit com.rti.dds.subscription.Subscriber. If an implicit Subscriber does not already exist, this creates one.

There can only be one implicit Subscriber per DomainParticipant.

The implicit Subscriber is created with com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_DEFAULT and no Listener.

This implicit Subscriber will be deleted automatically when the following methods are called: com.rti.dds.domain.DomainParticipant.delete_contained_entities, or com.rti.dds.domain.DomainParticipant.delete_subscriber with the subscriber as a parameter. Additionally, when a DomainParticipant is deleted, if there are no attached DataReaders that belong to the implicit Subscriber, the implicit Subscriber will be implicitly deleted.

MT Safety:: UNSAFE. it is not safe to create the implicit subscriber while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos.

Returns: The implicit subscriber

See Also: com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_DEFAULT; com.rti.dds.domain.DomainParticipant.create_subscriber

abstract Publisher lookup_publisher_by_name_exp ( String publisher_name )

pure virtual

<<experimental>> <<eXtension>> Looks up a com.rti.dds.publication.Publisher by its entity name within this com.rti.dds.domain.DomainParticipant.

Every com.rti.dds.publication.Publisher in the system has an entity name which is configured and stored in the GROUP_DATA policy. The use of the GROUP_DATA to store the entity name is a temporary situation while the feature is in experimental state.

This operation retrieves a com.rti.dds.publication.Publisher within the com.rti.dds.domain.DomainParticipant given the entity's name. If there are several com.rti.dds.publication.Publisher with the same name within the com.rti.dds.domain.DomainParticipant, this function returns the first matching occurrence.

Parameters

publisher_name <<in>> Entity name of the com.rti.dds.publication.Publisher.

Returns: The first com.rti.dds.publication.Publisher found with the specified name or NULL if it is not found.

See Also: com.rti.dds.domain.DomainParticipant.lookup_datawriter_by_name_exp

abstract Subscriber lookup_subscriber_by_name_exp ( String subscriber_name )

pure virtual

<<experimental>> <<eXtension>> Retrieves a com.rti.dds.subscription.Subscriber by its entity name within this com.rti.dds.domain.DomainParticipant.

Every com.rti.dds.subscription.Subscriber in the system has an entity name which is configured and stored in the GROUP_DATA policy. The use of the GROUP_DATA to store the entity name is a temporary situation while the function is in experimental state.

This operation retrieves a com.rti.dds.subscription.Subscriber within the com.rti.dds.domain.DomainParticipant given the entity's name. If there are several com.rti.dds.subscription.Subscriber with the same name within the com.rti.dds.domain.DomainParticipant, this function returns the first matching occurrence.

Parameters

subscriber_name <<in>> Entity name of the com.rti.dds.subscription.Subscriber.

Returns: The first com.rti.dds.subscription.Subscriber found with the specified name or NULL if it is not found.

See Also: com.rti.dds.domain.DomainParticipant.lookup_datareader_by_name_exp

abstract DataWriter lookup_datawriter_by_name_exp ( String datawriter_full_name )

pure virtual

<<experimental>> <<eXtension>> Looks up a com.rti.dds.publication.DataWriter by its entity name within this com.rti.dds.domain.DomainParticipant.

Every com.rti.dds.publication.DataWriter in the system has an entity name which is configured and stored in the EntityName policy, ENTITY_NAME.

Every com.rti.dds.publication.Publisher in the system has an entity name which is configured and stored in the <<eXtension>> GROUP_DATA policy. This is a temporary situation situation while the function is in experimental state.

This operation retrieves a com.rti.dds.publication.DataWriter within a com.rti.dds.publication.Publisher given the specified name which encodes both to the com.rti.dds.publication.DataWriter and the com.rti.dds.publication.Publisher name.

The specified name might be given as a fully-qualified entity name or as a plain name.

The fully qualified entity name is a concatenation of the com.rti.dds.publication.Publisher to which the com.rti.dds.publication.DataWriter belongs and the entity name of of the com.rti.dds.publication.DataWriter itself, separated by a double colon "::". For example: MyPublisherName::MyDataWriterName

The plain name contains the com.rti.dds.publication.DataWriter name only. In this situation it is implied that the com.rti.dds.publication.DataWriter belongs to the implicit com.rti.dds.publication.Publisher so the use of a plain name is equivalent to specifying a fully qualified name with the com.rti.dds.publication.Publisher name part being "implicit". For example: the plain name "MyDataWriterName" is equivalent to specifiying the fully qualified name "implicit::MyDataWriterName"

The com.rti.dds.publication.DataWriter is only looked up within the com.rti.dds.publication.Publisher specified in the fully qualified name, or within the implicit com.rti.dds.publication.Publisher if the name was not fully qualified.

If there are several com.rti.dds.publication.DataWriter with the same name within the corresponding com.rti.dds.publication.Publisher this function returns the first matching occurrence.

Parameters

datawriter_full_name <<in>> Entity name or fully-qualified entity name of the com.rti.dds.publication.DataWriter.

Returns: The first com.rti.dds.publication.DataWriter found with the specified name or NULL if it is not found.

See Also: com.rti.dds.publication.Publisher.lookup_datawriter_by_name_exp; com.rti.dds.domain.DomainParticipant.lookup_publisher_by_name_exp

abstract DataReader lookup_datareader_by_name_exp ( String datareder_full_name )

pure virtual

<<experimental>> <<eXtension>> Retrieves up a com.rti.dds.subscription.DataReader by its entity name in this com.rti.dds.domain.DomainParticipant.

Every com.rti.dds.subscription.DataReader in the system has an entity name which is configured and stored in the EntityName policy, ENTITY_NAME.

Every com.rti.dds.subscription.Subscriber in the system has an entity name which is configured and stored in the <<eXtension>> GROUP_DATA policy. This is a temporary situation situation while the function is in experimental state.

This operation retrieves a com.rti.dds.subscription.DataReader within a com.rti.dds.subscription.Subscriber given the specified name which encodes both to the com.rti.dds.subscription.DataReader and the com.rti.dds.subscription.Subscriber name.

The specified name might be given as a fully-qualified entity name or as a plain name.

The fully qualified entity name is a concatenation of the com.rti.dds.subscription.Subscriber to which the com.rti.dds.subscription.DataReader belongs and the entity name of of the com.rti.dds.subscription.DataReader itself, separated by a double colon "::". For example: MySubscriberName::MyDataReaderName

The plain name contains the com.rti.dds.subscription.DataReader name only. In this situation it is implied that the com.rti.dds.subscription.DataReader belongs to the implicit com.rti.dds.subscription.Subscriber so the use of a plain name is equivalent to specifying a fully qualified name with the com.rti.dds.subscription.Subscriber name part being "implicit". For example: the plain name "MyDataReaderName" is equivalent to specifiying the fully qualified name "implicit::MyDataReaderName"

The com.rti.dds.subscription.DataReader is only looked up within the com.rti.dds.subscription.Subscriber specified in the fully qualified name, or within the implicit com.rti.dds.subscription.Subscriber if the name was not fully qualified.

If there are several com.rti.dds.subscription.DataReader with the same name within the corresponding com.rti.dds.subscription.Subscriber this function returns the first matching occurrence.

Parameters

datareader_full_name <<in>> Full entity name of the com.rti.dds.subscription.DataReader.

Returns: The first com.rti.dds.subscription.DataReader found with the specified name or NULL if it is not found.

See Also: com.rti.dds.subscription.Subscriber.lookup_datareader_by_name_exp; com.rti.dds.domain.DomainParticipant.lookup_subscriber_by_name_exp

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

Special Instructions if Using 'Timestamp' APIs and BY_SOURCE_TIMESTAMP Destination Ordering: