iox::dds::DataReader🔗
Abstraction for DDS Data Readers.
#include <iceoryx_dds/dds/data_reader.hpp>
Inherited by iox::dds::CycloneDataReader
Public Functions🔗
Name | |
---|---|
virtual void | connect() =0 Connect the DataReader to the underlying DDS network. |
virtual iox::cxx::optional< IoxChunkDatagramHeader > | peekNextIoxChunkDatagramHeader() =0 peekNextIoxChunkDatagramHeader Get the IoxChunkDatagramHeader of the next sample if one is available. |
virtual bool | hasSamples() =0 Checks if new samples are ready to take. |
virtual iox::cxx::expected< DataReaderError > | takeNext(const IoxChunkDatagramHeader datagramHeader, uint8_t const userHeaderBuffer, uint8_t const userPayloadBuffer) =0 take Take the next available sample from the DDS data space. |
virtual capro::IdString_t | getServiceId() const =0 get ID of the service |
virtual capro::IdString_t | getInstanceId() const =0 get ID of the instance |
virtual capro::IdString_t | getEventId() const =0 get ID of the event |
Protected Functions🔗
Name | |
---|---|
DataReader() =default |
Public Functions Documentation🔗
function connect🔗
virtual void connect() =0
Connect the DataReader to the underlying DDS network.
Reimplemented by: iox::dds::CycloneDataReader::connect
function peekNextIoxChunkDatagramHeader🔗
virtual iox::cxx::optional< IoxChunkDatagramHeader > peekNextIoxChunkDatagramHeader() =0
peekNextIoxChunkDatagramHeader Get the IoxChunkDatagramHeader of the next sample if one is available.
Return: The IoxChunkDatagramHeader of the next sample if one is available.
Reimplemented by: iox::dds::CycloneDataReader::peekNextIoxChunkDatagramHeader
function hasSamples🔗
virtual bool hasSamples() =0
Checks if new samples are ready to take.
Return: True if new samples are available.
Reimplemented by: iox::dds::CycloneDataReader::hasSamples
function takeNext🔗
virtual iox::cxx::expected< DataReaderError > takeNext(
const IoxChunkDatagramHeader datagramHeader,
uint8_t *const userHeaderBuffer,
uint8_t *const userPayloadBuffer
) =0
take Take the next available sample from the DDS data space.
Parameters:
- datagramHeader with size information
- userHeaderBuffer buffer for the user-header
- userPayloadBuffer buffer for the user-payload
Return: Error if unsuccessful.
Reimplemented by: iox::dds::CycloneDataReader::takeNext
function getServiceId🔗
virtual capro::IdString_t getServiceId() const =0
get ID of the service
Reimplemented by: iox::dds::CycloneDataReader::getServiceId
function getInstanceId🔗
virtual capro::IdString_t getInstanceId() const =0
get ID of the instance
Reimplemented by: iox::dds::CycloneDataReader::getInstanceId
function getEventId🔗
virtual capro::IdString_t getEventId() const =0
get ID of the event
Reimplemented by: iox::dds::CycloneDataReader::getEventId
Protected Functions Documentation🔗
function DataReader🔗
DataReader() =default
Updated on 17 March 2022 at 12:15:57 CET