17. C++ API Reference

Fast DDS, as a Data Distribution Service (DDS) standard implementation, exposes the DDS Data-Centric Publish-Subscribe (DCPS) Platform Independent Model (PIM) API, as specified in the DDS specification. Furthermore, is also gives the user the possibility to directly interact with the underlying Real-time Publish-Subscribe (RTPS) API that DDS implements for wired communications, as specified in the RTPS standard.

This section presents the most commonly used APIs provided by Fast DDS. For more information about the API reference, please refer to Fast DDS API reference.

• 17.1. DDS DCPS PIM
  • 17.1.1. Core
    • 17.1.1.1. Entity
    • 17.1.1.2. DomainEntity
    • 17.1.1.3. Policy
      • 17.1.1.3.1. DataRepresentationId
      • 17.1.1.3.2. DataRepresentationQosPolicy
      • 17.1.1.3.3. DataSharingQosPolicy
      • 17.1.1.3.4. DataSharingKind
      • 17.1.1.3.5. DeadlineQosPolicy
      • 17.1.1.3.6. DestinationOrderQosPolicy
      • 17.1.1.3.7. DestinationOrderQosPolicyKind
      • 17.1.1.3.8. DisablePositiveACKsQosPolicy
      • 17.1.1.3.9. DurabilityQosPolicy
      • 17.1.1.3.10. DurabilityQosPolicyKind
      • 17.1.1.3.11. DurabilityServiceQosPolicy
      • 17.1.1.3.12. EntityFactoryQosPolicy
      • 17.1.1.3.13. GenericDataQosPolicy
      • 17.1.1.3.14. GroupDataQosPolicy
      • 17.1.1.3.15. HistoryQosPolicy
      • 17.1.1.3.16. HistoryQosPolicyKind
      • 17.1.1.3.17. LatencyBudgetQosPolicy
      • 17.1.1.3.18. LifespanQosPolicy
      • 17.1.1.3.19. LivelinessQosPolicy
      • 17.1.1.3.20. LivelinessQosPolicyKind
      • 17.1.1.3.21. OwnershipQosPolicy
      • 17.1.1.3.22. OwnershipQosPolicyKind
      • 17.1.1.3.23. OwnershipStrengthQosPolicy
      • 17.1.1.3.24. ParticipantResourceLimitsQos
      • 17.1.1.3.25. Partition_t
      • 17.1.1.3.26. PartitionQosPolicy
      • 17.1.1.3.27. PresentationQosPolicy
      • 17.1.1.3.28. PresentationQosPolicyAccessScopeKind
      • 17.1.1.3.29. PropertyPolicyQos
      • 17.1.1.3.30. PublishModeQosPolicy
      • 17.1.1.3.31. PublishModeQosPolicyKind
      • 17.1.1.3.32. QosPolicy
      • 17.1.1.3.33. QosPolicyId_t
      • 17.1.1.3.34. ReaderDataLifecycleQosPolicy
      • 17.1.1.3.35. ReliabilityQosPolicy
      • 17.1.1.3.36. ReliabilityQosPolicyKind
      • 17.1.1.3.37. ResourceLimitsQosPolicy
      • 17.1.1.3.38. RTPSEndpointQos
      • 17.1.1.3.39. TimeBasedFilterQosPolicy
      • 17.1.1.3.40. TopicDataQosPolicy
      • 17.1.1.3.41. TransportConfigQos
      • 17.1.1.3.42. TransportPriorityQosPolicy
      • 17.1.1.3.43. TypeConsistencyEnforcementQosPolicy
      • 17.1.1.3.44. TypeConsistencyKind
      • 17.1.1.3.45. UserDataQosPolicy
      • 17.1.1.3.46. WireProtocolConfigQos
      • 17.1.1.3.47. WriterDataLifecycleQosPolicy
      • 17.1.1.3.48. WriterResourceLimitsQos
    • 17.1.1.4. Status
      • 17.1.1.4.1. BaseStatus
      • 17.1.1.4.2. DeadlineMissedStatus
      • 17.1.1.4.3. IncompatibleQosStatus
      • 17.1.1.4.4. InconsistentTopicStatus
      • 17.1.1.4.5. LivelinessChangedStatus
      • 17.1.1.4.6. MatchedStatus
      • 17.1.1.4.7. OfferedDeadlineMissedStatus
      • 17.1.1.4.8. OfferedIncompatibleQosStatus
      • 17.1.1.4.9. PublicationMatchedStatus
      • 17.1.1.4.10. QosPolicyCount
      • 17.1.1.4.11. QosPolicyCountSeq
      • 17.1.1.4.12. RequestedDeadlineMissedStatus
      • 17.1.1.4.13. RequestedIncompatibleQosStatus
      • 17.1.1.4.14. LivelinessLostStatus
      • 17.1.1.4.15. SampleLostStatus
      • 17.1.1.4.16. SampleRejectedStatus
      • 17.1.1.4.17. SampleRejectedStatusKind
      • 17.1.1.4.18. StatusMask
      • 17.1.1.4.19. SubscriptionMatchedStatus
    • 17.1.1.5. Condition
      • 17.1.1.5.1. Condition
      • 17.1.1.5.2. ConditionSeq
      • 17.1.1.5.3. GuardCondition
      • 17.1.1.5.4. StatusCondition
      • 17.1.1.5.5. Wait-set
    • 17.1.1.6. LoanableArray
    • 17.1.1.7. LoanableCollection
    • 17.1.1.8. LoanableSequence
    • 17.1.1.9. StackAllocatedSequence
  • 17.1.2. Domain
    • 17.1.2.1. DomainParticipant
    • 17.1.2.2. DomainParticipantFactory
    • 17.1.2.3. DomainParticipantFactoryQos
    • 17.1.2.4. DomainParticipantListener
    • 17.1.2.5. DomainParticipantQos
  • 17.1.3. Publisher
    • 17.1.3.1. DataWriter
    • 17.1.3.2. DataWriterListener
    • 17.1.3.3. DataWriterQos
    • 17.1.3.4. Publisher
    • 17.1.3.5. PublisherListener
    • 17.1.3.6. PublisherQos
    • 17.1.3.7. RTPSReliableWriterQos
  • 17.1.4. Subscriber
    • 17.1.4.1. DataReader
    • 17.1.4.2. DataReaderListener
    • 17.1.4.3. DataReaderQos
    • 17.1.4.4. InstanceStateKind
    • 17.1.4.5. ReadCondition
    • 17.1.4.6. ReaderResourceLimitsQos
    • 17.1.4.7. RTPSReliableReaderQos
    • 17.1.4.8. SampleInfo
    • 17.1.4.9. SampleStateKind
    • 17.1.4.10. Subscriber
    • 17.1.4.11. SubscriberListener
    • 17.1.4.12. SubscriberQos
    • 17.1.4.13. TypeConsistencyQos
    • 17.1.4.14. ViewStateKind
  • 17.1.5. Topic
    • 17.1.5.1. TopicDataType
    • 17.1.5.2. TypeSupport
    • 17.1.5.3. TopicDescription
    • 17.1.5.4. Topic
    • 17.1.5.5. ContentFilteredTopic
    • 17.1.5.6. IContentFilter
    • 17.1.5.7. IContentFilterFactory
    • 17.1.5.8. TopicListener
    • 17.1.5.9. TopicQos
    • 17.1.5.10. TypeIdV1
    • 17.1.5.11. TypeInformation
    • 17.1.5.12. TypeObjectV1
• 17.2. RTPS
  • 17.2.1. Attributes
    • 17.2.1.1. BuiltinAttributes
    • 17.2.1.2. c_default_RTPSParticipantAllocationAttributes
    • 17.2.1.3. DiscoveryProtocol
    • 17.2.1.4. DiscoverySettings
    • 17.2.1.5. EndpointAttributes
    • 17.2.1.6. ExternalLocators
    • 17.2.1.7. HistoryAttributes
    • 17.2.1.8. InitialAnnouncementConfig
    • 17.2.1.9. ParticipantFilteringFlags
    • 17.2.1.10. PropertyPolicy
    • 17.2.1.11. PropertyPolicyHelper
    • 17.2.1.12. ReaderAttributes
    • 17.2.1.13. ReaderTimes
    • 17.2.1.14. RemoteLocatorsAllocationAttributes
    • 17.2.1.15. RemoteServerAttributes
    • 17.2.1.16. RemoteServerList_t
    • 17.2.1.17. RTPSParticipantAllocationAttributes
    • 17.2.1.18. RTPSParticipantAttributes
    • 17.2.1.19. RTPSWriterPublishMode
    • 17.2.1.20. SendBuffersAllocationAttributes
    • 17.2.1.21. SimpleEDPAttributes
    • 17.2.1.22. TypeLookupSettings
    • 17.2.1.23. VariableLengthDataLimits
    • 17.2.1.24. WriterAttributes
    • 17.2.1.25. WriterTimes
  • 17.2.2. Builtin data
    • 17.2.2.1. ContentFilterProperty
  • 17.2.3. Common
    • 17.2.3.1. BinaryProperty
      • 17.2.3.1.1. BinaryProperty
      • 17.2.3.1.2. BinaryPropertyHelper
      • 17.2.3.1.3. BinaryPropertySeq
    • 17.2.3.2. CacheChange
      • 17.2.3.2.1. CacheChange_t
      • 17.2.3.2.2. ChangeForReader_t
      • 17.2.3.2.3. ChangeForReaderCmp
      • 17.2.3.2.4. ChangeForReaderStatus_t
      • 17.2.3.2.5. ChangeKind_t
    • 17.2.3.3. CDRMessage
      • 17.2.3.3.1. CDRMessage_t
      • 17.2.3.3.2. Macro definitions (#define)
    • 17.2.3.4. EntityId
      • 17.2.3.4.1. Const values
      • 17.2.3.4.2. Macro definitions (#define)
      • 17.2.3.4.3. EntityId_t
      • 17.2.3.4.4. EntityId_t Operators
    • 17.2.3.5. FragmentNumber
      • 17.2.3.5.1. FragmentNumber_t
      • 17.2.3.5.2. FragmentNumberSet_t
    • 17.2.3.6. Guid
      • 17.2.3.6.1. c_Guid_Unknown
      • 17.2.3.6.2. GUID_t
      • 17.2.3.6.3. GUID_t Operators
    • 17.2.3.7. GuidPrefix
      • 17.2.3.7.1. c_GuidPrefix_Unknown
      • 17.2.3.7.2. GuidPrefix_t
      • 17.2.3.7.3. GuidPrefix_t Operators
    • 17.2.3.8. InstanceHandle
      • 17.2.3.8.1. c_InstanceHandle_Unknown
      • 17.2.3.8.2. InstanceHandle_t
      • 17.2.3.8.3. InstanceHandle_t Operators
    • 17.2.3.9. Locator
      • 17.2.3.9.1. Macro definitions (#define)
      • 17.2.3.9.2. IsAddressDefined
      • 17.2.3.9.3. IsLocatorValid
      • 17.2.3.9.4. Locator_t
      • 17.2.3.9.5. LocatorList
      • 17.2.3.9.6. LocatorListConstIterator
      • 17.2.3.9.7. LocatorListIterator
      • 17.2.3.9.8. LocatorsIterator
      • 17.2.3.9.9. Locators
      • 17.2.3.9.10. Locator Operators
    • 17.2.3.10. LocatorSelectorEntry
    • 17.2.3.11. LocatorSelector
    • 17.2.3.12. LocatorWithMask
    • 17.2.3.13. MatchingInfo
      • 17.2.3.13.1. MatchingInfo
      • 17.2.3.13.2. MatchingStatus
    • 17.2.3.14. PortParameters
    • 17.2.3.15. Property
      • 17.2.3.15.1. Property
      • 17.2.3.15.2. PropertyHelper
      • 17.2.3.15.3. PropertySeq
    • 17.2.3.16. RemoteLocators
      • 17.2.3.16.1. RemoteLocators Operators
      • 17.2.3.16.2. RemoteLocatorList
    • 17.2.3.17. SampleIdentity
    • 17.2.3.18. SequenceNumber
      • 17.2.3.18.1. c_SequenceNumber_Unknown
      • 17.2.3.18.2. SequenceNumber_t Operators
      • 17.2.3.18.3. SequenceNumber_t
      • 17.2.3.18.4. SequenceNumberDiff
      • 17.2.3.18.5. SequenceNumberHash
      • 17.2.3.18.6. SequenceNumberSet_t
      • 17.2.3.18.7. sort_seqNum
    • 17.2.3.19. SerializedPayload
      • 17.2.3.19.1. Macro definitions (#define)
      • 17.2.3.19.2. SerializedPayload_t
    • 17.2.3.20. Time_t
      • 17.2.3.20.1. Const values
      • 17.2.3.20.2. Macro definitions (#define)
      • 17.2.3.20.3. eprosima::fastrtps::Duration_t
      • 17.2.3.20.4. eprosima::fastrtps::Time_t
      • 17.2.3.20.5. Time_t Operators
      • 17.2.3.20.6. Time_t
    • 17.2.3.21. Token
      • 17.2.3.21.1. AuthenticatedPeerCredentialToken
      • 17.2.3.21.2. DataHolder
      • 17.2.3.21.3. DataHolderHelper
      • 17.2.3.21.4. DataHolderSeq
      • 17.2.3.21.5. IdentityStatusToken
      • 17.2.3.21.6. IdentityToken
      • 17.2.3.21.7. PermissionsCredentialToken
      • 17.2.3.21.8. PermissionsToken
      • 17.2.3.21.9. Token
    • 17.2.3.22. Types
      • 17.2.3.22.1. BuiltinEndpointSet_t
      • 17.2.3.22.2. Const values
      • 17.2.3.22.3. Count_t
      • 17.2.3.22.4. Macro definitions (#define)
      • 17.2.3.22.5. DurabilityKind_t
      • 17.2.3.22.6. Endianness_t
      • 17.2.3.22.7. EndpointKind_t
      • 17.2.3.22.8. octet
      • 17.2.3.22.9. ProtocolVersion_t
      • 17.2.3.22.10. ReliabilityKind_t
      • 17.2.3.22.11. SubmessageFlag
      • 17.2.3.22.12. TopicKind_t
      • 17.2.3.22.13. VendorId_t
    • 17.2.3.23. WriteParams
  • 17.2.4. Endpoint
  • 17.2.5. Exceptions
    • 17.2.5.1. Exception
  • 17.2.6. Flow control
    • 17.2.6.1. FlowControllerDescriptor
    • 17.2.6.2. FlowControllerSchedulerPolicy
    • 17.2.6.3. ThroughputControllerDescriptor
  • 17.2.7. History
    • 17.2.7.1. History
    • 17.2.7.2. IChangePool
    • 17.2.7.3. IPayloadPool
    • 17.2.7.4. ReaderHistory
    • 17.2.7.5. WriterHistory
  • 17.2.8. RTPSParticipant
    • 17.2.8.1. ParticipantDiscoveryInfo
      • 17.2.8.1.1. ParticipantAuthenticationInfo
      • 17.2.8.1.2. ParticipantDiscoveryInfo
      • 17.2.8.1.3. ParticipantProxyData
      • 17.2.8.1.4. ReaderDiscoveryInfo
      • 17.2.8.1.5. ReaderProxyData
      • 17.2.8.1.6. WriterDiscoveryInfo
      • 17.2.8.1.7. WriterProxyData
    • 17.2.8.2. RTPSParticipant
    • 17.2.8.3. RTPSParticipantListener
  • 17.2.9. RTPSReader
    • 17.2.9.1. ReaderListener
    • 17.2.9.2. RTPSReader
  • 17.2.10. Resources
    • 17.2.10.1. MemoryManagementPolicy
  • 17.2.11. RTPSDomain
  • 17.2.12. RTPSWriter
    • 17.2.12.1. LivelinessData
    • 17.2.12.2. RTPSWriter
    • 17.2.12.3. WriterListener
• 17.3. Transport
  • 17.3.1. Transport Generic Interfaces
    • 17.3.1.1. TransportDescriptorInterface
    • 17.3.1.2. TransportInterface
    • 17.3.1.3. TransportReceiverInterface
    • 17.3.1.4. SocketTransportDescriptor
  • 17.3.2. Chaining of transports
    • 17.3.2.1. ChainingTransportDescriptor
    • 17.3.2.2. ChainingTransport
  • 17.3.3. UDP Transport
    • 17.3.3.1. UDPTransportDescriptor
    • 17.3.3.2. UDPv4TransportDescriptor
    • 17.3.3.3. UDPv6TransportDescriptor
    • 17.3.3.4. test_UDPv4TransportDescriptor
  • 17.3.4. TCP Transport
    • 17.3.4.1. TCPTransportDescriptor
    • 17.3.4.2. TCPv4TransportDescriptor
    • 17.3.4.3. TCPv6TransportDescriptor
  • 17.3.5. Shared Memory Transport
    • 17.3.5.1. SharedMemTransportDescriptor
• 17.4. LOG
  • 17.4.1. Colors
    • 17.4.1.1. Color Blue
    • 17.4.1.2. Color Bright
    • 17.4.1.3. Color Bright Blue
    • 17.4.1.4. Color Bright Cyan
    • 17.4.1.5. Color Bright Green
    • 17.4.1.6. Color Bright Magenta
    • 17.4.1.7. Color Bright Red
    • 17.4.1.8. Color Bright White
    • 17.4.1.9. Color Bright Yellow
    • 17.4.1.10. Color Cyan
    • 17.4.1.11. Color Def
    • 17.4.1.12. Color Green
    • 17.4.1.13. Color Magenta
    • 17.4.1.14. Color Red
    • 17.4.1.15. Color White
    • 17.4.1.16. Color Yellow
  • 17.4.2. FileConsumer
  • 17.4.3. Log
  • 17.4.4. LogConsumer
  • 17.4.5. logError
  • 17.4.6. logInfo
  • 17.4.7. logWarning
  • 17.4.8. OStreamConsumer
  • 17.4.9. StdoutConsumer
  • 17.4.10. StdoutErrConsumer
• 17.5. Statistics
  • 17.5.1. DomainParticipant
  • 17.5.2. DataWriterQos
  • 17.5.3. DataReaderQos
  • 17.5.4. Topic names