Public Attributes | List of all members
mcap::Message Struct Reference

A single Message published to a Channel. More...

#include <types.hpp>

Public Attributes

ChannelId channelId
 
const std::byte * data = nullptr
 A pointer to the message payload. For readers, this pointer is only valid for the lifetime of an onMessage callback or before the message iterator is advanced. More...
 
uint64_t dataSize
 Size of the message payload in bytes, pointed to via data. More...
 
Timestamp logTime
 Nanosecond timestamp when this message was recorded or received for recording. More...
 
Timestamp publishTime
 Nanosecond timestamp when this message was initially published. If not available, this should be set to logTime. More...
 
uint32_t sequence
 An optional sequence number. If non-zero, sequence numbers should be unique per channel and increasing over time. More...
 

Detailed Description

A single Message published to a Channel.

Definition at line 181 of file types.hpp.

Member Data Documentation

◆ channelId

ChannelId mcap::Message::channelId

Definition at line 182 of file types.hpp.

◆ data

const std::byte* mcap::Message::data = nullptr

A pointer to the message payload. For readers, this pointer is only valid for the lifetime of an onMessage callback or before the message iterator is advanced.

Definition at line 207 of file types.hpp.

◆ dataSize

uint64_t mcap::Message::dataSize

Size of the message payload in bytes, pointed to via data.

Definition at line 201 of file types.hpp.

◆ logTime

Timestamp mcap::Message::logTime

Nanosecond timestamp when this message was recorded or received for recording.

Definition at line 192 of file types.hpp.

◆ publishTime

Timestamp mcap::Message::publishTime

Nanosecond timestamp when this message was initially published. If not available, this should be set to logTime.

Definition at line 197 of file types.hpp.

◆ sequence

uint32_t mcap::Message::sequence

An optional sequence number. If non-zero, sequence numbers should be unique per channel and increasing over time.

Definition at line 187 of file types.hpp.


The documentation for this struct was generated from the following file:


plotjuggler
Author(s): Davide Faconti
autogenerated on Mon Nov 11 2024 03:23:52