Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

Toggle table of contents sidebar

Introduction

What is Fast DDS?
Commercial support
Key features
DDS API
Fast DDS-Gen
RTPS Wire Protocol
Main Features
Dependencies and compatibilities
Contributing to the documentation
Structure of the documentation

Installation Manual

1. Linux installation from binaries
2. Windows installation from binaries
3. Linux installation from sources
4. Windows installation from sources
5. Mac OS installation from sources
6. QNX 7.1 installation from sources
7. CMake options

Fast DDS

1. Getting Started
Toggle navigation of 1. Getting Started
2. Library Overview
3. DDS Layer
Toggle navigation of 3. DDS Layer
- 3.1. Core
  Toggle navigation of 3.1. Core
  - 3.1.1. Entity
  - 3.1.2. Policy
    Toggle navigation of 3.1.2. Policy
  - 3.1.3. Status
  - 3.1.4. Conditions and Wait-sets
- 3.2. Domain
  Toggle navigation of 3.2. Domain
- 3.3. Publisher
  Toggle navigation of 3.3. Publisher
- 3.4. Subscriber
  Toggle navigation of 3.4. Subscriber
- 3.5. Topic
  Toggle navigation of 3.5. Topic
4. RTPS Layer
5. Discovery
Toggle navigation of 5. Discovery
6. Transport Layer
Toggle navigation of 6. Transport Layer
7. Persistence Service
8. Security
Toggle navigation of 8. Security
- 8.1. Authentication plugin: DDS:Auth:PKI-DH
- 8.2. Access control plugin: DDS:Access:Permissions
  Toggle navigation of 8.2. Access control plugin: DDS:Access:Permissions
  - Domain Governance XSD
  - DomainParticipant Permissions XSD
- 8.3. Cryptographic plugin: DDS:Crypto:AES-GCM-GMAC
- 8.4. Logging plugin: DDS:Logging:DDS_LogTopic
- 8.5. PKCS#11 support
9. Logging
Toggle navigation of 9. Logging
10. XML profiles
Toggle navigation of 10. XML profiles
11. Environment variables
12. PropertyPolicyQos Options
Toggle navigation of 12. PropertyPolicyQos Options
13. Statistics Module
Toggle navigation of 13. Statistics Module
- 13.1. Statistics Module DDS Layer
  Toggle navigation of 13.1. Statistics Module DDS Layer
- 13.2. Monitor Service
  Toggle navigation of 13.2. Monitor Service
14. XTypes
Toggle navigation of 14. XTypes
15. Typical Use-Cases
Toggle navigation of 15. Typical Use-Cases
- 15.1. Large Data mode and Fast DDS over TCP
  Toggle navigation of 15.1. Large Data mode and Fast DDS over TCP
- 15.2. Fast DDS over WIFI
  Toggle navigation of 15.2. Fast DDS over WIFI
- 15.3. Well Known Network Deployments
- 15.4. Large Data Rates
- 15.5. Topics with many subscribers
- 15.6. Real-time behavior
  Toggle navigation of 15.6. Real-time behavior
  - 15.6.1. Tuning allocations
  - 15.6.2. Non-blocking calls
- 15.7. Reduce memory usage
- 15.8. Zero-Copy communication
- 15.9. Unique network flows
- 15.10. Statistics module
- 15.11. Dynamic network interfaces
- 15.12. How to use eProsima DDS Record and Replay
- 15.13. Next Steps
- 15.14. Request-Reply communication
- 15.15. Remote type discovery and endpoint matching
16. ROS 2 using Fast DDS middleware
Toggle navigation of 16. ROS 2 using Fast DDS middleware
- 16.1. Configuring Fast DDS in ROS 2
- 16.2. Use ROS 2 with Fast-DDS Discovery Server
17. RPC over DDS
Toggle navigation of 17. RPC over DDS
- 17.1. RPC over DDS Request-Reply API overview
  Toggle navigation of 17.1. RPC over DDS Request-Reply API overview
- 17.2. Exceptions
18. Troubleshooting
19. Frequently Asked Questions
Toggle navigation of 19. Frequently Asked Questions
20. C++ API Reference
Toggle navigation of 20. C++ API Reference
- 20.1. DDS DCPS PIM
  Toggle navigation of 20.1. DDS DCPS PIM
  - 20.1.1. Core
    Toggle navigation of 20.1.1. Core
  - 20.1.2. Domain
    Toggle navigation of 20.1.2. Domain
  - 20.1.3. Publisher
    Toggle navigation of 20.1.3. Publisher
  - 20.1.4. Subscriber
    Toggle navigation of 20.1.4. Subscriber
  - 20.1.5. Topic
    Toggle navigation of 20.1.5. Topic
  - 20.1.6. XTypes
    Toggle navigation of 20.1.6. XTypes
    - 20.1.6.1. Dynamic Language Binding
      Toggle navigation of 20.1.6.1. Dynamic Language Binding
    - 20.1.6.2. InvalidArgumentError
    - 20.1.6.3. Type Representation
      Toggle navigation of 20.1.6.3. Type Representation
      - 20.1.6.3.1. TypeObjectRegistry
      - 20.1.6.3.2. TypeObjectUtils
    - 20.1.6.4. Utils
  - 20.1.7. RPC over DDS
    Toggle navigation of 20.1.7. RPC over DDS
- 20.2. RTPS
  Toggle navigation of 20.2. RTPS
  - 20.2.1. Attributes
    Toggle navigation of 20.2.1. Attributes
  - 20.2.2. Builtin data
    Toggle navigation of 20.2.2. Builtin data
  - 20.2.3. Common
    Toggle navigation of 20.2.3. Common
    - 20.2.3.1. BinaryProperty
      Toggle navigation of 20.2.3.1. BinaryProperty
    - 20.2.3.2. CacheChange
      Toggle navigation of 20.2.3.2. CacheChange
      - 20.2.3.2.1. CacheChange_t
      - 20.2.3.2.2. ChangeKind_t
    - 20.2.3.3. CDRMessage
      Toggle navigation of 20.2.3.3. CDRMessage
      - 20.2.3.3.1. CDRMessage_t
      - 20.2.3.3.2. Macro definitions (#define)
    - 20.2.3.4. CDRSerialization
    - 20.2.3.5. EntityId
      Toggle navigation of 20.2.3.5. EntityId
    - 20.2.3.6. FragmentNumber
      Toggle navigation of 20.2.3.6. FragmentNumber
      - 20.2.3.6.1. FragmentNumber_t
      - 20.2.3.6.2. FragmentNumberSet_t
    - 20.2.3.7. Guid
      Toggle navigation of 20.2.3.7. Guid
    - 20.2.3.8. GuidPrefix
      Toggle navigation of 20.2.3.8. GuidPrefix
    - 20.2.3.9. InstanceHandle
      Toggle navigation of 20.2.3.9. InstanceHandle
    - 20.2.3.10. Locator
      Toggle navigation of 20.2.3.10. Locator
    - 20.2.3.11. LocatorSelectorEntry
    - 20.2.3.12. LocatorSelector
    - 20.2.3.13. LocatorWithMask
    - 20.2.3.14. MatchingInfo
      Toggle navigation of 20.2.3.14. MatchingInfo
      - 20.2.3.14.1. MatchingInfo
      - 20.2.3.14.2. MatchingStatus
    - 20.2.3.15. PortParameters
    - 20.2.3.16. Property
      Toggle navigation of 20.2.3.16. Property
    - 20.2.3.17. RemoteLocators
      Toggle navigation of 20.2.3.17. RemoteLocators
      - 20.2.3.17.1. RemoteLocators Operators
      - 20.2.3.17.2. RemoteLocatorList
    - 20.2.3.18. SampleIdentity
    - 20.2.3.19. SequenceNumber
      Toggle navigation of 20.2.3.19. SequenceNumber
    - 20.2.3.20. SerializedPayload
      Toggle navigation of 20.2.3.20. SerializedPayload
      - 20.2.3.20.1. Macro definitions (#define)
      - 20.2.3.20.2. SerializedPayload_t
    - 20.2.3.21. RTPS Time_t
      Toggle navigation of 20.2.3.21. RTPS Time_t
    - 20.2.3.22. Token
      Toggle navigation of 20.2.3.22. Token
    - 20.2.3.23. Types
      Toggle navigation of 20.2.3.23. Types
    - 20.2.3.24. WriteParams
  - 20.2.4. Endpoint
  - 20.2.5. Flow control
    Toggle navigation of 20.2.5. Flow control
    - 20.2.5.1. FlowControllerDescriptor
    - 20.2.5.2. FlowControllerSchedulerPolicy
  - 20.2.6. History
    Toggle navigation of 20.2.6. History
  - 20.2.7. RTPSParticipant
    Toggle navigation of 20.2.7. RTPSParticipant
    - 20.2.7.1. ParticipantDiscoveryInfo
      Toggle navigation of 20.2.7.1. ParticipantDiscoveryInfo
    - 20.2.7.2. RTPSParticipant
    - 20.2.7.3. RTPSParticipantListener
  - 20.2.8. RTPSReader
    Toggle navigation of 20.2.8. RTPSReader
    - 20.2.8.1. ReaderListener
    - 20.2.8.2. RTPSReader
  - 20.2.9. Resources
    Toggle navigation of 20.2.9. Resources
    - 20.2.9.1. MemoryManagementPolicy
  - 20.2.10. RTPSDomain
  - 20.2.11. RTPSWriter
    Toggle navigation of 20.2.11. RTPSWriter
    - 20.2.11.1. RTPSWriter
    - 20.2.11.2. WriterListener
- 20.3. Transport
  Toggle navigation of 20.3. Transport
  - 20.3.1. Transport Generic Interfaces
    Toggle navigation of 20.3.1. Transport Generic Interfaces
  - 20.3.2. Chaining of transports
    Toggle navigation of 20.3.2. Chaining of transports
    - 20.3.2.1. ChainingTransportDescriptor
    - 20.3.2.2. ChainingTransport
  - 20.3.3. UDP Transport
    Toggle navigation of 20.3.3. UDP Transport
  - 20.3.4. TCP Transport
    Toggle navigation of 20.3.4. TCP Transport
  - 20.3.5. Shared Memory Transport
    Toggle navigation of 20.3.5. Shared Memory Transport
    - 20.3.5.1. SharedMemTransportDescriptor
    - 20.3.5.2. SharedMemTransportDescriptor
- 20.4. LOG
  Toggle navigation of 20.4. LOG
- 20.5. Statistics
  Toggle navigation of 20.5. Statistics
21. Python API Reference
Toggle navigation of 21. Python API Reference
- 21.1. DDS DCPS PIM
  Toggle navigation of 21.1. DDS DCPS PIM

Fast DDS-Gen

1. Introduction
2. Usage
3. Building a publish/subscribe application
4. Building Python auxiliary libraries
5. Defining a data type via IDL

Fast DDS CLI

1. CLI

Docker Images

1. Docker Images
Toggle navigation of 1. Docker Images

Versions

Dependencies and compatibilities
Migration Guide to Fast DDS v3
Version 3.2.4 (latest)
Supported versions
Previous end-of-life versions

Toggle table of contents sidebar

21.1.4.8. SampleStateKind¶

class fastdds.READ_SAMPLE_STATE(*args: Any, **kwargs: Any)¶

class fastdds.NOT_READ_SAMPLE_STATE(*args: Any, **kwargs: Any)¶

21.1.4.9. Subscriber

21.1.4.7. SampleInfo

Copyright © 2019, eProsima

Made with Sphinx and @pradyunsg's Furo

On this page

21.1.4.8. SampleStateKind
- READ_SAMPLE_STATE
- NOT_READ_SAMPLE_STATE