Classes
class	BaseStatus
	A struct storing the base status. More...

interface	DataReader
	DDS DataReader interface. More...

interface	DataReaderListener
	DDS DataReader listener. More...

interface	DataWriter
	DDS DataWriter interface. More...

interface	DataWriterListener
	DDS DataWriter listener. More...

interface	DomainParticipant
	DDS DomainParticipant interface. More...

class	DomainParticipantFactory
	DDS Domain Participant factory. More...

interface	DomainParticipantListener
	DDS Domain participant listener. More...

class	Entity
	The Entity base class. More...

struct	UserInlineQoS
	Definition of InlineQoS exposed to user APIs. More...

struct	SystemInlineQoS
	Definition of InlineQoS strictly used by the library. More...

struct	InlineQoS
	InlineQoS functionality. More...

class	LivelinessChangedStatus
	A struct storing the Liveliness Changed Status. More...

class	OfferedDeadlineMissedStatus
	A struct storing the status of offered missed deadline events. More...

class	OfferedIncompatibleQosStatus
	A struct storing the status of Offered Incompatible QoS Status events. More...

class	PublicationMatchedStatus
	A struct storing the Publication Matched Status of a publisher. More...

interface	Publisher
	DDS Publisher interface. More...

interface	PublisherListener
	DDS DataWriter listener. More...

class	RequestedDeadlineMissedStatus
	A struct storing the status of requested missed deadline events. More...

class	RequestedIncompatibleQosStatus
	A struct storing the status of Requested Incompatible QoS Status events. More...

class	SafeDomainParticipantFactoryAllocator
	Allocator interface for Safe DDS Domain Participant factory for Safety Profile. More...

class	SafeDomainParticipantFactory
	DDS Domain Participant factory for Safety Profile. More...

struct	SampleInfo
	DDS Sample information. More...

class	SampleRejectedStatus
	A struct storing the status of sample rejected events. More...

class	StatusCondition
	Activation of entity listeners. More...

interface	Subscriber
	DDS Subscriber interface. More...

interface	SubscriberListener
	DDS DataReader listener. More...

class	SubscriptionMatchedStatus
	A struct storing the Subscription Matched Status of a subscriber. More...

interface	Topic
	DDS Topic interface. More...

struct	TopicBuiltinTopicData
	Builtin topic data for topics. More...

class	TopicDescription
	Represents the topic and type name of a topic. More...

interface	TopicListener
	Topic listener. More...

interface	TypedDataReader
	DDS TypedDataReader implementation. More...

class	TypedDataWriter
	DDS TypedDataWriter implementation. More...

class	TypedTypeSupport
	TypedTypeSupport interface. More...

interface	TypeSupport
	Type support interface. More...

class	CommonQos
	Class to store and manage a Common QoS configuration. More...

class	DataReaderAllocationsQosPolicy
	Data reader preallocations memory configuration. More...

class	DataReaderQos
	Class to store and manage a dds::DataReader QoS configuration. More...

class	DataReaderWireProtocolQosPolicy
	Class with configuration related to the wire protocol. More...

class	DataRepresentationQosPolicy
	Qos to configure data representation. More...

class	DataSharingQosPolicy
	Data sharing feature configuration. More...

class	DataWriterAllocationsQosPolicy
	Data writer preallocations memory configuration. More...

class	DataWriterQos
	Class to store and manage a dds::DataWriter QoS configuration. More...

class	DataWriterWireProtocolQosPolicy
	Class with configuration related to the wire protocol. More...

class	DeadlineQosPolicy
	Qos Policy for periodic data time deadline. Configured period will stablish a requirement for the maximum expected time between received samples. More...

class	DestinationOrderQosPolicy
	Qos to configure destination order of and endpoint. More...

class	DomainParticipantAllocationsQosPolicy
	Domain participant preallocations memory configuration. More...

class	DomainParticipantFactoryQos
	Class to store and manage a DomainParticipantFactory QoS configuration. More...

class	DomainParticipantQos
	Class to store and manage a dds::Participant QoS configuration. More...

class	DomainParticipantWireProtocolQosPolicy
	Class with configuration related to the wire protocol. More...

class	DurabilityQosPolicy
	Qos Policy to configure data persistence of confirmed data. More...

class	DurabilityServiceQosPolicy
	QoS policy to configure the durability service. More...

class	EndpointQos
	Class to store and manage a Endpoint QoS configuration. More...

class	EntityFactoryQosPolicy
	Qos Policy to control if a factory should automatically enable created entities. More...

class	GroupDataQosPolicy
	QoS policy to configure the group data. More...

class	HistoryQosPolicy
	Qos Policy to configure data persistence. More...

class	LatencyBudgetQosPolicy
	Qos Policy to configure the latency budget. More...

class	LifespanQosPolicy
	Qos to configure the lifespan of the data. More...

class	LivelinessQosPolicy
	Qos Policy to configure the mechanism used to determine whether an Entity is “active” (alive). More...

class	OwnershipQosPolicy
	Qos to configure data ownership of and endpoint. More...

class	OwnershipStrengthQosPolicy
	Qos to configure ownership strength of and endpoint. More...

class	PartitionQosPolicy
	Qos to configure partition of and endpoint. More...

class	PresentationQosPolicy
	Qos Policy to control how received samples are ordered and presented to the subscriber application. More...

class	PublisherQos
	Class to store and manage a dds::Publisher QoS configuration. More...

class	QosMatchingEngine
	Helper class to check Qos compatibility between `dds` and `discovery` entities. More...

class	QosPolicyCompatibility
	Forward DataRepresentationQosPolicy declaration. More...

struct	QosPolicyCount
	Class to manage QosPolicyCount. More...

class	ReaderDataLifecycleQosPolicy
	Qos to configure lyfecycle of the data in a reader. More...

class	ReliabilityQosPolicy
	Qos to configure data reliability of and endpoint. More...

class	ResourceLimitsQosPolicy
	Qos Policy to configure the resources provided to the Topic in order to meet the requested Qos. More...

class	SubscriberQos
	Class to store and manage a dds::Subscriber QoS configuration. More...

class	TimeBasedFilterQosPolicy
	Qos to configure the time based filter. More...

class	TopicAllocationsQosPolicy
	Topic preallocations memory configuration. More...

class	TopicDataQosPolicy
	QoS policy to configure the topic data. More...

class	TopicQos
	Class to store and manage a dds::Topic QoS configuration. More...

class	TransportPriorityQosPolicy
	Qos to configure the transport priority of the data. More...

class	UserDataQosPolicy
	QoS policy to configure the user data. More...

class	WriterDataLifecycleQosPolicy
	Qos to configure instance lifecycle of data writer. More...

class	StaticDataReader
	DataReader that provides static memory to TypedDataReader. More...

class	StaticDataReaderInstance
	DataWriterInstance that provides static memory to BaseDataReaderInstance. More...

class	StaticDataReaderInstanceStorage
	DataReaderInstanceStorage that provides static memory to BaseDataReaderInstanceStorage. More...

class	StaticDataReaderWriterStorage
	DataReaderWriterStorage that provides static memory to BaseDataReaderWriterStorage. More...

class	StaticDataWriter
	DataWriter that provides static memory to TypedDataWriter. More...

class	StaticDataWriterInstance
	DataWriterInstance that provides static memory to StaticDataWriterInstance. More...

class	StaticDataWriterInstanceStorage
	DataWriterInstanceStorage that provides static memory to BaseDataWriterInstanceStorage. More...

class	StaticDomainParticipant
	DomainParticipant that provides static memory to BaseDomainParticipant. More...

class	StaticDomainTransportDispatcher
	DDS Domain Trasnport dispatcher. More...

class	StaticPublisher
	Publisher that provides static memory to BasePublisher. More...

class	StaticSubscriber
	Subscriber that provides static memory to BaseSubscriber. More...

class	StaticTopic
	Topic that provides static memory to BaseTopic. More...

Typedefs
using	SampleLostStatus = BaseStatus
	Alias of BaseStatus. More...

using	LivelinessLostStatus = BaseStatus
	Alias of BaseStatus. More...

using	InconsistentTopicStatus = BaseStatus
	Alias of BaseStatus. More...

using	DomainId = uint16_t
	DDS DomainId structure. More...

using	InstanceHandle = uint32_t
	DDS API unique identifier for entities. More...

using	InstanceStateKind = uint32_t
	Instance state kind type. More...

using	InstanceStateMask = uint32_t
	Instance state mask type. More...

using	KeyHash = protocol::KeyHash
	Sample key hash structure. More...

using	OwnershipStrengthValue = int32_t
	OwnershipStrengthValue type. More...

using	ParticipantBuiltinTopicData = discovery::ParticipantInfo
	Builtin topic data for Participants. More...

using	PublicationBuiltinTopicData = discovery::PublicationInfo
	Builtin topic data for publications. More...

using	SampleStateKind = uint32_t
	Sample state kind type. More...

using	SampleStateMask = uint32_t
	Sample state mask type. More...

using	StatusMask = uint64_t
	Mask for status changes. More...

using	StatusKind = uint64_t
	StatusMask constants. More...

using	SubscriptionBuiltinTopicData = discovery::SubscriptionInfo
	Builtin topic data for subscriptions. More...

using	ViewStateKind = uint32_t
	View state kind type. More...

using	ViewStateMask = uint32_t
	View state mask type. More...

Enumerations
enum class	ReturnCode : uint8_t { OK = 0x00 , ERROR = 0x01 , UNSUPPORTED = 0x02 , BAD_PARAMETER = 0x03 , PRECONDITION_NOT_MET = 0x04 , OUT_OF_RESOURCES = 0x05 , NOT_ENABLED = 0x06 , IMMUTABLE_POLICY = 0x07 , INCONSISTENT_POLICY = 0x08 , ALREADY_DELETED = 0x09 , TIMEOUT = 0x0A , NO_DATA = 0x0B , ILLEGAL_OPERATION = 0x0C }
	DDS API standardized ReturnCodes. More...

enum class	SampleRejectedStatusKind : uint8_t { 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 class	StatusInfo : uint32_t { ALIVE = 0 , DISPOSED = 1 , UNREGISTERED = 2 , DISPOSED_UNREGISTERED = 3 }
	SampleInfo Status possible values. More...

enum class	DataRepresentationQosPolicyKind : int16_t { XCDR_DATA_REPRESENTATION = 0 , XML_DATA_REPRESENTATION = 1 , XCDR2_DATA_REPRESENTATION = 2 , TYPE_SIZE }
	Data representation kind. More...

enum class	DestinationOrderQosPolicyKind : uint32_t { BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS = 0 , BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS = 1 }
	Destination order kind. More...

enum class	DurabilityQosPolicyKind : uint32_t { VOLATILE_DURABILITY_QOS = 0 , TRANSIENT_LOCAL_DURABILITY_QOS = 1 , TRANSIENT_DURABILITY_QOS = 2 , PERSISTENT_DURABILITY_QOS = 3 }
	Durability kind. More...

enum class	HistoryQosPolicyKind : uint32_t { KEEP_LAST_HISTORY_QOS = 0 , KEEP_ALL_HISTORY_QOS = 1 }
	History kind HistoryQosPolicyKind. More...

enum class	LivelinessQosPolicyKind : uint32_t { AUTOMATIC_LIVELINESS_QOS = 0 , MANUAL_BY_PARTICIPANT_LIVELINESS_QOS = 1 , MANUAL_BY_TOPIC_LIVELINESS_QOS = 2 }
	Liveliness kind. More...

enum class	OwnershipQosPolicyKind : uint32_t { SHARED_OWNERSHIP_QOS = 0 , EXCLUSIVE_OWNERSHIP_QOS = 1 }
	Ownership kind. More...

enum class	PresentationQosPolicyAccessScopeKind : uint32_t { INSTANCE_PRESENTATION_QOS = 0 , TOPIC_PRESENTATION_QOS = 1 , GROUP_PRESENTATION_QOS = 2 }
	Presentation access scope kind. More...

enum class	QosPolicyId : 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 , DOMAINPARTICIPANTWIREPROTOCOL_QOS_POLICY_ID = 25 , DATAWRITERWIREPROTOCOL_QOS_POLICY_ID = 26 , DATAREADERWIREPROTOCOL_QOS_POLICY_ID = 27 , DATASHARING_QOS_POLICY_ID = 28 , QOS_POLICY_ID_SIZE }
	DDS API standardized QoS Policy IDs. More...

enum class	ReliabilityQosPolicyKind : uint32_t { BEST_EFFORT_RELIABILITY_QOS , RELIABLE_RELIABILITY_QOS }
	Reliability kind. More...

Functions
constexpr bool	status_mask_has (StatusMask mask, StatusKind kind)
	Checks if a StatusKind is set in a StatusMask. More...

void	status_mask_set (StatusMask &mask, StatusKind kind)
	Sets a StatusKind in a StatusMask. More...

void	status_mask_unset (StatusMask &mask, StatusKind kind)
	Unsets a StatusKind in a StatusMask. More...

Variables
constexpr uint32_t	INLINE_QOS_MAX_SERIALIZED_SIZE
	Ensure SystemInlineQoS is IsStandardLayout in order to calculate max serialized size below. More...

constexpr InstanceHandle	HANDLE_NIL {UINT32_MAX}
	Invalid handle. More...

constexpr InstanceStateKind	ALIVE_INSTANCE_STATE = 0x00000001U
	Alive instance state. More...

constexpr InstanceStateKind	NOT_ALIVE_DISPOSED_INSTANCE_STATE = 0x00000002U
	Not alive disposed instance state. More...

constexpr InstanceStateKind	NOT_ALIVE_NO_WRITERS_INSTANCE_STATE = 0x00000004U
	Not alive no writers instance state. More...

constexpr InstanceStateKind	END_OF_LIFE_INSTANCE_STATE = 0x80000000U
	End of life instance state. More...

constexpr uint32_t	KEY_HASH_SIZE = protocol::KEY_HASH_SIZE
	SampleID handle size in bytes. More...

constexpr SampleStateKind	NOT_READ_SAMPLE_STATE = 0x00000001
	Not read sample state. More...

constexpr SampleStateKind	READ_SAMPLE_STATE = 0x00000002
	Read sample state. More...

constexpr uint32_t	STATUS_FLAGS_INDEX = 3U
	Status info flags positions in data array. More...

constexpr uint8_t	STATUS_FLAGS_MASK = 0x03U
	Mask for status info flags. More...

constexpr StatusMask	ANY_STATUS_MASK = UINT64_MAX
	Any status. More...

constexpr StatusMask	NONE_STATUS_MASK = 0x00
	None status. More...

constexpr StatusKind	INCONSISTENT_TOPIC_STATUS = 1UL << 0UL
	Inconsistent topic status. More...

constexpr StatusKind	OFFERED_DEADLINE_MISSED_STATUS = 1UL << 1UL
	Offered deadline missed status. More...

constexpr StatusKind	REQUESTED_DEADLINE_MISSED_STATUS = 1UL << 2UL
	Requested deadline missed status. More...

constexpr StatusKind	OFFERED_INCOMPATIBLE_QOS_STATUS = 1UL << 5UL
	Offered incompatible QoS status. More...

constexpr StatusKind	REQUESTED_INCOMPATIBLE_QOS_STATUS = 1UL << 6UL
	Requested incompatible QoS status. More...

constexpr StatusKind	SAMPLE_LOST_STATUS = 1UL << 7UL
	Sample lost status. More...

constexpr StatusKind	SAMPLE_REJECTED_STATUS = 1UL << 8UL
	Sample rejected status. More...

constexpr StatusKind	DATA_ON_READERS_STATUS = 1UL << 9UL
	Data on readers status. More...

constexpr StatusKind	DATA_AVAILABLE_STATUS = 1UL << 10UL
	Data available status. More...

constexpr StatusKind	LIVELINESS_LOST_STATUS = 1UL << 11UL
	Liveliness lost status. More...

constexpr StatusKind	LIVELINESS_CHANGED_STATUS = 1UL << 12UL
	Liveliness changed status. More...

constexpr StatusKind	PUBLICATION_MATCHED_STATUS = 1UL << 13UL
	Publication matched status. More...

constexpr StatusKind	SUBSCRIPTION_MATCHED_STATUS = 1UL << 14UL
	Subscription matched status. More...

constexpr StatusMask	SAFE_STATUS_MASK = ANY_STATUS_MASK & ~DATA_ON_READERS_STATUS
	Safe status. More...

constexpr ViewStateKind	NEW_VIEW_STATE = 0x00000001
	New view state. More...

constexpr ViewStateKind	NOT_NEW_VIEW_STATE = 0x00000002
	Not new view state. More...

Typedef Documentation

◆ DomainId

using eprosima::safedds::dds::DomainId = typedef uint16_t

DDS DomainId structure.

◆ InconsistentTopicStatus

using eprosima::safedds::dds::InconsistentTopicStatus = typedef BaseStatus

Alias of BaseStatus.

◆ InstanceHandle

eprosima::safedds::dds::InstanceHandle

DDS API unique identifier for entities.

◆ InstanceStateKind

eprosima::safedds::dds::InstanceStateKind

Instance state kind type.

◆ InstanceStateMask

eprosima::safedds::dds::InstanceStateMask

Instance state mask type.

◆ KeyHash

eprosima::safedds::dds::KeyHash

Sample key hash structure.

◆ LivelinessLostStatus

using eprosima::safedds::dds::LivelinessLostStatus = typedef BaseStatus

Alias of BaseStatus.

◆ OwnershipStrengthValue

eprosima::safedds::dds::OwnershipStrengthValue

OwnershipStrengthValue type.

◆ ParticipantBuiltinTopicData

eprosima::safedds::dds::ParticipantBuiltinTopicData

Builtin topic data for Participants.

◆ PublicationBuiltinTopicData

eprosima::safedds::dds::PublicationBuiltinTopicData

Builtin topic data for publications.

◆ SampleLostStatus

using eprosima::safedds::dds::SampleLostStatus = typedef BaseStatus

Alias of BaseStatus.

◆ SampleStateKind

eprosima::safedds::dds::SampleStateKind

Sample state kind type.

◆ SampleStateMask

eprosima::safedds::dds::SampleStateMask

Sample state mask type.

◆ StatusKind

using eprosima::safedds::dds::StatusKind = typedef uint64_t

StatusMask constants.

◆ StatusMask

eprosima::safedds::dds::StatusMask

Mask for status changes.

◆ SubscriptionBuiltinTopicData

eprosima::safedds::dds::SubscriptionBuiltinTopicData

Builtin topic data for subscriptions.

◆ ViewStateKind

eprosima::safedds::dds::ViewStateKind

View state kind type.

◆ ViewStateMask

eprosima::safedds::dds::ViewStateMask

View state mask type.

Enumeration Type Documentation

◆ DataRepresentationQosPolicyKind

enum eprosima::safedds::dds::DataRepresentationQosPolicyKind : int16_t

strong

Data representation kind.

Enumerator
XCDR_DATA_REPRESENTATION	Extended CDR Encoding version 1.
XML_DATA_REPRESENTATION	XML Data Representation (Unsupported)
XCDR2_DATA_REPRESENTATION	Extended CDR Encoding version 2 (Unsupported)
TYPE_SIZE

◆ DestinationOrderQosPolicyKind

enum eprosima::safedds::dds::DestinationOrderQosPolicyKind : uint32_t

strong

Destination order kind.

Enumerator
BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS
BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS

◆ DurabilityQosPolicyKind

enum eprosima::safedds::dds::DurabilityQosPolicyKind : uint32_t

strong

Durability kind.

@safety_api_struct

Enumerator
VOLATILE_DURABILITY_QOS
TRANSIENT_LOCAL_DURABILITY_QOS
TRANSIENT_DURABILITY_QOS
PERSISTENT_DURABILITY_QOS

◆ HistoryQosPolicyKind

enum eprosima::safedds::dds::HistoryQosPolicyKind : uint32_t

strong

History kind HistoryQosPolicyKind.

@safety_api_struct

Enumerator
KEEP_LAST_HISTORY_QOS
KEEP_ALL_HISTORY_QOS

◆ LivelinessQosPolicyKind

enum eprosima::safedds::dds::LivelinessQosPolicyKind : uint32_t

strong

Liveliness kind.

@safety_api_struct

Enumerator
AUTOMATIC_LIVELINESS_QOS
MANUAL_BY_PARTICIPANT_LIVELINESS_QOS
MANUAL_BY_TOPIC_LIVELINESS_QOS

◆ OwnershipQosPolicyKind

enum eprosima::safedds::dds::OwnershipQosPolicyKind : uint32_t

strong

Ownership kind.

Enumerator
SHARED_OWNERSHIP_QOS	Shared ownership.
EXCLUSIVE_OWNERSHIP_QOS	Exclusive ownership.

◆ PresentationQosPolicyAccessScopeKind

enum eprosima::safedds::dds::PresentationQosPolicyAccessScopeKind : uint32_t

strong

Presentation access scope kind.

Enumerator
INSTANCE_PRESENTATION_QOS
TOPIC_PRESENTATION_QOS
GROUP_PRESENTATION_QOS

◆ QosPolicyId

enum eprosima::safedds::dds::QosPolicyId : uint32_t

strong

DDS API standardized QoS Policy IDs.

Enumerator
INVALID_QOS_POLICY_ID	Does not refer to any valid QosPolicy.
USERDATA_QOS_POLICY_ID	UserDataQosPolicy.
DURABILITY_QOS_POLICY_ID	DurabilityQosPolicy.
PRESENTATION_QOS_POLICY_ID	PresentationQosPolicy.
DEADLINE_QOS_POLICY_ID	DeadlineQosPolicy.
LATENCYBUDGET_QOS_POLICY_ID	LatencyBudgetQosPolicy.
OWNERSHIP_QOS_POLICY_ID	OwnershipQosPolicy.
OWNERSHIPSTRENGTH_QOS_POLICY_ID	OwnershipStrengthQosPolicy.
LIVELINESS_QOS_POLICY_ID	LivelinessQosPolicy.
TIMEBASEDFILTER_QOS_POLICY_ID	TimeBasedFilterQosPolicy.
PARTITION_QOS_POLICY_ID	PartitionQosPolicy.
RELIABILITY_QOS_POLICY_ID	ReliabilityQosPolicy.
DESTINATIONORDER_QOS_POLICY_ID	DestinationOrderQosPolicy.
HISTORY_QOS_POLICY_ID	HistoryQosPolicy.
RESOURCELIMITS_QOS_POLICY_ID	ResourceLimitsQosPolicy.
ENTITYFACTORY_QOS_POLICY_ID	EntityFactoryQosPolicy.
WRITERDATALIFECYCLE_QOS_POLICY_ID	WriterDataLifecycleQosPolicy.
READERDATALIFECYCLE_QOS_POLICY_ID	ReaderDataLifecycleQosPolicy.
TOPICDATA_QOS_POLICY_ID	TopicDataQosPolicy.
GROUPDATA_QOS_POLICY_ID	GroupDataQosPolicy.
TRANSPORTPRIORITY_QOS_POLICY_ID	TransportPriorityQosPolicy.
LIFESPAN_QOS_POLICY_ID	LifespanQosPolicy.
DURABILITYSERVICE_QOS_POLICY_ID	DurabilityServiceQosPolicy.
DATAREPRESENTATION_QOS_POLICY_ID	DataRepresentationQosPolicy.
TYPECONSISTENCYENFORCEMENT_QOS_POLICY_ID	TypeConsistencyEnforcementQosPolicy.
DOMAINPARTICIPANTWIREPROTOCOL_QOS_POLICY_ID	DomainParticipantWireProtocolQosPolicy.
DATAWRITERWIREPROTOCOL_QOS_POLICY_ID	DataWriterWireProtocolQosPolicy.
DATAREADERWIREPROTOCOL_QOS_POLICY_ID	DataReaderWireProtocolQosPolicy.
DATASHARING_QOS_POLICY_ID	DataSharingQosPolicy.
QOS_POLICY_ID_SIZE	Keep always the last element (For internal use only).

◆ ReliabilityQosPolicyKind

enum eprosima::safedds::dds::ReliabilityQosPolicyKind : uint32_t

strong

Reliability kind.

@safety_api_struct

Enumerator
BEST_EFFORT_RELIABILITY_QOS	Best effort reliability.
RELIABLE_RELIABILITY_QOS	Reliable reliability.

◆ ReturnCode

enum eprosima::safedds::dds::ReturnCode : uint8_t

strong

DDS API standardized ReturnCodes.

Enumerator
OK
ERROR
UNSUPPORTED
BAD_PARAMETER
PRECONDITION_NOT_MET
OUT_OF_RESOURCES
NOT_ENABLED
IMMUTABLE_POLICY
INCONSISTENT_POLICY
ALREADY_DELETED
TIMEOUT
NO_DATA
ILLEGAL_OPERATION

◆ SampleRejectedStatusKind

enum eprosima::safedds::dds::SampleRejectedStatusKind : uint8_t

strong

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.

◆ StatusInfo

enum eprosima::safedds::dds::StatusInfo : uint32_t

strong

SampleInfo Status possible values.

Enumerator
ALIVE
DISPOSED
UNREGISTERED
DISPOSED_UNREGISTERED

Function Documentation

◆ status_mask_has()

constexpr bool eprosima::safedds::dds::status_mask_has	(	StatusMask	mask,
		StatusKind	kind
	)

constexpr

Checks if a StatusKind is set in a StatusMask.

Parameters

mask	StatusMask to check.
kind	StatusKind to check.

Returns: true if the StatusKind is set in the StatusMask, false otherwise.

◆ status_mask_set()

void eprosima::safedds::dds::status_mask_set	(	StatusMask &	mask,
		StatusKind	kind
	)

inline

Sets a StatusKind in a StatusMask.

Parameters

mask	StatusMask to set.
kind	StatusKind to set.

◆ status_mask_unset()

void eprosima::safedds::dds::status_mask_unset	(	StatusMask &	mask,
		StatusKind	kind
	)

inline

Unsets a StatusKind in a StatusMask.

Parameters

mask	StatusMask to unset.
kind	StatusKind to unset.

Variable Documentation

◆ ALIVE_INSTANCE_STATE

constexpr InstanceStateKind eprosima::safedds::dds::ALIVE_INSTANCE_STATE = 0x00000001U

constexpr

Alive instance state.

◆ ANY_STATUS_MASK

constexpr StatusMask eprosima::safedds::dds::ANY_STATUS_MASK = UINT64_MAX

constexpr

Any status.

◆ DATA_AVAILABLE_STATUS

constexpr StatusKind eprosima::safedds::dds::DATA_AVAILABLE_STATUS = 1UL << 10UL

constexpr

Data available status.

◆ DATA_ON_READERS_STATUS

constexpr StatusKind eprosima::safedds::dds::DATA_ON_READERS_STATUS = 1UL << 9UL

constexpr

Data on readers status.

◆ END_OF_LIFE_INSTANCE_STATE

constexpr InstanceStateKind eprosima::safedds::dds::END_OF_LIFE_INSTANCE_STATE = 0x80000000U

constexpr

End of life instance state.

◆ HANDLE_NIL

constexpr InstanceHandle eprosima::safedds::dds::HANDLE_NIL {UINT32_MAX}

constexpr

Invalid handle.

◆ INCONSISTENT_TOPIC_STATUS

constexpr StatusKind eprosima::safedds::dds::INCONSISTENT_TOPIC_STATUS = 1UL << 0UL

constexpr

Inconsistent topic status.

◆ INLINE_QOS_MAX_SERIALIZED_SIZE

constexpr uint32_t eprosima::safedds::dds::INLINE_QOS_MAX_SERIALIZED_SIZE

constexpr

Initial value:

=
        SystemInlineQoS::CDR_SERIALIZED_SIZE +
        UserInlineQoS::CDR_SERIALIZED_SIZE +
        serialization::cdr::rtps::ParameterHeader::CDR_SERIALIZED_SIZE

Ensure SystemInlineQoS is IsStandardLayout in order to calculate max serialized size below.

Ensure UserInlineQoS is IsStandardLayout in order to calculate max serialized size below. Maximum serialized size

◆ KEY_HASH_SIZE

constexpr uint32_t eprosima::safedds::dds::KEY_HASH_SIZE = protocol::KEY_HASH_SIZE

constexpr

SampleID handle size in bytes.

◆ LIVELINESS_CHANGED_STATUS

constexpr StatusKind eprosima::safedds::dds::LIVELINESS_CHANGED_STATUS = 1UL << 12UL

constexpr

Liveliness changed status.

◆ LIVELINESS_LOST_STATUS

constexpr StatusKind eprosima::safedds::dds::LIVELINESS_LOST_STATUS = 1UL << 11UL

constexpr

Liveliness lost status.

◆ NEW_VIEW_STATE

constexpr ViewStateKind eprosima::safedds::dds::NEW_VIEW_STATE = 0x00000001

constexpr

New view state.

◆ NONE_STATUS_MASK

constexpr StatusMask eprosima::safedds::dds::NONE_STATUS_MASK = 0x00

constexpr

None status.

◆ NOT_ALIVE_DISPOSED_INSTANCE_STATE

constexpr InstanceStateKind eprosima::safedds::dds::NOT_ALIVE_DISPOSED_INSTANCE_STATE = 0x00000002U

constexpr

Not alive disposed instance state.

◆ NOT_ALIVE_NO_WRITERS_INSTANCE_STATE

constexpr InstanceStateKind eprosima::safedds::dds::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE = 0x00000004U

constexpr

Not alive no writers instance state.

◆ NOT_NEW_VIEW_STATE

constexpr ViewStateKind eprosima::safedds::dds::NOT_NEW_VIEW_STATE = 0x00000002

constexpr

Not new view state.

◆ NOT_READ_SAMPLE_STATE

constexpr SampleStateKind eprosima::safedds::dds::NOT_READ_SAMPLE_STATE = 0x00000001

constexpr

Not read sample state.

◆ OFFERED_DEADLINE_MISSED_STATUS

constexpr StatusKind eprosima::safedds::dds::OFFERED_DEADLINE_MISSED_STATUS = 1UL << 1UL

constexpr

Offered deadline missed status.

◆ OFFERED_INCOMPATIBLE_QOS_STATUS

constexpr StatusKind eprosima::safedds::dds::OFFERED_INCOMPATIBLE_QOS_STATUS = 1UL << 5UL

constexpr

Offered incompatible QoS status.

◆ PUBLICATION_MATCHED_STATUS

constexpr StatusKind eprosima::safedds::dds::PUBLICATION_MATCHED_STATUS = 1UL << 13UL

constexpr

Publication matched status.

◆ READ_SAMPLE_STATE

constexpr SampleStateKind eprosima::safedds::dds::READ_SAMPLE_STATE = 0x00000002

constexpr

Read sample state.

◆ REQUESTED_DEADLINE_MISSED_STATUS

constexpr StatusKind eprosima::safedds::dds::REQUESTED_DEADLINE_MISSED_STATUS = 1UL << 2UL

constexpr

Requested deadline missed status.

◆ REQUESTED_INCOMPATIBLE_QOS_STATUS

constexpr StatusKind eprosima::safedds::dds::REQUESTED_INCOMPATIBLE_QOS_STATUS = 1UL << 6UL

constexpr

Requested incompatible QoS status.

◆ SAFE_STATUS_MASK

constexpr StatusMask eprosima::safedds::dds::SAFE_STATUS_MASK = ANY_STATUS_MASK & ~DATA_ON_READERS_STATUS

constexpr

Safe status.

◆ SAMPLE_LOST_STATUS

constexpr StatusKind eprosima::safedds::dds::SAMPLE_LOST_STATUS = 1UL << 7UL

constexpr

Sample lost status.

◆ SAMPLE_REJECTED_STATUS

constexpr StatusKind eprosima::safedds::dds::SAMPLE_REJECTED_STATUS = 1UL << 8UL

constexpr

Sample rejected status.

◆ STATUS_FLAGS_INDEX

constexpr uint32_t eprosima::safedds::dds::STATUS_FLAGS_INDEX = 3U

constexpr

Status info flags positions in data array.

◆ STATUS_FLAGS_MASK

constexpr uint8_t eprosima::safedds::dds::STATUS_FLAGS_MASK = 0x03U

constexpr

Mask for status info flags.

◆ SUBSCRIPTION_MATCHED_STATUS

constexpr StatusKind eprosima::safedds::dds::SUBSCRIPTION_MATCHED_STATUS = 1UL << 14UL

constexpr

Subscription matched status.

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ DomainId

◆ InconsistentTopicStatus

◆ InstanceHandle

◆ InstanceStateKind

◆ InstanceStateMask

◆ KeyHash

◆ LivelinessLostStatus

◆ OwnershipStrengthValue

◆ ParticipantBuiltinTopicData

◆ PublicationBuiltinTopicData

◆ SampleLostStatus

◆ SampleStateKind

◆ SampleStateMask

◆ StatusKind

◆ StatusMask

◆ SubscriptionBuiltinTopicData

◆ ViewStateKind

◆ ViewStateMask

Enumeration Type Documentation

◆ DataRepresentationQosPolicyKind

◆ DestinationOrderQosPolicyKind

◆ DurabilityQosPolicyKind

◆ HistoryQosPolicyKind

◆ LivelinessQosPolicyKind

◆ OwnershipQosPolicyKind

◆ PresentationQosPolicyAccessScopeKind

◆ QosPolicyId

◆ ReliabilityQosPolicyKind

◆ ReturnCode

◆ SampleRejectedStatusKind

◆ StatusInfo

Function Documentation

◆ status_mask_has()

◆ status_mask_set()

◆ status_mask_unset()

Variable Documentation

◆ ALIVE_INSTANCE_STATE

◆ ANY_STATUS_MASK

◆ DATA_AVAILABLE_STATUS

◆ DATA_ON_READERS_STATUS

◆ END_OF_LIFE_INSTANCE_STATE

◆ HANDLE_NIL

◆ INCONSISTENT_TOPIC_STATUS

◆ INLINE_QOS_MAX_SERIALIZED_SIZE

◆ KEY_HASH_SIZE

◆ LIVELINESS_CHANGED_STATUS

◆ LIVELINESS_LOST_STATUS

◆ NEW_VIEW_STATE

◆ NONE_STATUS_MASK

◆ NOT_ALIVE_DISPOSED_INSTANCE_STATE

◆ NOT_ALIVE_NO_WRITERS_INSTANCE_STATE

◆ NOT_NEW_VIEW_STATE

◆ NOT_READ_SAMPLE_STATE

◆ OFFERED_DEADLINE_MISSED_STATUS

◆ OFFERED_INCOMPATIBLE_QOS_STATUS

◆ PUBLICATION_MATCHED_STATUS

◆ READ_SAMPLE_STATE

◆ REQUESTED_DEADLINE_MISSED_STATUS

◆ REQUESTED_INCOMPATIBLE_QOS_STATUS

◆ SAFE_STATUS_MASK

◆ SAMPLE_LOST_STATUS

◆ SAMPLE_REJECTED_STATUS

◆ STATUS_FLAGS_INDEX

◆ STATUS_FLAGS_MASK

◆ SUBSCRIPTION_MATCHED_STATUS