RTI Connext Java API
Version 5.3.1
|
<<interface>> The most basic description of the data to be published and subscribed. More...
Public Member Functions | |
void | get_inconsistent_topic_status (InconsistentTopicStatus status) |
Allows the application to retrieve the com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT_TOPIC_STATUS status of a com.rti.dds.topic.Topic. | |
void | set_qos (TopicQos qos) |
Set the topic QoS. | |
void | set_qos_with_profile (String library_name, String profile_name) |
<<extension>> Change the QoS of this topic using the input XML QoS profile. | |
void | get_qos (TopicQos qos) |
Get the topic QoS. | |
void | set_listener (TopicListener l, int mask) |
Set the topic listener. | |
TopicListener | get_listener () |
Get the topic listener. | |
Public Member Functions inherited from TopicDescription | |
String | get_type_name () |
Get the associated type_name . | |
String | get_name () |
Get the name used to create this com.rti.dds.topic.TopicDescription . | |
DomainParticipant | get_participant () |
Get the com.rti.dds.domain.DomainParticipant to which the com.rti.dds.topic.TopicDescription belongs. | |
<<interface>> The most basic description of the data to be published and subscribed.
A com.rti.dds.topic.Topic is identified by its name, which must be unique in the whole domain. In addition (by virtue of extending com.rti.dds.topic.TopicDescription) it fully specifies the type of the data that can be communicated when publishing or subscribing to the com.rti.dds.topic.Topic.
com.rti.dds.topic.Topic is the only com.rti.dds.topic.TopicDescription that can be used for publications and therefore associated with a com.rti.dds.publication.DataWriter.
The following operations may be called even if the com.rti.dds.topic.Topic is not enabled. Other operations will fail with the value com.rti.dds.infrastructure.RETCODE_NOT_ENABLED if called on a disabled com.rti.dds.topic.Topic:
void get_inconsistent_topic_status | ( | InconsistentTopicStatus | status | ) |
Allows the application to retrieve the com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT_TOPIC_STATUS status of a com.rti.dds.topic.Topic.
Retrieve the current com.rti.dds.topic.InconsistentTopicStatus
status | <<inout>> Status to be retrieved. Cannot be NULL. |
One | of the Standard Return Codes |
void set_qos | ( | TopicQos | qos | ) |
Set the topic QoS.
The com.rti.dds.topic.TopicQos.topic_data and com.rti.dds.topic.TopicQos.deadline, com.rti.dds.topic.TopicQos.latency_budget, com.rti.dds.topic.TopicQos.transport_priority and com.rti.dds.topic.TopicQos.lifespan can be changed. The other policies are immutable.
qos | <<in>> Set of policies to be applied to com.rti.dds.topic.Topic. |
Policies must be consistent. Immutable policies cannot be changed after com.rti.dds.topic.Topic is enabled. The special value com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT can be used to indicate that the QoS of the com.rti.dds.topic.Topic should be changed to match the current default com.rti.dds.topic.TopicQos set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL.
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 |
void set_qos_with_profile | ( | String | library_name, |
String | profile_name | ||
) |
<<extension>> Change the QoS of this topic using the input XML QoS profile.
The com.rti.dds.topic.TopicQos.topic_data and com.rti.dds.topic.TopicQos.deadline, com.rti.dds.topic.TopicQos.latency_budget, com.rti.dds.topic.TopicQos.transport_priority and com.rti.dds.topic.TopicQos.lifespan can be changed. The other policies are immutable.
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). |
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 |
void get_qos | ( | TopicQos | qos | ) |
Get the topic QoS.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<inout>> QoS to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void set_listener | ( | TopicListener | l, |
int | mask | ||
) |
Set the topic listener.
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. |
One | of the Standard Return Codes |
TopicListener get_listener | ( | ) |
Get the topic listener.