Fast DDS  Version 3.1.2
Fast DDS
Loading...
Searching...
No Matches
eprosima::fastdds::dds Namespace Reference

Namespaces

namespace  builtin
 
namespace  detail
 
namespace  xtypes
 

Classes

class  AnnotationDescriptor
 
struct  BaseStatus
 A struct storing the base status. More...
 
class  Condition
 The Condition class is the root base class for all the conditions that may be attached to a WaitSet. More...
 
class  ContentFilteredTopic
 Specialization of TopicDescription that allows for content-based subscriptions. More...
 
class  DataReader
 Class DataReader, contains the actual implementation of the behaviour of the Subscriber. More...
 
class  DataReaderListener
 Class DataReaderListener, it should be used by the end user to implement specific callbacks to certain actions. More...
 
class  DataReaderQos
 Class DataReaderQos, containing all the possible Qos that can be set for a determined DataReader. More...
 
class  DataRepresentationQosPolicy
 With multiple standard data Representations available, and vendor-specific extensions possible, DataWriters and DataReaders must be able to negotiate which data representation(s) to use. More...
 
class  DataSharingQosPolicy
 Qos Policy to configure the data sharing. More...
 
class  DataWriter
 Class DataWriter, contains the actual implementation of the behaviour of the DataWriter. More...
 
class  DataWriterListener
 Class DataWriterListener, allows the end user to implement callbacks triggered by certain events. More...
 
class  DataWriterQos
 Class DataWriterQos, containing all the possible Qos that can be set for a determined DataWriter. More...
 
struct  DeadlineMissedStatus
 A struct storing the deadline status. More...
 
class  DeadlineQosPolicy
 DataReader expects a new sample updating the value of each instance at least once every deadline period. More...
 
class  DestinationOrderQosPolicy
 Controls the criteria used to determine the logical order among changes made by Publisher entities to the same instance of data (i.e., matching Topic and key). More...
 
class  DisablePositiveACKsQosPolicy
 Class DisablePositiveACKsQosPolicy to disable sending of positive ACKs. More...
 
class  DomainEntity
 The DomainEntity class is a subclass of Entity created in order to differentiate between DomainParticipants and the rest of Entities. More...
 
class  DomainParticipant
 Class DomainParticipant used to group Publishers and Subscribers into a single working unit. More...
 
class  DomainParticipantExtendedQos
 
class  DomainParticipantFactory
 Class DomainParticipantFactory. More...
 
class  DomainParticipantFactoryQos
 Class DomainParticipantFactoryQos, contains all the possible Qos that can be set for a determined participant. More...
 
class  DomainParticipantListener
 Class DomainParticipantListener, overrides behaviour towards certain events. More...
 
class  DomainParticipantQos
 Class DomainParticipantQos, contains all the possible Qos that can be set for a determined participant. More...
 
class  DurabilityQosPolicy
 This policy expresses if the data should ‘outlive’ their writing time. More...
 
class  DurabilityServiceQosPolicy
 Specifies the configuration of the durability service. More...
 
class  DynamicData
 
class  DynamicDataFactory
 
class  DynamicPubSubType
 
class  DynamicType
 
class  DynamicTypeBuilder
 
class  DynamicTypeBuilderFactory
 
class  DynamicTypeMember
 Represents a "member" of a type. More...
 
class  Entity
 The Entity class is the abstract base class for all the objects that support QoS policies, a listener and a status condition. More...
 
class  EntityFactoryQosPolicy
 Controls the behavior of the entity when acting as a factory for other entities. More...
 
class  FileConsumer
 
class  GenericDataQosPolicy
 Class GenericDataQosPolicy, base class to transmit user data during the discovery phase. More...
 
class  GuardCondition
 The GuardCondition class is a specific Condition whose trigger_value is completely under the control of the application. More...
 
class  HistoryQosPolicy
 Specifies the behavior of the Service in the case where the value of a sample changes (one or more times) before it can be successfully communicated to one or more existing subscribers. More...
 
struct  IContentFilter
 The interface that content filter objects should implement. More...
 
struct  IContentFilterFactory
 The interface that a factory of IContentFilter objects should implement. More...
 
struct  IncompatibleQosStatus
 A struct storing the requested incompatible QoS status. More...
 
class  LatencyBudgetQosPolicy
 Specifies the maximum acceptable delay from the time the data is written until the data is inserted in the receiver's application-cache and the receiving application is notified of the fact.This policy is a hint to the Service, not something that must be monitored or enforced. More...
 
class  LifespanQosPolicy
 Specifies the maximum duration of validity of the data written by the DataWriter. More...
 
struct  LivelinessChangedStatus
 A struct storing the liveliness changed status. More...
 
class  LivelinessQosPolicy
 Determines the mechanism and parameters used by the application to determine whether an Entity is “active” (alive). More...
 
struct  LoanableArray
 A type-safe, ordered collection of elements allocated on the stack, which can be loaned to a LoanableCollection. More...
 
class  LoanableCollection
 A collection of generic opaque pointers that can receive the buffer from outside (loan). More...
 
class  LoanableSequence
 A type-safe, ordered collection of elements that can receive the buffer from outside (loan). More...
 
class  LoanableTypedCollection
 A type-safe accessible collection of generic opaque pointers that can receive the buffer from outside (loan). More...
 
class  Log
 Logging utilities. More...
 
class  LogConsumer
 Consumes a log entry to output it somewhere. More...
 
struct  MatchedStatus
 A structure storing a matching status. More...
 
class  MemberDescriptor
 
struct  object_traits
 
class  OStreamConsumer
 
class  OwnershipQosPolicy
 Specifies whether it is allowed for multiple DataWriters to write the same instance of the data and if so, how these modifications should be arbitrated. More...
 
class  OwnershipStrengthQosPolicy
 Specifies the value of the “strength” used to arbitrate among multiple DataWriter objects that attempt to modify the same instance of a data-object (identified by Topic + key).This policy only applies if the OWNERSHIP QoS policy is of kind EXCLUSIVE. More...
 
class  Parameter_t
 Base Parameter class with parameter PID and parameter length in bytes. More...
 
class  ParameterBool_t
 
class  ParameterBuiltinEndpointSet_t
 
class  ParameterCount_t
 
class  ParameterDomainId_t
 
class  ParameterEntityId_t
 
class  ParameterGuid_t
 
class  ParameterIP4Address_t
 
class  ParameterKey_t
 
class  ParameterLocator_t
 
class  ParameterNetworkConfigSet_t
 
class  ParameterPort_t
 
class  ParameterProductVersion_t
 
class  ParameterProperty_t
 
class  ParameterPropertyList_t
 
class  ParameterProtocolVersion_t
 
class  ParameterSampleIdentity_t
 
class  ParameterStatusInfo_t
 
class  ParameterString_t
 
class  ParameterTime_t
 
class  ParameterVendorId_t
 
class  Partition_t
 
class  PartitionQosPolicy
 Set of strings that introduces a logical partition among the topics visible by the Publisher and Subscriber. More...
 
class  PresentationQosPolicy
 Specifies how the samples representing changes to data instances are presented to the subscribing application. More...
 
struct  PublicationMatchedStatus
 A structure storing the publication status. More...
 
class  Publisher
 Class Publisher, used to send data to associated subscribers. More...
 
class  PublisherListener
 Class PublisherListener, allows the end user to implement callbacks triggered by certain events. More...
 
class  PublisherQos
 Class PublisherQos, containing all the possible Qos that can be set for a determined Publisher. More...
 
class  PublishModeQosPolicy
 Class PublishModeQosPolicy, defines the publication mode for a specific writer. More...
 
class  QosPolicy
 Class QosPolicy, base for all QoS policies defined for Writers and Readers. More...
 
struct  QosPolicyCount
 A struct storing the id of the incompatible QoS Policy and the number of times it fails. More...
 
class  ReadCondition
 A Condition specifically dedicated to read operations and attached to one DataReader. More...
 
class  ReaderDataLifecycleQosPolicy
 Specifies the behavior of the DataReader with regards to the lifecycle of the data-instances it manages. More...
 
class  ReaderQos
 Class ReaderQos, contains all the possible Qos that can be set for a determined Subscriber. More...
 
class  ReaderResourceLimitsQos
 Qos Policy to configure the limit of the reader resources. More...
 
class  ReliabilityQosPolicy
 Indicates the reliability of the endpoint. More...
 
class  ReplierQos
 
class  RequesterQos
 
class  ResourceLimitsQosPolicy
 Specifies the resources that the Service can consume in order to meet the requested QoS. More...
 
class  RTPSEndpointQos
 Qos Policy to configure the endpoint. More...
 
class  RTPSReliableReaderQos
 Qos Policy to configure the DisablePositiveACKsQos and the reader attributes. More...
 
class  RTPSReliableWriterQos
 Qos Policy to configure the DisablePositiveACKsQos and the writer timing attributes. More...
 
struct  SampleInfo
 SampleInfo is the information that accompanies each sample that is ‘read’ or ‘taken. More...
 
struct  SampleRejectedStatus
 A struct storing the sample rejected status. More...
 
struct  StackAllocatedSequence
 A type-safe, ordered collection of elements allocated on the stack. More...
 
class  StatusCondition
 The StatusCondition class is a specific Condition that is associated with each Entity. More...
 
class  StatusMask
 StatusMask is a bitmap or bitset field. More...
 
class  StdoutConsumer
 
class  StdoutErrConsumer
 
class  Subscriber
 Class Subscriber, contains the public API that allows the user to control the reception of messages. More...
 
class  SubscriberListener
 Class SubscriberListener, it should be used by the end user to implement specific callbacks to certain actions. More...
 
class  SubscriberQos
 Class SubscriberQos, contains all the possible Qos that can be set for a determined Subscriber. More...
 
struct  SubscriptionMatchedStatus
 A structure storing the subscription status. More...
 
struct  Time_t
 Structure Time_t, used to describe times at a DDS level. More...
 
class  TimeBasedFilterQosPolicy
 Filter that allows a DataReader to specify that it is interested only in (potentially) a subset of the values of the data. More...
 
class  Topic
 Class Topic, represents the fact that both publications and subscriptions are tied to a single data-type. More...
 
class  TopicDataType
 Class TopicDataType used to provide the DomainRTPSParticipant with the methods to serialize, deserialize and get the key of a specific data type. More...
 
class  TopicDescription
 Class TopicDescription, represents the fact that both publications and subscriptions are tied to a single data-type. More...
 
class  TopicListener
 Class TopicListener, it should be used by the end user to implement specific callbacks to certain actions. More...
 
class  TopicQos
 Class TopicQos, containing all the possible Qos that can be set for a determined Topic. More...
 
struct  traits
 
struct  traits< DynamicData >
 
struct  traits< DynamicDataFactory >
 
struct  traits< DynamicType >
 
struct  traits< DynamicTypeBuilder >
 
struct  traits< DynamicTypeBuilderFactory >
 
struct  traits< DynamicTypeMember >
 
class  TransportConfigQos
 Qos Policy to configure the transport layer. More...
 
class  TransportPriorityQosPolicy
 This policy is a hint to the infrastructure as to how to set the priority of the underlying transport used to send the data. More...
 
class  TypeConsistencyEnforcementQosPolicy
 The TypeConsistencyEnforcementQosPolicy defines the rules for determining whether the type used to publish a given data stream is consistent with that used to subscribe to it. More...
 
class  TypeDescriptor
 TypeDescriptor definition according to [standard] section 7.5.2.4. More...
 
class  TypeIdV1
 Class TypeIdV1. More...
 
class  TypeObjectV1
 Class TypeObjectV1. More...
 
class  TypeSupport
 Class TypeSupport used to provide the DomainRTPSParticipant with the methods to serialize, deserialize and get the key of a specific data type. The user should created a class that inherits from this one, where Serialize and deserialize methods MUST be implemented. More...
 
struct  UserAllocatedSequence
 A collection of generic opaque pointers allocated by the user. More...
 
class  VerbatimTextDescriptor
 
class  WaitSet
 The WaitSet class allows an application to wait until one or more of the attached Condition objects has a trigger_value of TRUE or until timeout expires. More...
 
class  WireProtocolConfigQos
 Qos Policy that configures the wire protocol. More...
 
class  WriterDataLifecycleQosPolicy
 Specifies the behavior of the DataWriter with regards to the lifecycle of the data-instances it manages. More...
 
class  WriterQos
 Class WriterQos, containing all the possible Qos that can be set for a determined Publisher. More...
 
class  WriterResourceLimitsQos
 Qos Policy to configure the limit of the writer resources. More...
 

Typedefs

using BuiltinTopicKey_t = rtps::BuiltinTopicKey_t
 
using ParticipantBuiltinTopicData = rtps::ParticipantBuiltinTopicData
 
using PublicationBuiltinTopicData = rtps::PublicationBuiltinTopicData
 
using SubscriptionBuiltinTopicData = rtps::SubscriptionBuiltinTopicData
 
using InstanceHandle_t = eprosima::fastdds::rtps::InstanceHandle_t
 
using ConditionSeq = std::vector< Condition * >
 
typedef int32_t ReturnCode_t
 
using PolicyMask = std::bitset< NEXT_QOS_POLICY_ID >
 
typedef enum eprosima::fastdds::dds::DurabilityQosPolicyKind DurabilityQosPolicyKind_t
 Enum DurabilityQosPolicyKind_t, different kinds of durability for DurabilityQosPolicy.
 
typedef enum eprosima::fastdds::dds::LivelinessQosPolicyKind LivelinessQosPolicyKind
 Enum LivelinessQosPolicyKind, different kinds of liveliness for LivelinessQosPolicy.
 
typedef enum eprosima::fastdds::dds::ReliabilityQosPolicyKind ReliabilityQosPolicyKind
 Enum ReliabilityQosPolicyKind, different kinds of reliability for ReliabilityQosPolicy.
 
typedef enum eprosima::fastdds::dds::PublishModeQosPolicyKind PublishModeQosPolicyKind_t
 Enum PublishModeQosPolicyKind, different kinds of publication synchronism.
 
typedef enum eprosima::fastdds::dds::DataRepresentationId DataRepresentationId_t
 Enum DataRepresentationId, different kinds of topic data representation.
 
using ParticipantResourceLimitsQos = fastdds::rtps::RTPSParticipantAllocationAttributes
 Holds allocation limits affecting collections managed by a participant.
 
using PropertyPolicyQos = fastdds::rtps::PropertyPolicy
 Property policies.
 
using SampleLostStatus = BaseStatus
 Alias of BaseStatus.
 
using LivelinessLostStatus = BaseStatus
 Alias of BaseStatus.
 
using InconsistentTopicStatus = BaseStatus
 Alias of BaseStatus.
 
typedef DeadlineMissedStatus OfferedDeadlineMissedStatus
 Typedef of DeadlineMissedStatus.
 
typedef DeadlineMissedStatus RequestedDeadlineMissedStatus
 Typedef of DeadlineMissedStatus.
 
using QosPolicyCountSeq = std::vector< QosPolicyCount >
 Alias of std::vector<QosPolicyCount>
 
using RequestedIncompatibleQosStatus = IncompatibleQosStatus
 Alias of IncompatibleQosStatus.
 
using OfferedIncompatibleQosStatus = IncompatibleQosStatus
 Alias of IncompatibleQosStatus.
 
using Duration_t = Time_t
 
typedef uint32_t DomainId_t
 
using SampleInfoSeq = LoanableSequence< SampleInfo >
 
using InstanceStateMask = uint16_t
 A bit-mask (list) of instance states, i.e. InstanceStateKind.
 
using SampleStateMask = uint16_t
 A bit-mask (list) of sample states, i.e. SampleStateKind.
 
using ViewStateMask = uint16_t
 A bit-mask (list) of view states, i.e. ViewStateKind.
 
typedef std::vector< std::string > IncludePathSeq
 
typedef eprosima::fastcdr::fixed_string< 256 > ObjectName
 
typedef std::vector< uint32_t > BoundSeq
 
typedef uint8_t TypeKind
 
typedef std::map< ObjectName, ObjectNameParameters
 
typedef uint32_t MemberId
 
typedef std::vector< int32_t > UnionCaseLabelSeq
 
typedef std::vector< int32_t > Int32Seq
 
typedef std::vector< uint32_t > UInt32Seq
 
typedef std::vector< int8_t > Int8Seq
 
typedef std::vector< uint8_t > UInt8Seq
 
typedef std::vector< int16_t > Int16Seq
 
typedef std::vector< uint16_t > UInt16Seq
 
typedef std::vector< int64_t > Int64Seq
 
typedef std::vector< uint64_t > UInt64Seq
 
typedef std::vector< float > Float32Seq
 
typedef std::vector< double > Float64Seq
 
typedef std::vector< long double > Float128Seq
 
typedef std::vector< char > CharSeq
 
typedef std::vector< wchar_t > WcharSeq
 
typedef std::vector< bool > BooleanSeq
 
typedef std::vector< uint8_t > ByteSeq
 
typedef std::vector< std::string > StringSeq
 
typedef std::vector< std::wstring > WstringSeq
 
typedef std::map< ObjectName, traits< DynamicTypeMember >::ref_type > DynamicTypeMembersByName
 
typedef std::map< MemberId, traits< DynamicTypeMember >::ref_type > DynamicTypeMembersById
 

Enumerations

enum  ParameterId_t : uint16_t {
  PID_PAD = 0x0000 , PID_SENTINEL = 0x0001 , PID_USER_DATA = 0x002c , PID_TOPIC_NAME = 0x0005 ,
  PID_TYPE_NAME = 0x0007 , PID_GROUP_DATA = 0x002d , PID_TOPIC_DATA = 0x002e , PID_DURABILITY = 0x001d ,
  PID_DURABILITY_SERVICE = 0x001e , PID_DEADLINE = 0x0023 , PID_LATENCY_BUDGET = 0x0027 , PID_LIVELINESS = 0x001b ,
  PID_RELIABILITY = 0x001a , PID_LIFESPAN = 0x002b , PID_DESTINATION_ORDER = 0x0025 , PID_HISTORY = 0x0040 ,
  PID_RESOURCE_LIMITS = 0x0041 , PID_OWNERSHIP = 0x001f , PID_OWNERSHIP_STRENGTH = 0x0006 , PID_PRESENTATION = 0x0021 ,
  PID_PARTITION = 0x0029 , PID_TIME_BASED_FILTER = 0x0004 , PID_TRANSPORT_PRIORITY = 0x0049 , PID_DOMAIN_ID = 0x000f ,
  PID_DOMAIN_TAG = 0x4014 , PID_PROTOCOL_VERSION = 0x0015 , PID_VENDORID = 0x0016 , PID_UNICAST_LOCATOR = 0x002f ,
  PID_MULTICAST_LOCATOR = 0x0030 , PID_DEFAULT_UNICAST_LOCATOR = 0x0031 , PID_DEFAULT_MULTICAST_LOCATOR = 0x0048 , PID_METATRAFFIC_UNICAST_LOCATOR = 0x0032 ,
  PID_METATRAFFIC_MULTICAST_LOCATOR = 0x0033 , PID_EXPECTS_INLINE_QOS = 0x0043 , PID_PARTICIPANT_MANUAL_LIVELINESS_COUNT = 0x0034 , PID_PARTICIPANT_LEASE_DURATION = 0x0002 ,
  PID_CONTENT_FILTER_PROPERTY = 0x0035 , PID_PARTICIPANT_GUID = 0x0050 , PID_GROUP_GUID = 0x0052 , PID_GROUP_ENTITYID = 0x0053 ,
  PID_BUILTIN_ENDPOINT_SET = 0x0058 , PID_BUILTIN_ENDPOINT_QOS = 0x0077 , PID_PROPERTY_LIST = 0x0059 , PID_TYPE_MAX_SIZE_SERIALIZED = 0x0060 ,
  PID_ENTITY_NAME = 0x0062 , PID_ENDPOINT_GUID = 0x005a , PID_CONTENT_FILTER_INFO = 0x0055 , PID_COHERENT_SET = 0x0056 ,
  PID_DIRECTED_WRITE = 0x0057 , PID_ORIGINAL_WRITER_INFO = 0x0061 , PID_GROUP_COHERENT_SET = 0x0063 , PID_GROUP_SEQ_NUM = 0x0064 ,
  PID_WRITER_GROUP_INFO = 0x0065 , PID_SECURE_WRITER_GROUP_INFO = 0x0066 , PID_KEY_HASH = 0x0070 , PID_STATUS_INFO = 0x0071 ,
  PID_TYPE_IDV1 = 0x0069 , PID_TYPE_OBJECTV1 = 0x0072 , PID_DATA_REPRESENTATION = 0x0073 , PID_TYPE_CONSISTENCY_ENFORCEMENT = 0x0074 ,
  PID_TYPE_INFORMATION = 0x0075 , PID_IDENTITY_TOKEN = 0x1001 , PID_PERMISSIONS_TOKEN = 0x1002 , PID_PARTICIPANT_SECURITY_INFO = 0x1005 ,
  PID_ENDPOINT_SECURITY_INFO = 0x1004 , PID_IDENTITY_STATUS_TOKEN = 0x1006 , PID_DATA_TAGS = 0x1003 , PID_SERVICE_INSTANCE_NAME = 0x0080 ,
  PID_RELATED_ENTITY_GUID = 0x0081 , PID_TOPIC_ALIASES = 0x0082 , PID_RELATED_SAMPLE_IDENTITY = 0x0083 , PID_PRODUCT_VERSION = 0x8000 ,
  PID_PERSISTENCE_GUID = 0x8002 , PID_DISABLE_POSITIVE_ACKS = 0x8005 , PID_DATASHARING = 0x8006 , PID_NETWORK_CONFIGURATION_SET = 0x8007 ,
  PID_CUSTOM_RELATED_SAMPLE_IDENTITY = 0x800f
}
 Enum for the unique parameter identifier. More...
 
enum  QosPolicyId_t : uint32_t {
  INVALID_QOS_POLICY_ID = 0 , USERDATA_QOS_POLICY_ID = 1 , DURABILITY_QOS_POLICY_ID = 2 , PRESENTATION_QOS_POLICY_ID = 3 ,
  DEADLINE_QOS_POLICY_ID = 4 , LATENCYBUDGET_QOS_POLICY_ID = 5 , OWNERSHIP_QOS_POLICY_ID = 6 , OWNERSHIPSTRENGTH_QOS_POLICY_ID = 7 ,
  LIVELINESS_QOS_POLICY_ID = 8 , TIMEBASEDFILTER_QOS_POLICY_ID = 9 , PARTITION_QOS_POLICY_ID = 10 , RELIABILITY_QOS_POLICY_ID = 11 ,
  DESTINATIONORDER_QOS_POLICY_ID = 12 , HISTORY_QOS_POLICY_ID = 13 , RESOURCELIMITS_QOS_POLICY_ID = 14 , ENTITYFACTORY_QOS_POLICY_ID = 15 ,
  WRITERDATALIFECYCLE_QOS_POLICY_ID = 16 , READERDATALIFECYCLE_QOS_POLICY_ID = 17 , TOPICDATA_QOS_POLICY_ID = 18 , GROUPDATA_QOS_POLICY_ID = 19 ,
  TRANSPORTPRIORITY_QOS_POLICY_ID = 20 , LIFESPAN_QOS_POLICY_ID = 21 , DURABILITYSERVICE_QOS_POLICY_ID = 22 , DATAREPRESENTATION_QOS_POLICY_ID = 23 ,
  TYPECONSISTENCYENFORCEMENT_QOS_POLICY_ID = 24 , DISABLEPOSITIVEACKS_QOS_POLICY_ID = 25 , PARTICIPANTRESOURCELIMITS_QOS_POLICY_ID = 26 , PROPERTYPOLICY_QOS_POLICY_ID = 27 ,
  PUBLISHMODE_QOS_POLICY_ID = 28 , READERRESOURCELIMITS_QOS_POLICY_ID = 29 , RTPSENDPOINT_QOS_POLICY_ID = 30 , RTPSRELIABLEREADER_QOS_POLICY_ID = 31 ,
  RTPSRELIABLEWRITER_QOS_POLICY_ID = 32 , TRANSPORTCONFIG_QOS_POLICY_ID = 33 , TYPECONSISTENCY_QOS_POLICY_ID = 34 , WIREPROTOCOLCONFIG_QOS_POLICY_ID = 35 ,
  WRITERRESOURCELIMITS_QOS_POLICY_ID = 36 , NEXT_QOS_POLICY_ID
}
 The identifier for each QosPolicy. More...
 
enum  DurabilityQosPolicyKind : fastdds::rtps::octet { VOLATILE_DURABILITY_QOS , TRANSIENT_LOCAL_DURABILITY_QOS , TRANSIENT_DURABILITY_QOS , PERSISTENT_DURABILITY_QOS }
 Enum DurabilityQosPolicyKind_t, different kinds of durability for DurabilityQosPolicy. More...
 
enum  LivelinessQosPolicyKind : fastdds::rtps::octet { AUTOMATIC_LIVELINESS_QOS , MANUAL_BY_PARTICIPANT_LIVELINESS_QOS , MANUAL_BY_TOPIC_LIVELINESS_QOS }
 Enum LivelinessQosPolicyKind, different kinds of liveliness for LivelinessQosPolicy. More...
 
enum  ReliabilityQosPolicyKind : fastdds::rtps::octet { BEST_EFFORT_RELIABILITY_QOS = 0x01 , RELIABLE_RELIABILITY_QOS = 0x02 }
 Enum ReliabilityQosPolicyKind, different kinds of reliability for ReliabilityQosPolicy. More...
 
enum  OwnershipQosPolicyKind : fastdds::rtps::octet { SHARED_OWNERSHIP_QOS , EXCLUSIVE_OWNERSHIP_QOS }
 Enum OwnershipQosPolicyKind, different kinds of ownership for OwnershipQosPolicy. More...
 
enum  DestinationOrderQosPolicyKind : fastdds::rtps::octet { BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS , BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS }
 Enum DestinationOrderQosPolicyKind, different kinds of destination order for DestinationOrderQosPolicy. More...
 
enum  PresentationQosPolicyAccessScopeKind : fastdds::rtps::octet { INSTANCE_PRESENTATION_QOS , TOPIC_PRESENTATION_QOS , GROUP_PRESENTATION_QOS }
 Enum PresentationQosPolicyAccessScopeKind, different kinds of Presentation Policy order for PresentationQosPolicy. More...
 
enum  HistoryQosPolicyKind : fastdds::rtps::octet { KEEP_LAST_HISTORY_QOS , KEEP_ALL_HISTORY_QOS }
 Enum HistoryQosPolicyKind, different kinds of History Qos for HistoryQosPolicy. More...
 
enum  PublishModeQosPolicyKind : fastdds::rtps::octet { SYNCHRONOUS_PUBLISH_MODE , ASYNCHRONOUS_PUBLISH_MODE }
 Enum PublishModeQosPolicyKind, different kinds of publication synchronism. More...
 
enum  DataRepresentationId : int16_t { XCDR_DATA_REPRESENTATION = 0 , XML_DATA_REPRESENTATION = 1 , XCDR2_DATA_REPRESENTATION = 2 }
 Enum DataRepresentationId, different kinds of topic data representation. More...
 
enum  TypeConsistencyKind : uint16_t { DISALLOW_TYPE_COERCION , ALLOW_TYPE_COERCION }
 
enum  DataSharingKind : fastdds::rtps::octet { AUTO = 0x01 , ON = 0x02 , OFF = 0x03 }
 Data sharing configuration kinds. More...
 
enum  SampleRejectedStatusKind { NOT_REJECTED , REJECTED_BY_INSTANCES_LIMIT , REJECTED_BY_SAMPLES_LIMIT , REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT }
 An enum with the possible values for the sample rejected reason. More...
 
enum  InstanceStateKind : uint16_t { ALIVE_INSTANCE_STATE = 0x0001 << 0 , NOT_ALIVE_DISPOSED_INSTANCE_STATE = 0x0001 << 1 , NOT_ALIVE_NO_WRITERS_INSTANCE_STATE = 0x0001 << 2 }
 Indicates if the samples are from an alive eprosima::fastdds::dds::DataWriter or not. More...
 
enum  SampleStateKind : uint16_t { READ_SAMPLE_STATE = 0x0001 << 0 , NOT_READ_SAMPLE_STATE = 0x0001 << 1 }
 Indicates whether or not a sample has ever been read. More...
 
enum  ViewStateKind : uint16_t { NEW_VIEW_STATE = 0x0001 << 0 , NOT_NEW_VIEW_STATE = 0x0001 << 1 }
 Indicates whether or not an instance is new. More...
 
enum class  ExtensibilityKind : int32_t { FINAL , APPENDABLE , MUTABLE }
 This class represents the enumeration ExtensibilityKind defined by the user in the IDL file. More...
 
enum class  TryConstructKind : int32_t { USE_DEFAULT , DISCARD , TRIM }
 This class represents the enumeration TryConstructKind defined by the user in the IDL file. More...
 
enum class  DynamicDataJsonFormat { OMG , EPROSIMA }
 

Functions

template<class T , class PL >
void set_proxy_property (const T &p, const char *PID, PL &properties)
 
template<class T , class PL >
get_proxy_property (const char *const PID, PL &properties)
 
static bool operator== (const Time_t &t1, const Time_t &t2)
 Comparison assignment.
 
static bool operator!= (const Time_t &t1, const Time_t &t2)
 Comparison assignment.
 
static bool operator< (const Time_t &t1, const Time_t &t2)
 Checks if a Time_t is less than other.
 
static bool operator> (const Time_t &t1, const Time_t &t2)
 Checks if a Time_t is greater than other.
 
static bool operator<= (const Time_t &t1, const Time_t &t2)
 Checks if a Time_t is less or equal than other.
 
static bool operator>= (const Time_t &t1, const Time_t &t2)
 Checks if a Time_t is greater or equal than other.
 
std::ostream & operator<< (std::ostream &output, const Time_t &t)
 
static Time_t operator+ (const Time_t &ta, const Time_t &tb)
 Adds two Time_t.
 
static Time_t operator- (const Time_t &ta, const Time_t &tb)
 Subtracts two Time_t.
 
std::ostream & operator<< (std::ostream &output, const Log::Kind &kind)
 Streams Log::Kind serialization.
 
FASTDDS_EXPORTED_API ReturnCode_t idl_serialize (const DynamicType::_ref_type &dynamic_type, std::ostream &output) noexcept
 Serializes a DynamicType into its IDL representation.
 
FASTDDS_EXPORTED_API ReturnCode_t json_serialize (const DynamicData::_ref_type &data, DynamicDataJsonFormat format, std::ostream &output) noexcept
 Serializes a DynamicData into a JSON object, which is then dumped into an std::ostream.
 

Variables

FASTDDS_EXPORTED_API const InstanceHandle_t HANDLE_NIL
 
const ReturnCode_t RETCODE_OK = 0
 
const ReturnCode_t RETCODE_ERROR = 1
 
const ReturnCode_t RETCODE_UNSUPPORTED = 2
 
const ReturnCode_t RETCODE_BAD_PARAMETER = 3
 
const ReturnCode_t RETCODE_PRECONDITION_NOT_MET = 4
 
const ReturnCode_t RETCODE_OUT_OF_RESOURCES = 5
 
const ReturnCode_t RETCODE_NOT_ENABLED = 6
 
const ReturnCode_t RETCODE_IMMUTABLE_POLICY = 7
 
const ReturnCode_t RETCODE_INCONSISTENT_POLICY = 8
 
const ReturnCode_t RETCODE_ALREADY_DELETED = 9
 
const ReturnCode_t RETCODE_TIMEOUT = 10
 
const ReturnCode_t RETCODE_NO_DATA = 11
 
const ReturnCode_t RETCODE_ILLEGAL_OPERATION = 12
 
const ReturnCode_t RETCODE_NOT_ALLOWED_BY_SECURITY = 1000
 
const std::string parameter_property_persistence_guid = "PID_PERSISTENCE_GUID"
 Parameter property ID for persistence GUID.
 
const std::string parameter_property_participant_type = "PARTICIPANT_TYPE"
 Parameter property ID for participant type.
 
const std::string parameter_property_ds_version = "DS_VERSION"
 Parameter property ID for Discovery Server version.
 
const std::string parameter_property_current_ds_version = "2.0"
 Parameter property value for Discovery Server version.
 
const char *const parameter_policy_physical_data_host = "fastdds.physical_data.host"
 Parameter property value for Host physical data.
 
const char *const parameter_policy_physical_data_user = "fastdds.physical_data.user"
 Parameter property value for User physical data.
 
const char *const parameter_policy_physical_data_process = "fastdds.physical_data.process"
 Parameter property value for Process physical data.
 
const char *const parameter_enable_monitor_service = "fastdds.enable_monitor_service"
 Parameter property value for enabling the monitor service.
 
const char *const parameter_policy_type_propagation = "fastdds.type_propagation"
 Parameter property value for configuring type propagation.
 
constexpr DataRepresentationId_t DEFAULT_DATA_REPRESENTATION {DataRepresentationId_t::XCDR_DATA_REPRESENTATION}
 Default DataRepresentationId used in Fast DDS.
 
const Time_t c_TimeInfinite {Time_t::INFINITE_SECONDS, Time_t::INFINITE_NANOSECONDS}
 Time_t (dds::Duration_t) representing an infinite time. DONT USE IT IN CONSTRUCTORS.
 
const Time_t c_TimeZero {0, 0}
 Time_t (dds::Duration_t) representing a zero time. DONT USE IT IN CONSTRUCTORS.
 
const Time_t c_TimeInvalid {-1, Time_t::INFINITE_NANOSECONDS}
 Time_t (dds::Duration_t) representing an invalid time. DONT USE IT IN CONSTRUCTORS.
 
const DomainId_t DOMAIN_ID_UNKNOWN = 0xFFFFFFFF
 
const int32_t LENGTH_UNLIMITED = -1
 
FASTDDS_EXPORTED_API const DomainParticipantFactoryQos PARTICIPANT_FACTORY_QOS_DEFAULT
 
FASTDDS_EXPORTED_API const DomainParticipantQos PARTICIPANT_QOS_DEFAULT
 
FASTDDS_EXPORTED_API const DataWriterQos DATAWRITER_QOS_DEFAULT
 
FASTDDS_EXPORTED_API const DataWriterQos DATAWRITER_QOS_USE_TOPIC_QOS
 
FASTDDS_EXPORTED_API const PublisherQos PUBLISHER_QOS_DEFAULT
 
constexpr InstanceStateMask NOT_ALIVE_INSTANCE_STATE
 Not alive instance state.
 
constexpr InstanceStateMask ANY_INSTANCE_STATE = ALIVE_INSTANCE_STATE | NOT_ALIVE_INSTANCE_STATE
 Any instance state.
 
FASTDDS_EXPORTED_API const DataReaderQos DATAREADER_QOS_DEFAULT
 
FASTDDS_EXPORTED_API const DataReaderQos DATAREADER_QOS_USE_TOPIC_QOS
 
FASTDDS_EXPORTED_API const SubscriberQos SUBSCRIBER_QOS_DEFAULT
 
constexpr SampleStateMask ANY_SAMPLE_STATE = READ_SAMPLE_STATE | NOT_READ_SAMPLE_STATE
 Any sample state.
 
constexpr ViewStateMask ANY_VIEW_STATE = NEW_VIEW_STATE | NOT_NEW_VIEW_STATE
 Any view state.
 
constexpr const char *const sqlfilter_name = "DDSSQL"
 
FASTDDS_EXPORTED_API const TopicQos TOPIC_QOS_DEFAULT
 
const TypeKind TK_NONE = 0x00
 
const TypeKind TK_BOOLEAN = 0x01
 
const TypeKind TK_BYTE = 0x02
 
const TypeKind TK_INT16 = 0x03
 
const TypeKind TK_INT32 = 0x04
 
const TypeKind TK_INT64 = 0x05
 
const TypeKind TK_UINT16 = 0x06
 
const TypeKind TK_UINT32 = 0x07
 
const TypeKind TK_UINT64 = 0x08
 
const TypeKind TK_FLOAT32 = 0x09
 
const TypeKind TK_FLOAT64 = 0x0A
 
const TypeKind TK_FLOAT128 = 0x0B
 
const TypeKind TK_INT8 = 0x0C
 
const TypeKind TK_UINT8 = 0x0D
 
const TypeKind TK_CHAR8 = 0x10
 
const TypeKind TK_CHAR16 = 0x11
 
const TypeKind TK_STRING8 = 0x20
 
const TypeKind TK_STRING16 = 0x21
 
const TypeKind TK_ALIAS = 0x30
 
const TypeKind TK_ENUM = 0x40
 
const TypeKind TK_BITMASK = 0x41
 
const TypeKind TK_ANNOTATION = 0x50
 
const TypeKind TK_STRUCTURE = 0x51
 
const TypeKind TK_UNION = 0x52
 
const TypeKind TK_BITSET = 0x53
 
const TypeKind TK_SEQUENCE = 0x60
 
const TypeKind TK_ARRAY = 0x61
 
const TypeKind TK_MAP = 0x62
 
constexpr MemberId MEMBER_ID_INVALID {0x0FFFFFFF}
 

Typedef Documentation

◆ BooleanSeq

typedef std::vector<bool> BooleanSeq

◆ BoundSeq

typedef std::vector<uint32_t> BoundSeq

◆ BuiltinTopicKey_t

◆ ByteSeq

typedef std::vector<uint8_t> ByteSeq

◆ CharSeq

typedef std::vector<char> CharSeq

◆ ConditionSeq

using ConditionSeq = std::vector<Condition*>

◆ DataRepresentationId_t

Enum DataRepresentationId, different kinds of topic data representation.

◆ DomainId_t

typedef uint32_t DomainId_t

◆ DurabilityQosPolicyKind_t

Enum DurabilityQosPolicyKind_t, different kinds of durability for DurabilityQosPolicy.

◆ Duration_t

using Duration_t = Time_t

◆ DynamicTypeMembersById

◆ DynamicTypeMembersByName

◆ Float128Seq

typedef std::vector<long double> Float128Seq

◆ Float32Seq

typedef std::vector<float> Float32Seq

◆ Float64Seq

typedef std::vector<double> Float64Seq

◆ IncludePathSeq

typedef std::vector<std::string> IncludePathSeq

◆ InconsistentTopicStatus

◆ InstanceHandle_t

◆ InstanceStateMask

using InstanceStateMask = uint16_t

A bit-mask (list) of instance states, i.e. InstanceStateKind.

◆ Int16Seq

typedef std::vector<int16_t> Int16Seq

◆ Int32Seq

typedef std::vector<int32_t> Int32Seq

◆ Int64Seq

typedef std::vector<int64_t> Int64Seq

◆ Int8Seq

typedef std::vector<int8_t> Int8Seq

◆ LivelinessLostStatus

◆ LivelinessQosPolicyKind

Enum LivelinessQosPolicyKind, different kinds of liveliness for LivelinessQosPolicy.

◆ MemberId

typedef uint32_t MemberId

◆ ObjectName

typedef eprosima::fastcdr::fixed_string<256> ObjectName

◆ OfferedDeadlineMissedStatus

◆ OfferedIncompatibleQosStatus

◆ Parameters

typedef std::map<ObjectName, ObjectName> Parameters

◆ ParticipantBuiltinTopicData

◆ ParticipantResourceLimitsQos

Holds allocation limits affecting collections managed by a participant.

◆ PolicyMask

using PolicyMask = std::bitset<NEXT_QOS_POLICY_ID>

◆ PropertyPolicyQos

◆ PublicationBuiltinTopicData

◆ PublishModeQosPolicyKind_t

Enum PublishModeQosPolicyKind, different kinds of publication synchronism.

◆ QosPolicyCountSeq

using QosPolicyCountSeq = std::vector<QosPolicyCount>

Alias of std::vector<QosPolicyCount>

◆ ReliabilityQosPolicyKind

Enum ReliabilityQosPolicyKind, different kinds of reliability for ReliabilityQosPolicy.

◆ RequestedDeadlineMissedStatus

◆ RequestedIncompatibleQosStatus

◆ ReturnCode_t

typedef int32_t ReturnCode_t

◆ SampleInfoSeq

◆ SampleLostStatus

◆ SampleStateMask

using SampleStateMask = uint16_t

A bit-mask (list) of sample states, i.e. SampleStateKind.

◆ StringSeq

typedef std::vector<std::string> StringSeq

◆ SubscriptionBuiltinTopicData

◆ TypeKind

typedef uint8_t TypeKind

◆ UInt16Seq

typedef std::vector<uint16_t> UInt16Seq

◆ UInt32Seq

typedef std::vector<uint32_t> UInt32Seq

◆ UInt64Seq

typedef std::vector<uint64_t> UInt64Seq

◆ UInt8Seq

typedef std::vector<uint8_t> UInt8Seq

◆ UnionCaseLabelSeq

typedef std::vector<int32_t> UnionCaseLabelSeq

◆ ViewStateMask

using ViewStateMask = uint16_t

A bit-mask (list) of view states, i.e. ViewStateKind.

◆ WcharSeq

typedef std::vector<wchar_t> WcharSeq

◆ WstringSeq

typedef std::vector<std::wstring> WstringSeq

Enumeration Type Documentation

◆ DataRepresentationId

enum DataRepresentationId : int16_t

Enum DataRepresentationId, different kinds of topic data representation.

Enumerator
XCDR_DATA_REPRESENTATION 

Extended CDR Encoding version 1.

XML_DATA_REPRESENTATION 

XML Data Representation (Unsupported)

XCDR2_DATA_REPRESENTATION 

Extended CDR Encoding version 2.

◆ DataSharingKind

Data sharing configuration kinds.

Enumerator
AUTO 

Automatic configuration.

DataSharing will be used if requirements are met.

ON 

Activate the use of DataSharing.

Entity creation will fail if requirements for DataSharing are not met

OFF 

Disable the use of DataSharing.

◆ DestinationOrderQosPolicyKind

Enum DestinationOrderQosPolicyKind, different kinds of destination order for DestinationOrderQosPolicy.

Enumerator
BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS 

Indicates that data is ordered based on the reception time at each Subscriber.

Since each subscriber may receive the data at different times there is no guaranteed that the changes will be seen in the same order. Consequently, it is possible for each subscriber to end up with a different final value for the data.

BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS 

Indicates that data is ordered based on a timestamp placed at the source (by the Service or by the application).

In any case this guarantees a consistent final value for the data in all subscribers.

◆ DurabilityQosPolicyKind

Enum DurabilityQosPolicyKind_t, different kinds of durability for DurabilityQosPolicy.

Enumerator
VOLATILE_DURABILITY_QOS 

The Service does not need to keep any samples of data-instances on behalf of any DataReader that is not known by the DataWriter at the time the instance is written.

In other words the Service will only attempt to provide the data to existing subscribers

TRANSIENT_LOCAL_DURABILITY_QOS 

For TRANSIENT_LOCAL, the service is only required to keep the data in the memory of the DataWriter that wrote the data and the data is not required to survive the DataWriter.

TRANSIENT_DURABILITY_QOS 

For TRANSIENT, the service is only required to keep the data in memory and not in permanent storage; but the data is not tied to the lifecycle of the DataWriter and will, in general, survive it.

PERSISTENT_DURABILITY_QOS 

Data is kept on permanent storage, so that they can outlive a system session.

Warning
Not Supported

◆ DynamicDataJsonFormat

enum class DynamicDataJsonFormat
strong
Enumerator
OMG 
EPROSIMA 

◆ HistoryQosPolicyKind

Enum HistoryQosPolicyKind, different kinds of History Qos for HistoryQosPolicy.

Enumerator
KEEP_LAST_HISTORY_QOS 

On the publishing side, the Service will only attempt to keep the most recent “depth” samples of each instance of data (identified by its key) managed by the DataWriter.

On the subscribing side, the DataReader will only attempt to keep the most recent “depth” samples received for each instance (identified by its key) until the application “takes” them via the DataReader’s take operation.

KEEP_ALL_HISTORY_QOS 

On the publishing side, the Service will attempt to keep all samples (representing each value written) of each instance of data (identified by its key) managed by the DataWriter until they can be delivered to all subscribers.

On the subscribing side, the Service will attempt to keep all samples of each instance of data (identified by its key) managed by the DataReader. These samples are kept until the application “takes” them from the Service via the take operation.

◆ InstanceStateKind

enum InstanceStateKind : uint16_t

Indicates if the samples are from an alive eprosima::fastdds::dds::DataWriter or not.

For each instance, the middleware internally maintains an instance state. The instance state can be:

  • ALIVE_INSTANCE_STATE indicates that (a) samples have been received for the instance, (b) there are alive DataWriter entities writing the instance, and (c) the instance has not been explicitly disposed (or else more samples have been received after it was disposed).

The precise behavior events that cause the instance state to change depends on the setting of the OWNERSHIP QoS:

The instance state available in the SampleInfo is a snapshot of the instance state of the instance at the time the collection was obtained (i.e. at the time read or take was called). The instance state is therefore the same for all samples in the returned collection that refer to the same instance.

Enumerator
ALIVE_INSTANCE_STATE 

Instance is currently in existence.

NOT_ALIVE_DISPOSED_INSTANCE_STATE 

Not alive disposed instance. The instance has been disposed by a DataWriter.

NOT_ALIVE_NO_WRITERS_INSTANCE_STATE 

Not alive no writers for instance.

None of the DataWriter objects that are currently alive (according to the LIVELINESS QoS) are writing the instance.

◆ LivelinessQosPolicyKind

Enum LivelinessQosPolicyKind, different kinds of liveliness for LivelinessQosPolicy.

Enumerator
AUTOMATIC_LIVELINESS_QOS 

The infrastructure will automatically signal liveliness for the DataWriters at least as often as required by the lease_duration.

MANUAL_BY_PARTICIPANT_LIVELINESS_QOS 

The Service will assume that as long as at least one Entity within the DomainParticipant has asserted its liveliness the other Entities in that same DomainParticipant are also alive.

MANUAL_BY_TOPIC_LIVELINESS_QOS 

The Service will only assume liveliness of the DataWriter if the application has asserted liveliness of that DataWriter itself.

◆ OwnershipQosPolicyKind

Enum OwnershipQosPolicyKind, different kinds of ownership for OwnershipQosPolicy.

Enumerator
SHARED_OWNERSHIP_QOS 

Indicates shared ownership for each instance.

Multiple writers are allowed to update the same instance and all the updates are made available to the readers. In other words there is no concept of an “owner” for the instances.

EXCLUSIVE_OWNERSHIP_QOS 

Indicates each instance can only be owned by one DataWriter, but the owner of an instance can change dynamically.

The selection of the owner is controlled by the setting of the OwnershipStrengthQosPolicy. The owner is always set to be the highest-strength DataWriter object among the ones currently “active” (as determined by the LivelinessQosPolicy).

◆ PresentationQosPolicyAccessScopeKind

Enum PresentationQosPolicyAccessScopeKind, different kinds of Presentation Policy order for PresentationQosPolicy.

Enumerator
INSTANCE_PRESENTATION_QOS 

Scope spans only a single instance.

Indicates that changes to one instance need not be coherent nor ordered with respect to changes to any other instance. In other words, order and coherent changes apply to each instance separately.

TOPIC_PRESENTATION_QOS 

Scope spans to all instances within the same DataWriter (or DataReader), but not across instances in different DataWriter (or DataReader).

GROUP_PRESENTATION_QOS 

Scope spans to all instances belonging to DataWriter (or DataReader) entities within the same Publisher (or Subscriber).

◆ PublishModeQosPolicyKind

Enum PublishModeQosPolicyKind, different kinds of publication synchronism.

Enumerator
SYNCHRONOUS_PUBLISH_MODE 

Synchronous publication mode (default for writers).

ASYNCHRONOUS_PUBLISH_MODE 

Asynchronous publication mode.

◆ QosPolicyId_t

enum QosPolicyId_t : uint32_t

The identifier for each QosPolicy.

Each QosPolicy class has a different ID that is then used to refer to the incompatible policies on OfferedIncompatibleQosStatus and RequestedIncompatibleQosStatus.

Enumerator
INVALID_QOS_POLICY_ID 
USERDATA_QOS_POLICY_ID 
DURABILITY_QOS_POLICY_ID 
PRESENTATION_QOS_POLICY_ID 
DEADLINE_QOS_POLICY_ID 
LATENCYBUDGET_QOS_POLICY_ID 
OWNERSHIP_QOS_POLICY_ID 
OWNERSHIPSTRENGTH_QOS_POLICY_ID 
LIVELINESS_QOS_POLICY_ID 
TIMEBASEDFILTER_QOS_POLICY_ID 
PARTITION_QOS_POLICY_ID 
RELIABILITY_QOS_POLICY_ID 
DESTINATIONORDER_QOS_POLICY_ID 
HISTORY_QOS_POLICY_ID 
RESOURCELIMITS_QOS_POLICY_ID 
ENTITYFACTORY_QOS_POLICY_ID 
WRITERDATALIFECYCLE_QOS_POLICY_ID 
READERDATALIFECYCLE_QOS_POLICY_ID 
TOPICDATA_QOS_POLICY_ID 
GROUPDATA_QOS_POLICY_ID 
TRANSPORTPRIORITY_QOS_POLICY_ID 
LIFESPAN_QOS_POLICY_ID 
DURABILITYSERVICE_QOS_POLICY_ID 
DATAREPRESENTATION_QOS_POLICY_ID 
TYPECONSISTENCYENFORCEMENT_QOS_POLICY_ID 
DISABLEPOSITIVEACKS_QOS_POLICY_ID 
PARTICIPANTRESOURCELIMITS_QOS_POLICY_ID 
PROPERTYPOLICY_QOS_POLICY_ID 
PUBLISHMODE_QOS_POLICY_ID 
READERRESOURCELIMITS_QOS_POLICY_ID 
RTPSENDPOINT_QOS_POLICY_ID 
RTPSRELIABLEREADER_QOS_POLICY_ID 
RTPSRELIABLEWRITER_QOS_POLICY_ID 
TRANSPORTCONFIG_QOS_POLICY_ID 
TYPECONSISTENCY_QOS_POLICY_ID 
WIREPROTOCOLCONFIG_QOS_POLICY_ID 
WRITERRESOURCELIMITS_QOS_POLICY_ID 
NEXT_QOS_POLICY_ID 

◆ ReliabilityQosPolicyKind

Enum ReliabilityQosPolicyKind, different kinds of reliability for ReliabilityQosPolicy.

Enumerator
BEST_EFFORT_RELIABILITY_QOS 

Indicates that it is acceptable to not retry propagation of any samples.

Presumably new values for the samples are generated often enough that it is not necessary to re-send or acknowledge any samples

RELIABLE_RELIABILITY_QOS 

Specifies the Service will attempt to deliver all samples in its history.

Missed samples may be retried. In steady-state (no modifications communicated via the DataWriter) the middleware guarantees that all samples in the DataWriter history will eventually be delivered to all the DataReader objects. Outside steady state the HistoryQosPolicy and ResourceLimitsQosPolicy will determine how samples become part of the history and whether samples can be discarded from it.

◆ SampleRejectedStatusKind

An enum with the possible values for the sample rejected reason.

Enumerator
NOT_REJECTED 

Default value.

REJECTED_BY_INSTANCES_LIMIT 

Exceeds the max_instance limit.

REJECTED_BY_SAMPLES_LIMIT 

Exceeds the max_samples limit.

REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT 

Exceeds the max_samples_per_instance limit.

◆ SampleStateKind

enum SampleStateKind : uint16_t

Indicates whether or not a sample has ever been read.

For each sample received, the middleware internally maintains a sample state relative to each DataReader. This sample state can have the following values:

The sample state will, in general, be different for each sample in the collection returned by read or take.

Enumerator
READ_SAMPLE_STATE 

Sample has been read.

NOT_READ_SAMPLE_STATE 

Sample has not been read.

◆ TypeConsistencyKind

enum TypeConsistencyKind : uint16_t
Enumerator
DISALLOW_TYPE_COERCION 

The DataWriter and the DataReader must support the same data type in order for them to communicate.

ALLOW_TYPE_COERCION 

The DataWriter and the DataReader need not support the same data type in order for them to communicate as long as the reader’s type is assignable from the writer’s type.

◆ ViewStateKind

enum ViewStateKind : uint16_t

Indicates whether or not an instance is new.

For each instance (identified by the key), the middleware internally maintains a view state relative to each DataReader. This view state can have the following values:

  • NOT_NEW_VIEW_STATE indicates that the DataReader has already accessed samples of the same instance and that the instance has not been reborn since.

The view_state available in the SampleInfo is a snapshot of the view state of the instance relative to the DataReader used to access the samples at the time the collection was obtained (i.e. at the time read or take was called). The view_state is therefore the same for all samples in the returned collection that refer to the same instance.

Once an instance has been detected as not having any "live" writers and all the samples associated with the instance are "taken" from the DDSDataReader, the middleware can reclaim all local resources regarding the instance. Future samples will be treated as "never seen."

Enumerator
NEW_VIEW_STATE 

New instance.This latest generation of the instance has not previously been accessed.

NOT_NEW_VIEW_STATE 

Not a new instance. This latest generation of the instance has previously been accessed.

Function Documentation

◆ get_proxy_property()

template<class T , class PL >
T get_proxy_property ( const char *const  PID,
PL &  properties 
)

◆ idl_serialize()

FASTDDS_EXPORTED_API ReturnCode_t idl_serialize ( const DynamicType::_ref_type dynamic_type,
std::ostream &  output 
)
noexcept

Serializes a DynamicType into its IDL representation.

Parameters
[in]dynamic_typeThe DynamicType to serialize.
[in,out]outputstd::ostream reference containing the IDL representation.
Return values
RETCODE_OKwhen serialization fully succeeds, and inner (member serialization) failing code otherwise.

◆ json_serialize()

FASTDDS_EXPORTED_API ReturnCode_t json_serialize ( const DynamicData::_ref_type data,
DynamicDataJsonFormat  format,
std::ostream &  output 
)
noexcept

Serializes a DynamicData into a JSON object, which is then dumped into an std::ostream.

Parameters
[in]dataDynamicData reference to be serialized.
[in]formatDynamicDataJsonFormat JSON serialization format.
[in,out]outputstd::ostream reference where the JSON object is dumped.
Return values
RETCODE_OKwhen serialization fully succeeds, and inner (member serialization) failing code otherwise.

◆ operator!=()

static bool operator!= ( const Time_t t1,
const Time_t t2 
)
inlinestatic

Comparison assignment.

Parameters
t1First Time_t to compare
t2Second Time_t to compare
Returns
True if not equal

◆ operator+()

static Time_t operator+ ( const Time_t ta,
const Time_t tb 
)
inlinestatic

Adds two Time_t.

Parameters
taFirst Time_t to add
tbSecond Time_t to add
Returns
A new Time_t with the result.

◆ operator-()

static Time_t operator- ( const Time_t ta,
const Time_t tb 
)
inlinestatic

Subtracts two Time_t.

Parameters
taFirst Time_t to subtract
tbSecond Time_t to subtract
Returns
A new Time_t with the result.

◆ operator<()

static bool operator< ( const Time_t t1,
const Time_t t2 
)
inlinestatic

Checks if a Time_t is less than other.

Parameters
t1First Time_t to compare
t2Second Time_t to compare
Returns
True if the first Time_t is less than the second

◆ operator<<() [1/2]

std::ostream & operator<< ( std::ostream &  output,
const Log::Kind kind 
)
inline

Streams Log::Kind serialization.

◆ operator<<() [2/2]

std::ostream & operator<< ( std::ostream &  output,
const Time_t t 
)
inline

◆ operator<=()

static bool operator<= ( const Time_t t1,
const Time_t t2 
)
inlinestatic

Checks if a Time_t is less or equal than other.

Parameters
t1First Time_t to compare
t2Second Time_t to compare
Returns
True if the first Time_t is less or equal than the second

◆ operator==()

static bool operator== ( const Time_t t1,
const Time_t t2 
)
inlinestatic

Comparison assignment.

Parameters
t1First Time_t to compare
t2Second Time_t to compare
Returns
True if equal

◆ operator>()

static bool operator> ( const Time_t t1,
const Time_t t2 
)
inlinestatic

Checks if a Time_t is greater than other.

Parameters
t1First Time_t to compare
t2Second Time_t to compare
Returns
True if the first Time_t is greater than the second

◆ operator>=()

static bool operator>= ( const Time_t t1,
const Time_t t2 
)
inlinestatic

Checks if a Time_t is greater or equal than other.

Parameters
t1First Time_t to compare
t2Second Time_t to compare
Returns
True if the first Time_t is greater or equal than the second

◆ set_proxy_property()

template<class T , class PL >
void set_proxy_property ( const T &  p,
const char *  PID,
PL &  properties 
)

Variable Documentation

◆ ANY_INSTANCE_STATE

constexpr InstanceStateMask ANY_INSTANCE_STATE = ALIVE_INSTANCE_STATE | NOT_ALIVE_INSTANCE_STATE
constexpr

Any instance state.

◆ ANY_SAMPLE_STATE

constexpr SampleStateMask ANY_SAMPLE_STATE = READ_SAMPLE_STATE | NOT_READ_SAMPLE_STATE
constexpr

Any sample state.

◆ ANY_VIEW_STATE

constexpr ViewStateMask ANY_VIEW_STATE = NEW_VIEW_STATE | NOT_NEW_VIEW_STATE
constexpr

Any view state.

◆ c_TimeInfinite

Time_t (dds::Duration_t) representing an infinite time. DONT USE IT IN CONSTRUCTORS.

◆ c_TimeInvalid

const Time_t c_TimeInvalid {-1, Time_t::INFINITE_NANOSECONDS}

Time_t (dds::Duration_t) representing an invalid time. DONT USE IT IN CONSTRUCTORS.

◆ c_TimeZero

const Time_t c_TimeZero {0, 0}

Time_t (dds::Duration_t) representing a zero time. DONT USE IT IN CONSTRUCTORS.

◆ DATAREADER_QOS_DEFAULT

FASTDDS_EXPORTED_API const DataReaderQos DATAREADER_QOS_DEFAULT
extern

◆ DATAREADER_QOS_USE_TOPIC_QOS

FASTDDS_EXPORTED_API const DataReaderQos DATAREADER_QOS_USE_TOPIC_QOS
extern

◆ DATAWRITER_QOS_DEFAULT

FASTDDS_EXPORTED_API const DataWriterQos DATAWRITER_QOS_DEFAULT
extern

◆ DATAWRITER_QOS_USE_TOPIC_QOS

FASTDDS_EXPORTED_API const DataWriterQos DATAWRITER_QOS_USE_TOPIC_QOS
extern

◆ DEFAULT_DATA_REPRESENTATION

constexpr DataRepresentationId_t DEFAULT_DATA_REPRESENTATION {DataRepresentationId_t::XCDR_DATA_REPRESENTATION}
constexpr

Default DataRepresentationId used in Fast DDS.

◆ DOMAIN_ID_UNKNOWN

const DomainId_t DOMAIN_ID_UNKNOWN = 0xFFFFFFFF

◆ HANDLE_NIL

FASTDDS_EXPORTED_API const InstanceHandle_t HANDLE_NIL
extern

◆ LENGTH_UNLIMITED

const int32_t LENGTH_UNLIMITED = -1

◆ MEMBER_ID_INVALID

constexpr MemberId MEMBER_ID_INVALID {0x0FFFFFFF}
constexpr

◆ NOT_ALIVE_INSTANCE_STATE

constexpr InstanceStateMask NOT_ALIVE_INSTANCE_STATE
constexpr
Initial value:
=
@ NOT_ALIVE_NO_WRITERS_INSTANCE_STATE
Not alive no writers for instance.
Definition InstanceState.hpp:71
@ NOT_ALIVE_DISPOSED_INSTANCE_STATE
Not alive disposed instance. The instance has been disposed by a DataWriter.
Definition InstanceState.hpp:68

Not alive instance state.

◆ PARTICIPANT_FACTORY_QOS_DEFAULT

FASTDDS_EXPORTED_API const DomainParticipantFactoryQos PARTICIPANT_FACTORY_QOS_DEFAULT
extern

◆ PARTICIPANT_QOS_DEFAULT

FASTDDS_EXPORTED_API const DomainParticipantQos PARTICIPANT_QOS_DEFAULT
extern

◆ PUBLISHER_QOS_DEFAULT

FASTDDS_EXPORTED_API const PublisherQos PUBLISHER_QOS_DEFAULT
extern

◆ RETCODE_ALREADY_DELETED

const ReturnCode_t RETCODE_ALREADY_DELETED = 9

◆ RETCODE_BAD_PARAMETER

const ReturnCode_t RETCODE_BAD_PARAMETER = 3

◆ RETCODE_ERROR

const ReturnCode_t RETCODE_ERROR = 1

◆ RETCODE_ILLEGAL_OPERATION

const ReturnCode_t RETCODE_ILLEGAL_OPERATION = 12

◆ RETCODE_IMMUTABLE_POLICY

const ReturnCode_t RETCODE_IMMUTABLE_POLICY = 7

◆ RETCODE_INCONSISTENT_POLICY

const ReturnCode_t RETCODE_INCONSISTENT_POLICY = 8

◆ RETCODE_NO_DATA

const ReturnCode_t RETCODE_NO_DATA = 11

◆ RETCODE_NOT_ALLOWED_BY_SECURITY

const ReturnCode_t RETCODE_NOT_ALLOWED_BY_SECURITY = 1000

◆ RETCODE_NOT_ENABLED

const ReturnCode_t RETCODE_NOT_ENABLED = 6

◆ RETCODE_OK

const ReturnCode_t RETCODE_OK = 0

◆ RETCODE_OUT_OF_RESOURCES

const ReturnCode_t RETCODE_OUT_OF_RESOURCES = 5

◆ RETCODE_PRECONDITION_NOT_MET

const ReturnCode_t RETCODE_PRECONDITION_NOT_MET = 4

◆ RETCODE_TIMEOUT

const ReturnCode_t RETCODE_TIMEOUT = 10

◆ RETCODE_UNSUPPORTED

const ReturnCode_t RETCODE_UNSUPPORTED = 2

◆ sqlfilter_name

constexpr const char* const sqlfilter_name = "DDSSQL"
constexpr

◆ SUBSCRIBER_QOS_DEFAULT

FASTDDS_EXPORTED_API const SubscriberQos SUBSCRIBER_QOS_DEFAULT
extern

◆ TK_ALIAS

const TypeKind TK_ALIAS = 0x30

◆ TK_ANNOTATION

const TypeKind TK_ANNOTATION = 0x50

◆ TK_ARRAY

const TypeKind TK_ARRAY = 0x61

◆ TK_BITMASK

const TypeKind TK_BITMASK = 0x41

◆ TK_BITSET

const TypeKind TK_BITSET = 0x53

◆ TK_BOOLEAN

const TypeKind TK_BOOLEAN = 0x01

◆ TK_BYTE

const TypeKind TK_BYTE = 0x02

◆ TK_CHAR16

const TypeKind TK_CHAR16 = 0x11

◆ TK_CHAR8

const TypeKind TK_CHAR8 = 0x10

◆ TK_ENUM

const TypeKind TK_ENUM = 0x40

◆ TK_FLOAT128

const TypeKind TK_FLOAT128 = 0x0B

◆ TK_FLOAT32

const TypeKind TK_FLOAT32 = 0x09

◆ TK_FLOAT64

const TypeKind TK_FLOAT64 = 0x0A

◆ TK_INT16

const TypeKind TK_INT16 = 0x03

◆ TK_INT32

const TypeKind TK_INT32 = 0x04

◆ TK_INT64

const TypeKind TK_INT64 = 0x05

◆ TK_INT8

const TypeKind TK_INT8 = 0x0C

◆ TK_MAP

const TypeKind TK_MAP = 0x62

◆ TK_NONE

const TypeKind TK_NONE = 0x00

◆ TK_SEQUENCE

const TypeKind TK_SEQUENCE = 0x60

◆ TK_STRING16

const TypeKind TK_STRING16 = 0x21

◆ TK_STRING8

const TypeKind TK_STRING8 = 0x20

◆ TK_STRUCTURE

const TypeKind TK_STRUCTURE = 0x51

◆ TK_UINT16

const TypeKind TK_UINT16 = 0x06

◆ TK_UINT32

const TypeKind TK_UINT32 = 0x07

◆ TK_UINT64

const TypeKind TK_UINT64 = 0x08

◆ TK_UINT8

const TypeKind TK_UINT8 = 0x0D

◆ TK_UNION

const TypeKind TK_UNION = 0x52

◆ TOPIC_QOS_DEFAULT

FASTDDS_EXPORTED_API const TopicQos TOPIC_QOS_DEFAULT
extern