vlink::TriggerPluginInterface::DumpResult Struct Reference

Final outcome of a dump, delivered to on_dump_finished() / on_dump_failed(). More...

#include <trigger_plugin_interface.h>

Collaboration diagram for vlink::TriggerPluginInterface::DumpResult:

Public Attributes
std::string	reason
	Trigger reason for this dump. More...
std::string	path
	Output bag file path. More...
int64_t	frame_count {0}
	Snapshot frames accepted by the writer; a bag plugin may alter final output count. More...
int64_t	dropped_count {0}
	Retained for compatibility; a synchronous dump aborts on failure, so this stays 0. More...
int64_t	byte_count {0}
	Total payload bytes accepted by the writer. More...
int64_t	url_count {0}
	Number of URLs snapshotted into this dump. More...
int64_t	start_timestamp {0}
	Wall-clock time of the window's first frame, in milliseconds. More...
int64_t	duration_us {0}
	Wall-clock time spent writing the dump, in microseconds. More...
bool	success {false}
	true when the dump completed and the file was closed. More...
std::string	error
	Human-readable failure reason when success is false. More...

Detailed Description

Final outcome of a dump, delivered to on_dump_finished() / on_dump_failed().

Member Data Documentation

byte_count

int64_t vlink::TriggerPluginInterface::DumpResult::byte_count {0}

Total payload bytes accepted by the writer.

dropped_count

int64_t vlink::TriggerPluginInterface::DumpResult::dropped_count {0}

Retained for compatibility; a synchronous dump aborts on failure, so this stays 0.

duration_us

int64_t vlink::TriggerPluginInterface::DumpResult::duration_us {0}

Wall-clock time spent writing the dump, in microseconds.

error

std::string vlink::TriggerPluginInterface::DumpResult::error

Human-readable failure reason when success is false.

frame_count

int64_t vlink::TriggerPluginInterface::DumpResult::frame_count {0}

Snapshot frames accepted by the writer; a bag plugin may alter final output count.

path

std::string vlink::TriggerPluginInterface::DumpResult::path

Output bag file path.

reason

std::string vlink::TriggerPluginInterface::DumpResult::reason

Trigger reason for this dump.

start_timestamp

int64_t vlink::TriggerPluginInterface::DumpResult::start_timestamp {0}

Wall-clock time of the window's first frame, in milliseconds.

success

bool vlink::TriggerPluginInterface::DumpResult::success {false}

true when the dump completed and the file was closed.

url_count

int64_t vlink::TriggerPluginInterface::DumpResult::url_count {0}

Number of URLs snapshotted into this dump.

---

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

• include/vlink/extension/trigger_plugin_interface.h