RTI Connext Micro C API  2.4.14.2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
LIVELINESS

Determines the mechanism and parameters used by the application to determine whether a DDS_Entity is alive. More...

Data Structures

struct  DDS_LivelinessQosPolicy
 <<cert>> Determines the mechanism and parameters used by the application to determine whether a DDS_Entity is alive. More...

Enumerations

enum  DDS_LivelinessQosPolicyKind { DDS_AUTOMATIC_LIVELINESS_QOS, DDS_MANUAL_BY_PARTICIPANT_LIVELINESS_QOS, DDS_MANUAL_BY_TOPIC_LIVELINESS_QOS }
 Kinds of liveliness. More...

Variables

const char *const DDS_LIVELINESS_QOS_POLICY_NAME
 Stringified human-readable name for DDS_LivelinessQosPolicy.

Detailed Description

Determines the mechanism and parameters used by the application to determine whether a DDS_Entity is alive.


Enumeration Type Documentation

Kinds of liveliness.

QoS:
DDS_LivelinessQosPolicy
Enumerator:
DDS_AUTOMATIC_LIVELINESS_QOS 

[default] The infrastructure will automatically signal liveliness for the DDS_DataWriter (s) at least as often as required by the DDS_DataWriter (S) lease_duration.

A DDS_DataWriter with this setting does not need to take any specific action in order to be considered 'alive.' The DDS_DataWriter is only 'not alive' when the participant to which it belongs terminates (gracefully or not), or when there is a network problem that prevents the current participant from contacting that remote participant.

Only DDS_DURATION_INFINITE is supported for lease_duration. Finite lease_duration is not supported with this liveliness setting.

DDS_MANUAL_BY_PARTICIPANT_LIVELINESS_QOS 

RTI Connext Micro will assume that as long as at least one DDS_DataWriter belonging to the DDS_DomainParticipant (or the DDS_DomainParticipant itself) has asserted its liveliness, then the other DataWriters belonging to that same DDS_DomainParticipant are also alive.

Only DDS_DURATION_INFINITE is supported for lease_duration. Finite lease_duration is not supported with this liveliness setting.

The user application takes responsibility to signal liveliness to RTI Connext Micro by calling DDS_DataWriter_assert_liveliness, or FooDataWriter_write on any DDS_DataWriter belonging to the DDS_DomainParticipant.

DDS_MANUAL_BY_TOPIC_LIVELINESS_QOS 

RTI Connext Micro will only assume liveliness of the DDS_DataWriter if the application has asserted liveliness of that DDS_DataWriter itself.

The user application takes responsibility to signal liveliness to RTI Connext Micro using the DDS_DataWriter_assert_liveliness function, or by writing some data.


Variable Documentation

const char* const DDS_LIVELINESS_QOS_POLICY_NAME

Stringified human-readable name for DDS_LivelinessQosPolicy.


RTI Connext Micro C API 2.4.14.2 Copyright © Tue May 28 2024 Real-Time Innovations, Inc