VLink  2.1.0
A high-performance communication middleware
vlink::TriggerPluginInterface::TriggerContext Struct Referencefinal

Describes an accepted trigger request, delivered to on_trigger(). More...

#include <trigger_plugin_interface.h>

Collaboration diagram for vlink::TriggerPluginInterface::TriggerContext:

Public Attributes

std::string reason
 Trigger reason (also written as the bag tag). More...
 
std::string name_hint
 Requested output file-name hint (may be empty). More...
 
std::string out_file
 Explicit output path requested (empty => auto-named). More...
 
int64_t pre_ms {-1}
 Per-trigger pre window override in ms (<0 => configured default). More...
 
int64_t post_ms {-1}
 Per-trigger post window override in ms (<0 => configured default). More...
 
int64_t trigger_timestamp {0}
 Wall-clock time of the trigger instant, in microseconds. More...
 

Detailed Description

Describes an accepted trigger request, delivered to on_trigger().

Member Data Documentation

◆ name_hint

std::string vlink::TriggerPluginInterface::TriggerContext::name_hint

Requested output file-name hint (may be empty).

◆ out_file

std::string vlink::TriggerPluginInterface::TriggerContext::out_file

Explicit output path requested (empty => auto-named).

◆ post_ms

int64_t vlink::TriggerPluginInterface::TriggerContext::post_ms {-1}

Per-trigger post window override in ms (<0 => configured default).

◆ pre_ms

int64_t vlink::TriggerPluginInterface::TriggerContext::pre_ms {-1}

Per-trigger pre window override in ms (<0 => configured default).

◆ reason

std::string vlink::TriggerPluginInterface::TriggerContext::reason

Trigger reason (also written as the bag tag).

◆ trigger_timestamp

int64_t vlink::TriggerPluginInterface::TriggerContext::trigger_timestamp {0}

Wall-clock time of the trigger instant, in microseconds.


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