vlink::Frame Struct Reference

One recorded or replayed message as it flows through the bag pipeline. More...

#include <types.h>

Collaboration diagram for vlink::Frame:

Public Attributes
int64_t	timestamp {-1}
	Canonical time in microseconds (record / playback). More...
std::string	url
	Topic URL. More...
std::string	ser_type
	Serialisation type; reader fills it before user output. More...
SchemaType	schema_type {SchemaType::kUnknown}
	Coarse schema family; reader fills it before user output. More...
ActionType	action_type {ActionType::kUnknownAction}
	Recorded action kind. More...
Bytes	data
	Serialised payload bytes. More...

Detailed Description

One recorded or replayed message as it flows through the bag pipeline.

The single unit passed through every bag push / callback / record hook (BagReader, BagWriter, BagProcessor, BagPluginInterface). Passed by const reference through each hop so the payload is never deep-copied on the synchronous path; a stage that must take ownership (an async reorder cache) or rewrite a field (playback URL remap) copies explicitly, and the payload Bytes itself is normally a shallow view at the source. ser_type / schema_type are supplied by the caller on the write side; on the read side they arrive empty at a plugin's on_read(), and BagReader fills them from the bag's URL metadata before invoking the user's output callback (so a fully-populated frame reaches consumers without a separate get_ser_type() lookup).

Member Data Documentation

action_type

ActionType vlink::Frame::action_type {ActionType::kUnknownAction}

Recorded action kind.

data

Bytes vlink::Frame::data

Serialised payload bytes.

schema_type

SchemaType vlink::Frame::schema_type {SchemaType::kUnknown}

Coarse schema family; reader fills it before user output.

ser_type

std::string vlink::Frame::ser_type

Serialisation type; reader fills it before user output.

timestamp

int64_t vlink::Frame::timestamp {-1}

Canonical time in microseconds (record / playback).

url

std::string vlink::Frame::url

Topic URL.

---

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

• include/vlink/impl/types.h