Class astutedds::dcps::DataWriter

Class astutedds::dcps::DataWriter

ClassList > astutedds > dcps > DataWriter

Publishes data samples to a topic.

  • #include <dcps.hpp>

Public Types

Type Name
typedef std::function< void(const std::vector< uint8_t > &)> SendCallback
typedef std::function< void(const std::vector< uint8_t > &, const std::vector< uint8_t > &)> SendDualCallback

Public Functions

Type Name
DataWriter (Topic * topic, Publisher * publisher)
void add_matched_reader (const rtps::GUID_t & reader_guid)
bool dispose (uint64_t handle)
Dispose a type instance.
const DataWriterQos & get_qos () const
Topic * get_topic () const
const rtps::GUID_t & guid () const
const std::deque< CacheChange > & history_cache () const
void notify_write ()
void process_acknack (const rtps::GUID_t & reader_guid, const std::set< uint32_t > & requested_sns, rtps::Count_t count)
Publisher * publisher () const
uint64_t register_instance ()
Register a type instance.
void remove_expired_samples ()
void remove_matched_reader (const rtps::GUID_t & reader_guid)
void set_guid (const rtps::GUID_t & guid)
void set_qos (const DataWriterQos & qos)
void set_send_callback (SendCallback callback)
void set_send_dual_callback (SendDualCallback callback)
void start_deadline_timer ()
void stop_deadline_timer ()
Topic * topic () const
bool unregister_instance (uint64_t handle)
Unregister a type instance.
ReturnCode_t wait_for_acknowledgments (const Duration_t & max_wait)
Wait for acknowledgments from all matched readers.
bool write (const std::vector< uint8_t > & data)
Write a serialized data sample.
bool write (const std::vector< uint8_t > & xcdr1Data, const std::vector< uint8_t > & xcdr2Data)
Write dual-encoded data (XCDR1 + XCDR2)
virtual ~DataWriter () = default

Public Types Documentation

typedef SendCallback

using astutedds::dcps::DataWriter::SendCallback =  std::function<void(const std::vector<uint8_t> &)>;

typedef SendDualCallback

using astutedds::dcps::DataWriter::SendDualCallback =  std::function<void(const std::vector<uint8_t> &, const std::vector<uint8_t> &)>;

Public Functions Documentation

function DataWriter

astutedds::dcps::DataWriter::DataWriter (
    Topic * topic,
    Publisher * publisher
)

function add_matched_reader

void astutedds::dcps::DataWriter::add_matched_reader (
    const rtps::GUID_t & reader_guid
)

function dispose

Dispose a type instance. 

bool astutedds::dcps::DataWriter::dispose (
    uint64_t handle
)

function get_qos

inline const DataWriterQos & astutedds::dcps::DataWriter::get_qos () const

function get_topic

inline Topic * astutedds::dcps::DataWriter::get_topic () const

function guid

inline const rtps::GUID_t & astutedds::dcps::DataWriter::guid () const

function history_cache

inline const std::deque< CacheChange > & astutedds::dcps::DataWriter::history_cache () const

function notify_write

void astutedds::dcps::DataWriter::notify_write ()

function process_acknack

void astutedds::dcps::DataWriter::process_acknack (
    const rtps::GUID_t & reader_guid,
    const std::set< uint32_t > & requested_sns,
    rtps::Count_t count
)

function publisher

inline Publisher * astutedds::dcps::DataWriter::publisher () const

function register_instance

Register a type instance. 

uint64_t astutedds::dcps::DataWriter::register_instance ()

Returns:

Instance handle

function remove_expired_samples

void astutedds::dcps::DataWriter::remove_expired_samples ()

function remove_matched_reader

void astutedds::dcps::DataWriter::remove_matched_reader (
    const rtps::GUID_t & reader_guid
)

function set_guid

inline void astutedds::dcps::DataWriter::set_guid (
    const rtps::GUID_t & guid
)

function set_qos

void astutedds::dcps::DataWriter::set_qos (
    const DataWriterQos & qos
)

function set_send_callback

inline void astutedds::dcps::DataWriter::set_send_callback (
    SendCallback callback
)

function set_send_dual_callback

inline void astutedds::dcps::DataWriter::set_send_dual_callback (
    SendDualCallback callback
)

function start_deadline_timer

void astutedds::dcps::DataWriter::start_deadline_timer ()

function stop_deadline_timer

void astutedds::dcps::DataWriter::stop_deadline_timer ()

function topic

inline Topic * astutedds::dcps::DataWriter::topic () const

function unregister_instance

Unregister a type instance. 

bool astutedds::dcps::DataWriter::unregister_instance (
    uint64_t handle
)

function wait_for_acknowledgments

Wait for acknowledgments from all matched readers. 

inline ReturnCode_t astutedds::dcps::DataWriter::wait_for_acknowledgments (
    const Duration_t & max_wait
)

Parameters:

  • max_wait Maximum time to wait

Returns:

RETCODE_OK or RETCODE_TIMEOUT

function write [1/2]

Write a serialized data sample. 

bool astutedds::dcps::DataWriter::write (
    const std::vector< uint8_t > & data
)

Parameters:

  • data Serialized data bytes

Returns:

true on success

function write [2/2]

Write dual-encoded data (XCDR1 + XCDR2) 

bool astutedds::dcps::DataWriter::write (
    const std::vector< uint8_t > & xcdr1Data,
    const std::vector< uint8_t > & xcdr2Data
)

Parameters:

  • xcdr1Data XCDR1 serialized data
  • xcdr2Data XCDR2 serialized data

Returns:

true on success

function ~DataWriter

virtual astutedds::dcps::DataWriter::~DataWriter () = default

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