struct IndexedMessageReader

Declaration

struct IndexedMessageReader { /* full declaration omitted */ };

Description

Uses message indices to read messages out of an MCAP in log time order. The underlying MCAP must be chunked, with a summary section and message indexes. The required McapWriterOptions are: - noChunking: false - noMessageIndex: false - noSummary: false

Declared at: mcap/include/mcap/reader.hpp:611

Method Overview

• public IndexedMessageReader(mcap::McapReader & reader, const mcap::ReadMessageOptions & options, const std::function<void (const Message &, RecordOffset)> onMessage)
• public bool next()
• public mcap::Status status() const

Methods

¶IndexedMessageReader(
    mcap::McapReader& reader,
    const mcap::ReadMessageOptions& options,
    const std::function<void(const Message&,
                             RecordOffset)>
        onMessage)

Declared at: mcap/include/mcap/reader.hpp:613

Parameters

mcap::McapReader& reader

const mcap::ReadMessageOptions& options

const std::function<void(const Message&, RecordOffset)> onMessage

¶bool next()

Description

reads the next message out of the MCAP.

Declared at: mcap/include/mcap/reader.hpp:623

Returns

false if no more messages are to be read. If there was some error reading the MCAP, `status()` will return a non-Success status.

¶mcap::Status status() const

Description

gets the status of the reader.

Declared at: mcap/include/mcap/reader.hpp:630

Returns

Status