VLink  2.1.0
A high-performance communication middleware
vlink::TriggerRecorder::Config Struct Referencefinal

Recorder-wide configuration; passed once to the constructor and read-only afterwards. More...

#include <trigger_recorder.h>

Collaboration diagram for vlink::TriggerRecorder::Config:

Public Member Functions

 Config ()
 

Public Attributes

std::string dump_dir
 Output directory; empty => {tmp}/vlink-trigger. More...
 
FileType file_type {kVdb}
 Bag container format. More...
 
int64_t default_pre_ms {15'000}
 Default pre-trigger window in ms. More...
 
int64_t default_post_ms {0}
 Default post-trigger window in ms. More...
 
int64_t default_max_packet_size {4LL * 1024 * 1024}
 Default per-packet byte limit in bytes (0 = unlimited). More...
 
int64_t default_max_size {0}
 Default per-URL ring byte cap (0 = unlimited). More...
 
int64_t max_cache_size {2LL * 1024 * 1024 * 1024}
 Global ring byte cap across all URLs. More...
 
int64_t retention_guard_ms {500}
 Extra retention margin to absorb dump-timer jitter. More...
 
int max_dump_file_count {10}
 Rotation cap; only auto-named dumps trigger dump_dir rotation. More...
 
bool enable_compress {false}
 Compress the dumped bag. More...
 
bool busy_skip_data {false}
 Drop incoming data while a bag is being written. More...
 
bool destroy_on_offline {false}
 Destroy offline subscribers; an in-flight dump keeps their data. More...
 
OverflowPolicy overflow {kDropNewest}
 Byte-cap overflow policy. More...
 
int64_t sleep_interval {4LL * 1024 * 1024}
 Dump input throttle: sleep after this many bytes submitted. More...
 
int64_t sleep_time_ms {0}
 Dump input-throttle sleep duration in ms (0 disables). More...
 
DiscoveryViewer::FilterType discovery_filter {DiscoveryViewer::kFilterAvailable}
 Discovery filter. More...
 
std::vector< std::string > whitelist
 If non-empty, only these exact URLs are recorded. More...
 
std::vector< std::string > blacklist
 These exact URLs are never recorded. More...
 
std::unordered_map< std::string, UrlConfigurl_overrides
 Per-URL window / limit overrides. More...
 

Detailed Description

Recorder-wide configuration; passed once to the constructor and read-only afterwards.

Constructor & Destructor Documentation

◆ Config()

vlink::TriggerRecorder::Config::Config ( )
inline

Member Data Documentation

◆ blacklist

std::vector<std::string> vlink::TriggerRecorder::Config::blacklist

These exact URLs are never recorded.

◆ busy_skip_data

bool vlink::TriggerRecorder::Config::busy_skip_data {false}

Drop incoming data while a bag is being written.

◆ default_max_packet_size

int64_t vlink::TriggerRecorder::Config::default_max_packet_size {4LL * 1024 * 1024}

Default per-packet byte limit in bytes (0 = unlimited).

◆ default_max_size

int64_t vlink::TriggerRecorder::Config::default_max_size {0}

Default per-URL ring byte cap (0 = unlimited).

◆ default_post_ms

int64_t vlink::TriggerRecorder::Config::default_post_ms {0}

Default post-trigger window in ms.

◆ default_pre_ms

int64_t vlink::TriggerRecorder::Config::default_pre_ms {15'000}

Default pre-trigger window in ms.

◆ destroy_on_offline

bool vlink::TriggerRecorder::Config::destroy_on_offline {false}

Destroy offline subscribers; an in-flight dump keeps their data.

◆ discovery_filter

DiscoveryViewer::FilterType vlink::TriggerRecorder::Config::discovery_filter {DiscoveryViewer::kFilterAvailable}

Discovery filter.

◆ dump_dir

std::string vlink::TriggerRecorder::Config::dump_dir

Output directory; empty => {tmp}/vlink-trigger.

◆ enable_compress

bool vlink::TriggerRecorder::Config::enable_compress {false}

Compress the dumped bag.

◆ file_type

FileType vlink::TriggerRecorder::Config::file_type {kVdb}

Bag container format.

◆ max_cache_size

int64_t vlink::TriggerRecorder::Config::max_cache_size {2LL * 1024 * 1024 * 1024}

Global ring byte cap across all URLs.

◆ max_dump_file_count

int vlink::TriggerRecorder::Config::max_dump_file_count {10}

Rotation cap; only auto-named dumps trigger dump_dir rotation.

◆ overflow

OverflowPolicy vlink::TriggerRecorder::Config::overflow {kDropNewest}

Byte-cap overflow policy.

◆ retention_guard_ms

int64_t vlink::TriggerRecorder::Config::retention_guard_ms {500}

Extra retention margin to absorb dump-timer jitter.

◆ sleep_interval

int64_t vlink::TriggerRecorder::Config::sleep_interval {4LL * 1024 * 1024}

Dump input throttle: sleep after this many bytes submitted.

◆ sleep_time_ms

int64_t vlink::TriggerRecorder::Config::sleep_time_ms {0}

Dump input-throttle sleep duration in ms (0 disables).

◆ url_overrides

std::unordered_map<std::string, UrlConfig> vlink::TriggerRecorder::Config::url_overrides

Per-URL window / limit overrides.

◆ whitelist

std::vector<std::string> vlink::TriggerRecorder::Config::whitelist

If non-empty, only these exact URLs are recorded.


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