15. 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.

• 15.1. DDS DCPS PIM
  • 15.1.1. Core
    • 15.1.1.1. Entity
    • 15.1.1.2. DomainEntity
    • 15.1.1.3. Policy
      • 15.1.1.3.1. DataRepresentationId
      • 15.1.1.3.2. DataRepresentationQosPolicy
      • 15.1.1.3.3. DeadlineQosPolicy
      • 15.1.1.3.4. DestinationOrderQosPolicy
      • 15.1.1.3.5. DestinationOrderQosPolicyKind
      • 15.1.1.3.6. DisablePositiveACKsQosPolicy
      • 15.1.1.3.7. DurabilityQosPolicy
      • 15.1.1.3.8. DurabilityQosPolicyKind
      • 15.1.1.3.9. DurabilityServiceQosPolicy
      • 15.1.1.3.10. EntityFactoryQosPolicy
      • 15.1.1.3.11. GenericDataQosPolicy
      • 15.1.1.3.12. GroupDataQosPolicy
      • 15.1.1.3.13. HistoryQosPolicy
      • 15.1.1.3.14. HistoryQosPolicyKind
      • 15.1.1.3.15. LatencyBudgetQosPolicy
      • 15.1.1.3.16. LifespanQosPolicy
      • 15.1.1.3.17. LivelinessQosPolicy
      • 15.1.1.3.18. LivelinessQosPolicyKind
      • 15.1.1.3.19. OwnershipQosPolicy
      • 15.1.1.3.20. OwnershipQosPolicyKind
      • 15.1.1.3.21. OwnershipStrengthQosPolicy
      • 15.1.1.3.22. ParticipantResourceLimitsQos
      • 15.1.1.3.23. Partition_t
      • 15.1.1.3.24. PartitionQosPolicy
      • 15.1.1.3.25. PresentationQosPolicy
      • 15.1.1.3.26. PresentationQosPolicyAccessScopeKind
      • 15.1.1.3.27. PropertyPolicyQos
      • 15.1.1.3.28. PublishModeQosPolicy
      • 15.1.1.3.29. PublishModeQosPolicyKind
      • 15.1.1.3.30. QosPolicy
      • 15.1.1.3.31. QosPolicyId_t
      • 15.1.1.3.32. ReaderDataLifecycleQosPolicy
      • 15.1.1.3.33. ReliabilityQosPolicy
      • 15.1.1.3.34. ReliabilityQosPolicyKind
      • 15.1.1.3.35. ResourceLimitsQosPolicy
      • 15.1.1.3.36. RTPSEndpointQos
      • 15.1.1.3.37. TimeBasedFilterQosPolicy
      • 15.1.1.3.38. TopicDataQosPolicy
      • 15.1.1.3.39. TransportConfigQos
      • 15.1.1.3.40. TransportPriorityQosPolicy
      • 15.1.1.3.41. TypeConsistencyEnforcementQosPolicy
      • 15.1.1.3.42. TypeConsistencyKind
      • 15.1.1.3.43. UserDataQosPolicy
      • 15.1.1.3.44. WireProtocolConfigQos
      • 15.1.1.3.45. WriterDataLifecycleQosPolicy
      • 15.1.1.3.46. WriterResourceLimitsQos
    • 15.1.1.4. Status
      • 15.1.1.4.1. BaseStatus
      • 15.1.1.4.2. DeadlineMissedStatus
      • 15.1.1.4.3. IncompatibleQosStatus
      • 15.1.1.4.4. InconsistentTopicStatus
      • 15.1.1.4.5. LivelinessChangedStatus
      • 15.1.1.4.6. MatchedStatus
      • 15.1.1.4.7. OfferedDeadlineMissedStatus
      • 15.1.1.4.8. OfferedIncompatibleQosStatus
      • 15.1.1.4.9. PublicationMatchedStatus
      • 15.1.1.4.10. QosPolicyCount
      • 15.1.1.4.11. QosPolicyCountSeq
      • 15.1.1.4.12. RequestedDeadlineMissedStatus
      • 15.1.1.4.13. RequestedIncompatibleQosStatus
      • 15.1.1.4.14. LivelinessLostStatus
      • 15.1.1.4.15. SampleLostStatus
      • 15.1.1.4.16. SampleRejectedStatus
      • 15.1.1.4.17. SampleRejectedStatusKind
      • 15.1.1.4.18. StatusMask
      • 15.1.1.4.19. SubscriptionMatchedStatus
  • 15.1.2. Domain
    • 15.1.2.1. DomainParticipant
    • 15.1.2.2. DomainParticipantFactory
    • 15.1.2.3. DomainParticipantFactoryQos
    • 15.1.2.4. DomainParticipantListener
    • 15.1.2.5. DomainParticipantQos
  • 15.1.3. Publisher
    • 15.1.3.1. DataWriter
    • 15.1.3.2. DataWriterListener
    • 15.1.3.3. DataWriterQos
    • 15.1.3.4. Publisher
    • 15.1.3.5. PublisherListener
    • 15.1.3.6. PublisherQos
    • 15.1.3.7. RTPSReliableWriterQos
  • 15.1.4. Subscriber
    • 15.1.4.1. DataReader
    • 15.1.4.2. DataReaderListener
    • 15.1.4.3. DataReaderQos
    • 15.1.4.4. InstanceStateKind
    • 15.1.4.5. ReaderResourceLimitsQos
    • 15.1.4.6. RTPSReliableReaderQos
    • 15.1.4.7. SampleInfo
    • 15.1.4.8. SampleStateKind
    • 15.1.4.9. Subscriber
    • 15.1.4.10. SubscriberListener
    • 15.1.4.11. SubscriberQos
    • 15.1.4.12. TypeConsistencyQos
    • 15.1.4.13. ViewStateKind
  • 15.1.5. Topic
    • 15.1.5.1. Topic
    • 15.1.5.2. TopicDataType
    • 15.1.5.3. TopicDescription
    • 15.1.5.4. TopicListener
    • 15.1.5.5. TopicQos
    • 15.1.5.6. TypeIdV1
    • 15.1.5.7. TypeInformation
    • 15.1.5.8. TypeObjectV1
    • 15.1.5.9. TypeSupport
• 15.2. RTPS
  • 15.2.1. Attributes
    • 15.2.1.1. BuiltinAttributes
    • 15.2.1.2. c_default_RTPSParticipantAllocationAttributes
    • 15.2.1.3. DiscoveryProtocol
    • 15.2.1.4. DiscoverySettings
    • 15.2.1.5. EndpointAttributes
    • 15.2.1.6. HistoryAttributes
    • 15.2.1.7. InitialAnnouncementConfig
    • 15.2.1.8. ParticipantFilteringFlags
    • 15.2.1.9. PropertyPolicy
    • 15.2.1.10. PropertyPolicyHelper
    • 15.2.1.11. ReaderAttributes
    • 15.2.1.12. ReaderTimes
    • 15.2.1.13. RemoteLocatorsAllocationAttributes
    • 15.2.1.14. RemoteServerAttributes
    • 15.2.1.15. RemoteServerList_t
    • 15.2.1.16. RTPSParticipantAllocationAttributes
    • 15.2.1.17. RTPSParticipantAttributes
    • 15.2.1.18. RTPSWriterPublishMode
    • 15.2.1.19. SendBuffersAllocationAttributes
    • 15.2.1.20. SimpleEDPAttributes
    • 15.2.1.21. TypeLookupSettings
    • 15.2.1.22. VariableLengthDataLimits
    • 15.2.1.23. WriterAttributes
    • 15.2.1.24. WriterTimes
  • 15.2.2. Common
    • 15.2.2.1. BinaryProperty
      • 15.2.2.1.1. BinaryProperty
      • 15.2.2.1.2. BinaryPropertyHelper
      • 15.2.2.1.3. BinaryPropertySeq
    • 15.2.2.2. CacheChange
      • 15.2.2.2.1. CacheChange_t
      • 15.2.2.2.2. ChangeForReader_t
      • 15.2.2.2.3. ChangeForReaderCmp
      • 15.2.2.2.4. ChangeForReaderStatus_t
      • 15.2.2.2.5. ChangeKind_t
    • 15.2.2.3. CDRMessage
      • 15.2.2.3.1. CDRMessage_t
      • 15.2.2.3.2. Macro definitions (#define)
    • 15.2.2.4. EntityId
      • 15.2.2.4.1. Const values
      • 15.2.2.4.2. Macro definitions (#define)
      • 15.2.2.4.3. EntityId_t
      • 15.2.2.4.4. EntityId_t Operators
    • 15.2.2.5. FragmentNumber
      • 15.2.2.5.1. FragmentNumber_t
      • 15.2.2.5.2. FragmentNumberSet_t
    • 15.2.2.6. Guid
      • 15.2.2.6.1. c_Guid_Unknown
      • 15.2.2.6.2. GUID_t
      • 15.2.2.6.3. GUID_t Operators
    • 15.2.2.7. GuidPrefix
      • 15.2.2.7.1. c_GuidPrefix_Unknown
      • 15.2.2.7.2. GuidPrefix_t
      • 15.2.2.7.3. GuidPrefix_t Operators
    • 15.2.2.8. InstanceHandle
      • 15.2.2.8.1. c_InstanceHandle_Unknown
      • 15.2.2.8.2. InstanceHandle_t
      • 15.2.2.8.3. InstanceHandle_t Operators
    • 15.2.2.9. Locator
      • 15.2.2.9.1. Macro definitions (#define)
      • 15.2.2.9.2. IsAddressDefined
      • 15.2.2.9.3. IsLocatorValid
      • 15.2.2.9.4. Locator_t
      • 15.2.2.9.5. LocatorList_t
      • 15.2.2.9.6. LocatorListConstIterator
      • 15.2.2.9.7. LocatorListIterator
      • 15.2.2.9.8. LocatorsIterator
      • 15.2.2.9.9. Locator Operators
    • 15.2.2.10. LocatorSelectorEntry
    • 15.2.2.11. LocatorSelector
    • 15.2.2.12. MatchingInfo
      • 15.2.2.12.1. MatchingInfo
      • 15.2.2.12.2. MatchingStatus
    • 15.2.2.13. PortParameters
    • 15.2.2.14. Property
      • 15.2.2.14.1. Property
      • 15.2.2.14.2. PropertyHelper
      • 15.2.2.14.3. PropertySeq
    • 15.2.2.15. RemoteLocators
      • 15.2.2.15.1. RemoteLocators Operators
      • 15.2.2.15.2. RemoteLocatorList
    • 15.2.2.16. SampleIdentity
    • 15.2.2.17. SequenceNumber
      • 15.2.2.17.1. c_SequenceNumber_Unknown
      • 15.2.2.17.2. SequenceNumber_t Operators
      • 15.2.2.17.3. SequenceNumber_t
      • 15.2.2.17.4. SequenceNumberDiff
      • 15.2.2.17.5. SequenceNumberHash
      • 15.2.2.17.6. SequenceNumberSet_t
      • 15.2.2.17.7. sort_seqNum
    • 15.2.2.18. SerializedPayload
      • 15.2.2.18.1. Macro definitions (#define)
      • 15.2.2.18.2. SerializedPayload_t
    • 15.2.2.19. Time_t
      • 15.2.2.19.1. Const values
      • 15.2.2.19.2. Macro definitions (#define)
      • 15.2.2.19.3. eprosima::fastrtps::Duration_t
      • 15.2.2.19.4. eprosima::fastrtps::Time_t
      • 15.2.2.19.5. Time_t Operators
      • 15.2.2.19.6. Time_t
    • 15.2.2.20. Token
      • 15.2.2.20.1. AuthenticatedPeerCredentialToken
      • 15.2.2.20.2. DataHolder
      • 15.2.2.20.3. DataHolderHelper
      • 15.2.2.20.4. DataHolderSeq
      • 15.2.2.20.5. IdentityStatusToken
      • 15.2.2.20.6. IdentityToken
      • 15.2.2.20.7. PermissionsCredentialToken
      • 15.2.2.20.8. PermissionsToken
      • 15.2.2.20.9. Token
    • 15.2.2.21. Types
      • 15.2.2.21.1. BuiltinEndpointSet_t
      • 15.2.2.21.2. Const values
      • 15.2.2.21.3. Count_t
      • 15.2.2.21.4. Macro definitions (#define)
      • 15.2.2.21.5. DurabilityKind_t
      • 15.2.2.21.6. Endianness_t
      • 15.2.2.21.7. EndpointKind_t
      • 15.2.2.21.8. octet
      • 15.2.2.21.9. ProtocolVersion_t
      • 15.2.2.21.10. ReliabilityKind_t
      • 15.2.2.21.11. SubmessageFlag
      • 15.2.2.21.12. TopicKind_t
      • 15.2.2.21.13. VendorId_t
    • 15.2.2.22. WriteParams
  • 15.2.3. Endpoint
  • 15.2.4. Exceptions
    • 15.2.4.1. Exception
  • 15.2.5. Flow control
    • 15.2.5.1. ThroughputControllerDescriptor
  • 15.2.6. History
    • 15.2.6.1. History
    • 15.2.6.2. IChangePool
    • 15.2.6.3. IPayloadPool
    • 15.2.6.4. ReaderHistory
    • 15.2.6.5. WriterHistory
  • 15.2.7. RTPSParticipant
    • 15.2.7.1. ParticipantDiscoveryInfo
      • 15.2.7.1.1. ParticipantAuthenticationInfo
      • 15.2.7.1.2. ParticipantDiscoveryInfo
      • 15.2.7.1.3. ParticipantProxyData
      • 15.2.7.1.4. ReaderDiscoveryInfo
      • 15.2.7.1.5. ReaderProxyData
      • 15.2.7.1.6. WriterDiscoveryInfo
      • 15.2.7.1.7. WriterProxyData
    • 15.2.7.2. RTPSParticipant
    • 15.2.7.3. RTPSParticipantListener
  • 15.2.8. RTPSReader
    • 15.2.8.1. ReaderListener
    • 15.2.8.2. RTPSReader
  • 15.2.9. Resources
    • 15.2.9.1. MemoryManagementPolicy
  • 15.2.10. RTPSDomain
  • 15.2.11. RTPSWriter
    • 15.2.11.1. LivelinessData
    • 15.2.11.2. RTPSWriter
    • 15.2.11.3. WriterListener
• 15.3. LOG
  • 15.3.1. Colors
    • 15.3.1.1. Color Blue
    • 15.3.1.2. Color Bright
    • 15.3.1.3. Color Bright Blue
    • 15.3.1.4. Color Bright Cyan
    • 15.3.1.5. Color Bright Green
    • 15.3.1.6. Color Bright Magenta
    • 15.3.1.7. Color Bright Red
    • 15.3.1.8. Color Bright White
    • 15.3.1.9. Color Bright Yellow
    • 15.3.1.10. Color Cyan
    • 15.3.1.11. Color Def
    • 15.3.1.12. Color Green
    • 15.3.1.13. Color Magenta
    • 15.3.1.14. Color Red
    • 15.3.1.15. Color White
    • 15.3.1.16. Color Yellow
  • 15.3.2. FileConsumer
  • 15.3.3. Log
  • 15.3.4. LogConsumer
  • 15.3.5. logError
  • 15.3.6. logInfo
  • 15.3.7. logWarning
  • 15.3.8. OStreamConsumer
  • 15.3.9. StdoutConsumer
  • 15.3.10. StdoutErrConsumer