Class astutedds::dcps::WriterLiveliness

Class astutedds::dcps::WriterLiveliness

ClassList > astutedds > dcps > WriterLiveliness

Per-writer liveliness assertion helper. More...

  • #include <liveliness_manager.hpp>

Public Functions

Type Name
WriterLiveliness (LivelinessManager & manager, const rtps::GUID_t & writer_guid, const LivelinessQosPolicy & qos)
Construct writer liveliness helper.
bool assert_liveliness ()
Assert liveliness for this writer.
LivelinessLostStatus get_liveliness_lost_status () const
Get liveliness lost status.
void on_data_written ()
Called when writer sends data.
void set_listener (LivelinessLostCallback callback)
Set callback for liveliness lost.
~WriterLiveliness ()

Detailed Description

Provides convenient methods for asserting liveliness from DataWriter context.

Public Functions Documentation

function WriterLiveliness

Construct writer liveliness helper. 

astutedds::dcps::WriterLiveliness::WriterLiveliness (
    LivelinessManager & manager,
    const rtps::GUID_t & writer_guid,
    const LivelinessQosPolicy & qos
)

Parameters:

  • manager Reference to the participant's liveliness manager
  • writer_guid GUID of the associated writer
  • qos Liveliness QoS policy

function assert_liveliness

Assert liveliness for this writer. 

bool astutedds::dcps::WriterLiveliness::assert_liveliness ()

Returns:

true if successful

function get_liveliness_lost_status

Get liveliness lost status. 

LivelinessLostStatus astutedds::dcps::WriterLiveliness::get_liveliness_lost_status () const

Returns:

Current status

function on_data_written

Called when writer sends data. 

void astutedds::dcps::WriterLiveliness::on_data_written ()

function set_listener

Set callback for liveliness lost. 

void astutedds::dcps::WriterLiveliness::set_listener (
    LivelinessLostCallback callback
)

Parameters:

  • callback Function to call

function ~WriterLiveliness

astutedds::dcps::WriterLiveliness::~WriterLiveliness ()

The documentation for this class was generated from the following file include/astutedds/dcps/liveliness_manager.hpp