RTI Connext TSS API  Version 3.1.2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
RTI_TSS_Connection_Configuration Struct Reference

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This defines the configuration to be used by a TSS connection. More...

#include <Configuration.h>

Data Fields

const char * config_name
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Configuration name used to lookup this configuration.
 
const char * domain_config_name
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Configuration name used to lookup the DDS Domain Participant configuration for the Domain Participant that will create the underliying DDS entities needed by this connection.
 
FACE_CONNECTION_DIRECTION_TYPE direction
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Direction of the connection.
 
const char * topic_name
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Name for the new topic.
 
const char * type_name
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The type to which the new DDS_Topic will be bound..
 
RTI_TSS_PublisherQosCallback configure_publisher_qos_fn
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Publisher QoS settings.
 
struct DDS_PublisherListener publisher_listener
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Listener for publisher status.
 
DDS_StatusMask publisher_listener_status
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the publisher listener.
 
RTI_TSS_SubscriberQosCallback configure_subscriber_qos_fn
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Subscriber QoS settings.
 
struct DDS_SubscriberListener subscriber_listener
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Listener for subscriber status.
 
DDS_StatusMask subscriber_listener_status
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the subscriber listener.
 
RTI_TSS_TopicQosCallback configure_topic_qos_fn
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Topic QoS settings.
 
struct DDS_TopicListener topic_listener
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Listener for topic status.
 
DDS_StatusMask topic_listener_status
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the topic listener.
 
RTI_TSS_DataWriterQosCallback configure_datawriter_qos_fn
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Data Writer QoS settings.
 
struct DDS_DataWriterListener writer_listener
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Listener for writer status.
 
DDS_StatusMask writer_listener_status
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the writer listener.
 
RTI_TSS_DataReaderQosCallback configure_datareader_qos_fn
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Data Reader QoS settings.
 
struct DDS_DataReaderListener reader_listener
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Listener for reader status.
 
DDS_StatusMask reader_listener_status
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the reader listener.
 
void * user_data
 <<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to data that may be needed by the configure_publisher_qos_fn , configure_subscriber_qos_fn , configure_topic_qos_fn , configure_datawriter_qos_fn , and configure_datareader_qos_fn functions.
 
DDS_Boolean bi_dir_ignore_self
 <<Connext Pro>> Used to indicate if DDS entities created for this connection should ignore other DDS Entities previously created under the same participant.
 
const char * qos_library
 <<Connext Pro>> QoS Library to load the QoS profile from.
 
const char * qos_profile
 <<Connext Pro>> QoS Profile to load the DDS entities QoS settings from.
 

Detailed Description

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This defines the configuration to be used by a TSS connection.

The memory allocated to fill out this structure will be managed by the user and referenced by TSS.

Field Documentation

const char* RTI_TSS_Connection_Configuration::config_name

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Configuration name used to lookup this configuration.

const char* RTI_TSS_Connection_Configuration::domain_config_name

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Configuration name used to lookup the DDS Domain Participant configuration for the Domain Participant that will create the underliying DDS entities needed by this connection.

See Also
RTI_TSS_DDS_DomainParticipant_Configuration
FACE_CONNECTION_DIRECTION_TYPE RTI_TSS_Connection_Configuration::direction
const char* RTI_TSS_Connection_Configuration::topic_name

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Name for the new topic.

Must not exceed 255 characters.

const char* RTI_TSS_Connection_Configuration::type_name

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The type to which the new DDS_Topic will be bound..

Also used to lookup the matching

See Also
RTI_TSS_TypeSupport_Configuration structure.
RTI_TSS_PublisherQosCallback RTI_TSS_Connection_Configuration::configure_publisher_qos_fn

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Publisher QoS settings.

If this field is not NULL and qos_library and/or qos_profile are not NULL, the QoS settings loaded from that library/profile will be passed to this function. Otherwise, if this field is not NULL, and qos_library and/or qos_profile are NULL, the default QoS settings for this DDS entity type will be passed to this function.

Note
If direction is FACE_DESTINATION this one is ignored
struct DDS_PublisherListener RTI_TSS_Connection_Configuration::publisher_listener
DDS_StatusMask RTI_TSS_Connection_Configuration::publisher_listener_status

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the publisher listener.

RTI_TSS_SubscriberQosCallback RTI_TSS_Connection_Configuration::configure_subscriber_qos_fn

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Subscriber QoS settings.

If this field is not NULL and qos_library and/or qos_profile are not NULL, the QoS settings loaded from that library/profile will be passed to this function. Otherwise, if this field is not NULL, and qos_library and/or qos_profile are NULL, the default QoS settings for this DDS entity type will be passed to this function.

Note
If direction is FACE_SOURCE this one is ignored
struct DDS_SubscriberListener RTI_TSS_Connection_Configuration::subscriber_listener
DDS_StatusMask RTI_TSS_Connection_Configuration::subscriber_listener_status

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the subscriber listener.

RTI_TSS_TopicQosCallback RTI_TSS_Connection_Configuration::configure_topic_qos_fn

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Topic QoS settings.

If this field is not NULL and qos_library and/or qos_profile are not NULL, the QoS settings loaded from that library/profile will be passed to this function. Otherwise, if this field is not NULL, and qos_library and/or qos_profile are NULL, the default QoS settings for this DDS Entity type will be passed to this function.

struct DDS_TopicListener RTI_TSS_Connection_Configuration::topic_listener
DDS_StatusMask RTI_TSS_Connection_Configuration::topic_listener_status

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the topic listener.

RTI_TSS_DataWriterQosCallback RTI_TSS_Connection_Configuration::configure_datawriter_qos_fn

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Data Writer QoS settings.

If this field is not NULL and qos_library and/or qos_profile are not NULL, the QoS settings loaded from that library/profile will be passed to this function. Otherwise, if this field is not NULL, and qos_library and/or qos_profile are NULL, the default QoS settings for this DDS entity type will be passed to this function.

Note
If direction is FACE_DESTINATION this one is ignored
struct DDS_DataWriterListener RTI_TSS_Connection_Configuration::writer_listener
DDS_StatusMask RTI_TSS_Connection_Configuration::writer_listener_status

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the writer listener.

RTI_TSS_DataReaderQosCallback RTI_TSS_Connection_Configuration::configure_datareader_qos_fn

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to a function used to set the DDS Data Reader QoS settings.

If this field is not NULL and qos_library and/or qos_profile are not NULL, the QoS settings loaded from that library/profile will be passed to this function. Otherwise, if this field is not NULL, and qos_library and/or qos_profile are NULL, the default QoS settings for this entity type will be passed to this function.

Note
If direction is FACE_SOURCE this one is ignored
struct DDS_DataReaderListener RTI_TSS_Connection_Configuration::reader_listener
DDS_StatusMask RTI_TSS_Connection_Configuration::reader_listener_status

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Changes of communication status to be invoked on the reader listener.

void* RTI_TSS_Connection_Configuration::user_data

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Pointer to data that may be needed by the configure_publisher_qos_fn , configure_subscriber_qos_fn , configure_topic_qos_fn , configure_datawriter_qos_fn , and configure_datareader_qos_fn functions.

DDS_Boolean RTI_TSS_Connection_Configuration::bi_dir_ignore_self

<<Connext Pro>> Used to indicate if DDS entities created for this connection should ignore other DDS Entities previously created under the same participant.

const char* RTI_TSS_Connection_Configuration::qos_library

<<Connext Pro>> QoS Library to load the QoS profile from.

const char* RTI_TSS_Connection_Configuration::qos_profile

<<Connext Pro>> QoS Profile to load the DDS entities QoS settings from.


RTI Connext TSS API Version 3.1.2 Copyright © Tue Sep 20 2022 Real-Time Innovations, Inc