RTI Routing Service MQTT Adapter
7.3.0
Contents
1. Introduction
2. Configuration
2.1. Load the MQTT Adapter Plugin
2.2. Register MQTT Data Types
2.3. Configure QoS
2.4. Connect to an
MQTT Broker
2.5. Route Data from MQTT to DDS
2.6. Route Data from DDS to MQTT
2.7. XML Configuration properties
2.7.1. <connection> Properties
2.7.1.1. client.id
2.7.1.2. client.servers
2.7.1.3. client.protocol_version
2.7.1.4. client.connection_timeout.sec
2.7.1.5. client.connection_timeout.nanosec
2.7.1.6. client.max_connection_retries
2.7.1.7. client.keep_alive_period.sec
2.7.1.8. client.keep_alive_period.nanosec
2.7.1.9. client.clean_session
2.7.1.10. client.unsubscribe_on_disconnect
2.7.1.11. client.max_reply_timeout.sec
2.7.1.12. client.max_reply_timeout.nanosec
2.7.1.13. client.reconnect
2.7.1.14. client.max_unack_messages
2.7.1.15. client.persistence
2.7.1.16. client.persistence_storage
2.7.1.17. client.username
2.7.1.18. client.password
2.7.1.19. client.ssl.ca
2.7.1.20. client.ssl.id
2.7.1.21. client.ssl.key
2.7.1.22. client.ssl.key_password
2.7.1.23. client.ssl.protocol_version
2.7.1.24. client.ssl.verify_server_certificate
2.7.1.25. client.ssl.cypher_suites
2.7.2. <input> Properties
2.7.2.1. subscription.topics
2.7.2.2. subscription.max_qos
2.7.2.3. subscription.queue_size
2.7.3. <output> Properties
2.7.3.1. publication.topic
2.7.3.2. publication.qos
2.7.3.3. publication.retained
2.7.3.4. publication.use_message_info
2.7.3.5. publication.max_wait_time.sec
2.7.3.6. publication.max_wait_time.nanosec
3. MQTT Adapter API
3.1. Compiler Defines
3.1.1. User Defines
3.1.2. Automatic Defines
3.1.3. Platform Defines
3.1.4. MQTT Library Defines
3.2. MQTT Client API
3.2.1. MQTT Configuration
3.2.1.1. MQTT Client Configuration
3.2.1.2. MQTT Subscription Configuration
3.2.1.3. MQTT Publication Configuration
3.2.1.4. Configuration Infrastructure
3.2.2. MQTT Client
3.2.3. MQTT Subscription
3.2.4. MQTT Publication
3.2.5. MQTT Message
3.2.6. Platform Support
3.2.7. IDL Types
3.2.7.1. MQTT Configuration
3.2.7.2. MQTT Message
3.2.7.3. MQTT Client
3.2.7.4. MQTT Subscription
3.2.7.5. MQTT Publication
3.3. RTI Routing Service Adapter Plugin
3.4. Configuration Properties
3.4.1. MQTT Client Configuration
3.4.2. MQTT Subscription Configuration
3.4.3. MQTT Publication Configuration
4. Additional Resources
4.1. Examples
4.2. Tests
5. Release Notes
5.1. Supported Platforms
6. Copyrights
RTI Routing Service MQTT Adapter
»
Index
Index
C
|
M
|
P
|
Q
|
R
|
S
C
ClientStateKind (C++ enum)
ClientStateKind::CONNECTED (C++ enumerator)
ClientStateKind::CONNECTING (C++ enumerator)
ClientStateKind::DISCONNECTED (C++ enumerator)
ClientStateKind::DISCONNECTING (C++ enumerator)
ClientStateKind::ERROR (C++ enumerator)
M
MQTT_CLIENT_API (C macro)
MQTT_CLIENT_API_DEFAULT (C macro)
MQTT_CLIENT_API_MOSQUITTO (C macro)
MQTT_CLIENT_API_PAHO_C (C macro)
MqttProtocolVersion (C++ enum)
MqttProtocolVersion::MQTT_3_1 (C++ enumerator)
MqttProtocolVersion::MQTT_3_1_1 (C++ enumerator)
MqttProtocolVersion::MQTT_5 (C++ enumerator)
MqttProtocolVersion::MQTT_DEFAULT (C++ enumerator)
P
PersistenceLevel (C++ enum)
PersistenceLevel::DURABLE (C++ enumerator)
PersistenceLevel::NONE (C++ enumerator)
Q
QosLevel (C++ enum)
QosLevel::ONE (C++ enumerator)
QosLevel::TWO (C++ enumerator)
QosLevel::UNKNOWN (C++ enumerator)
QosLevel::ZERO (C++ enumerator)
R
RTI::MQTT::ClientConfig (C++ struct)
RTI::MQTT::ClientConfig::clean_session (C++ member)
RTI::MQTT::ClientConfig::connect_timeout (C++ member)
RTI::MQTT::ClientConfig::id (C++ member)
RTI::MQTT::ClientConfig::keep_alive_period (C++ member)
RTI::MQTT::ClientConfig::max_connection_retries (C++ member)
RTI::MQTT::ClientConfig::max_reply_timeout (C++ member)
RTI::MQTT::ClientConfig::max_unack_messages (C++ member)
RTI::MQTT::ClientConfig::password (C++ type)
RTI::MQTT::ClientConfig::persistence_level (C++ member)
RTI::MQTT::ClientConfig::persistence_storage (C++ member)
RTI::MQTT::ClientConfig::protocol_version (C++ member)
RTI::MQTT::ClientConfig::reconnect (C++ member)
RTI::MQTT::ClientConfig::server_uris (C++ type)
RTI::MQTT::ClientConfig::ssl_tls_config (C++ member)
RTI::MQTT::ClientConfig::unsubscribe_on_disconnect (C++ member)
RTI::MQTT::ClientConfig::username (C++ member)
RTI::MQTT::ClientStatus (C++ struct)
RTI::MQTT::ClientStatus::config (C++ member)
RTI::MQTT::ClientStatus::publications (C++ type)
RTI::MQTT::ClientStatus::state (C++ member)
RTI::MQTT::ClientStatus::subscriptions (C++ type)
RTI::MQTT::KeyedMessage (C++ struct)
RTI::MQTT::KeyedMessage::info (C++ member)
RTI::MQTT::KeyedMessage::payload (C++ member)
RTI::MQTT::Message (C++ struct)
RTI::MQTT::Message::info (C++ member)
RTI::MQTT::Message::payload (C++ member)
RTI::MQTT::Message::topic (C++ member)
RTI::MQTT::MessageInfo (C++ struct)
RTI::MQTT::MessageInfo::duplicate (C++ member)
RTI::MQTT::MessageInfo::id (C++ member)
RTI::MQTT::MessageInfo::qos_level (C++ member)
RTI::MQTT::MessageInfo::retained (C++ member)
RTI::MQTT::MessagePayload (C++ struct)
RTI::MQTT::MessagePayload::data (C++ type)
RTI::MQTT::PublicationConfig (C++ struct)
RTI::MQTT::PublicationConfig::max_wait_time (C++ member)
RTI::MQTT::PublicationConfig::qos (C++ member)
RTI::MQTT::PublicationConfig::retained (C++ member)
RTI::MQTT::PublicationConfig::topic (C++ member)
RTI::MQTT::PublicationConfig::use_message_info (C++ member)
RTI::MQTT::PublicationMessageStatus (C++ struct)
RTI::MQTT::PublicationMessageStatus::error_count (C++ member)
RTI::MQTT::PublicationMessageStatus::ok_count (C++ member)
RTI::MQTT::PublicationMessageStatus::pending_count (C++ member)
RTI::MQTT::PublicationMessageStatus::sent_count (C++ member)
RTI::MQTT::PublicationStatus (C++ struct)
RTI::MQTT::PublicationStatus::config (C++ member)
RTI::MQTT::PublicationStatus::message_status (C++ member)
RTI::MQTT::SslTlsConfig (C++ struct)
RTI::MQTT::SslTlsConfig::ca (C++ member)
RTI::MQTT::SslTlsConfig::cypher_suites (C++ member)
RTI::MQTT::SslTlsConfig::identity (C++ member)
RTI::MQTT::SslTlsConfig::private_key (C++ member)
RTI::MQTT::SslTlsConfig::private_key_password (C++ member)
RTI::MQTT::SslTlsConfig::protocol_version (C++ member)
RTI::MQTT::SslTlsConfig::verify_server_certificate (C++ member)
RTI::MQTT::SubscriptionConfig (C++ struct)
RTI::MQTT::SubscriptionConfig::max_qos (C++ member)
RTI::MQTT::SubscriptionConfig::message_queue_size (C++ member)
RTI::MQTT::SubscriptionConfig::topic_filters (C++ type)
RTI::MQTT::SubscriptionMessageStatus (C++ struct)
RTI::MQTT::SubscriptionMessageStatus::lost_count (C++ member)
RTI::MQTT::SubscriptionMessageStatus::read_count (C++ member)
RTI::MQTT::SubscriptionMessageStatus::received_count (C++ member)
RTI::MQTT::SubscriptionMessageStatus::unread_count (C++ member)
RTI::MQTT::SubscriptionParams (C++ struct)
RTI::MQTT::SubscriptionParams::max_qos (C++ member)
RTI::MQTT::SubscriptionParams::topic (C++ member)
RTI::MQTT::SubscriptionStatus (C++ struct)
RTI::MQTT::SubscriptionStatus::config (C++ member)
RTI::MQTT::SubscriptionStatus::message_status (C++ member)
RTI::MQTT::Time (C++ struct)
RTI::MQTT::Time::nanoseconds (C++ member)
RTI::MQTT::Time::seconds (C++ member)
RTI::MQTT::WriteParams (C++ struct)
RTI::MQTT::WriteParams::qos_level (C++ member)
RTI::MQTT::WriteParams::retained (C++ member)
RTI_MQTT_Client_connect (C++ function)
RTI_MQTT_Client_delete (C++ function)
RTI_MQTT_Client_disconnect (C++ function)
RTI_MQTT_Client_get_id (C++ function)
RTI_MQTT_Client_new (C++ function)
RTI_MQTT_Client_publish (C++ function)
RTI_MQTT_Client_subscribe (C++ function)
RTI_MQTT_Client_unpublish (C++ function)
RTI_MQTT_Client_unsubscribe (C++ function)
RTI_MQTT_ClientConfig_default (C++ function)
RTI_MQTT_ClientConfig_DEFAULT (C++ member)
RTI_MQTT_ClientConfig_delete (C++ function)
RTI_MQTT_ClientConfig_INITIALIZER (C macro)
RTI_MQTT_ClientConfig_new (C++ function)
RTI_MQTT_DISABLE_LOG (C macro)
RTI_MQTT_DYNAMIC_TYPES (C macro)
RTI_MQTT_ENABLE_LOG (C macro)
RTI_MQTT_ENABLE_SSL (C macro)
RTI_MQTT_ENABLE_TRACE (C macro)
RTI_MQTT_Message_from_dynamic_data (C++ function)
RTI_MQTT_Message_to_dynamic_data (C++ function)
RTI_MQTT_Mutex (C++ type)
RTI_MQTT_Mutex_assert (C macro)
RTI_MQTT_Mutex_assert_w_state (C macro)
RTI_MQTT_Mutex_finalize (C++ function)
RTI_MQTT_Mutex_give (C++ function)
RTI_MQTT_Mutex_initialize (C++ function)
RTI_MQTT_Mutex_INITIALIZER (C macro)
RTI_MQTT_MUTEX_INITIALIZER_NATIVE (C macro)
RTI_MQTT_MUTEX_INITIALIZER_POSIX (C macro)
RTI_MQTT_MUTEX_INITIALIZER_WINDOWS (C macro)
RTI_MQTT_MUTEX_NATIVE (C macro)
RTI_MQTT_MUTEX_POSIX (C macro)
RTI_MQTT_Mutex_release (C macro)
RTI_MQTT_Mutex_release_from_state (C macro)
RTI_MQTT_Mutex_release_w_state (C macro)
RTI_MQTT_Mutex_take (C++ function)
RTI_MQTT_MUTEX_WINDOWS (C macro)
RTI_MQTT_PLATFORM (C macro)
RTI_MQTT_PLATFORM_POSIX (C macro)
RTI_MQTT_PLATFORM_UNKNOWN (C macro)
RTI_MQTT_PLATFORM_WINDOWS (C macro)
RTI_MQTT_PROPERTY_CLIENT_CLEAN_SESSION (C macro)
RTI_MQTT_PROPERTY_CLIENT_CONNECTION_TIMEOUT (C macro)
RTI_MQTT_PROPERTY_CLIENT_CONNECTION_TIMEOUT_NANOSECONDS (C macro)
RTI_MQTT_PROPERTY_CLIENT_CONNECTION_TIMEOUT_SECONDS (C macro)
RTI_MQTT_PROPERTY_CLIENT_ID (C macro)
RTI_MQTT_PROPERTY_CLIENT_KEEP_ALIVE_PERIOD (C macro)
RTI_MQTT_PROPERTY_CLIENT_KEEP_ALIVE_PERIOD_NANOSECONDS (C macro)
RTI_MQTT_PROPERTY_CLIENT_KEEP_ALIVE_PERIOD_SECONDS (C macro)
RTI_MQTT_PROPERTY_CLIENT_MAX_CONNECTION_RETRIES (C macro)
RTI_MQTT_PROPERTY_CLIENT_MAX_REPLY_TIMEOUT (C macro)
RTI_MQTT_PROPERTY_CLIENT_MAX_REPLY_TIMEOUT_NANOSECONDS (C macro)
RTI_MQTT_PROPERTY_CLIENT_MAX_REPLY_TIMEOUT_SECONDS (C macro)
RTI_MQTT_PROPERTY_CLIENT_MAX_UNACK_MESSAGES (C macro)
RTI_MQTT_PROPERTY_CLIENT_PASSWORD (C macro)
RTI_MQTT_PROPERTY_CLIENT_PERSISTENCE (C macro)
RTI_MQTT_PROPERTY_CLIENT_PERSISTENCE_STORAGE (C macro)
RTI_MQTT_PROPERTY_CLIENT_PROTOCOL_VERSION (C macro)
RTI_MQTT_PROPERTY_CLIENT_RECONNECT (C macro)
RTI_MQTT_PROPERTY_CLIENT_SERVERS (C macro)
RTI_MQTT_PROPERTY_CLIENT_UNSUBSCRIBE_ON_DISCONNECT (C macro)
RTI_MQTT_PROPERTY_CLIENT_USERNAME (C macro)
RTI_MQTT_PROPERTY_PREFIX_CLIENT (C macro)
RTI_MQTT_PROPERTY_PREFIX_CLIENT_SSL (C macro)
RTI_MQTT_PROPERTY_PREFIX_PUBLICATION (C macro)
RTI_MQTT_PROPERTY_PREFIX_SUBSCRIPTION (C macro)
RTI_MQTT_PROPERTY_PUBLICATION_MAX_WAIT_TIME (C macro)
RTI_MQTT_PROPERTY_PUBLICATION_MAX_WAIT_TIME_NANOSECONDS (C macro)
RTI_MQTT_PROPERTY_PUBLICATION_MAX_WAIT_TIME_SECONDS (C macro)
RTI_MQTT_PROPERTY_PUBLICATION_QOS (C macro)
RTI_MQTT_PROPERTY_PUBLICATION_RETAINED (C macro)
RTI_MQTT_PROPERTY_PUBLICATION_TOPIC (C macro)
RTI_MQTT_PROPERTY_PUBLICATION_USE_MESSAGE_INFO (C macro)
RTI_MQTT_PROPERTY_SUBSCRIPTION_MAX_QOS (C macro)
RTI_MQTT_PROPERTY_SUBSCRIPTION_QUEUE_SIZE (C macro)
RTI_MQTT_PROPERTY_SUBSCRIPTION_TOPICS (C macro)
RTI_MQTT_Publication_write (C++ function)
RTI_MQTT_Publication_write_w_params (C++ function)
RTI_MQTT_PublicationConfig_default (C++ function)
RTI_MQTT_PublicationConfig_DEFAULT (C++ member)
RTI_MQTT_PublicationConfig_delete (C++ function)
RTI_MQTT_PublicationConfig_INITIALIZER (C macro)
RTI_MQTT_PublicationConfig_new (C++ function)
RTI_MQTT_STATIC_TYPES (C macro)
RTI_MQTT_Subscription_DataAvailableCallback (C++ type)
RTI_MQTT_Subscription_read (C++ function)
RTI_MQTT_SUBSCRIPTION_READ_LENGTH_UNLIMITED (C macro)
RTI_MQTT_Subscription_return_loan (C++ function)
RTI_MQTT_Subscription_set_data_available_listener (C++ function)
RTI_MQTT_SubscriptionConfig_default (C++ function)
RTI_MQTT_SubscriptionConfig_DEFAULT (C++ member)
RTI_MQTT_SubscriptionConfig_delete (C++ function)
RTI_MQTT_SubscriptionConfig_INITIALIZER (C macro)
RTI_MQTT_SubscriptionConfig_new (C++ function)
RTI_MQTT_Thread_join (C++ function)
RTI_MQTT_Thread_spawn (C++ function)
RTI_MQTT_ThreadFn (C++ type)
RTI_MQTT_Time_INFINITE (C++ member)
RTI_MQTT_Time_INITIALIZER (C macro)
RTI_MQTT_Time_ZERO (C++ member)
RTI_MQTT_USE_LOG (C macro)
RTI_MQTT_USE_SSL (C macro)
RTI_MQTT_USE_STATIC_TYPES (C macro)
RTI_MQTT_USE_TRACE (C macro)
RTI_MQTT_WriteParams_INITIALIZER (C macro)
RTI_RS_MQTT_ADAPTER_VERSION_MAJOR (C macro)
RTI_RS_MQTT_ADAPTER_VERSION_MINOR (C macro)
RTI_RS_MQTT_ADAPTER_VERSION_RELEASE (C macro)
RTI_RS_MQTT_ADAPTER_VERSION_REVISION (C macro)
RTI_RS_MQTT_AdapterPlugin_create (C++ function)
RTI_RS_MQTT_AdapterPlugin_VERSION (C++ member)
S
SslTlsProtocolVersion (C++ enum)
SslTlsProtocolVersion::TLS_1_0 (C++ enumerator)
SslTlsProtocolVersion::TLS_1_1 (C++ enumerator)
SslTlsProtocolVersion::TLS_1_2 (C++ enumerator)
SslTlsProtocolVersion::TLS_DEFAULT (C++ enumerator)
SubscriptionStateKind (C++ enum)
SubscriptionStateKind::CREATED (C++ enumerator)
SubscriptionStateKind::ERROR (C++ enumerator)
SubscriptionStateKind::SUBSCRIBED (C++ enumerator)