VLink  2.3.0
A high-performance communication middleware
vlink::LoggerBackend::Config Struct Referencefinal

Construction-time queue, file and formatting settings. More...

#include <logger_backend.h>

Collaboration diagram for vlink::LoggerBackend::Config:

Public Attributes

std::string app_name
 Application name used by fixed-name rotation. More...
 
std::string log_path
 Base directory for generated log files. More...
 
size_t max_file_size {0}
 Rotation threshold in bytes; must be non-zero. More...
 
size_t max_files {0}
 Timestamp retention target, or fixed-name backups excluding the active file. More...
 
size_t queue_size {0}
 Dispatcher queue capacity; zero is clamped to one. More...
 
uint32_t flush_interval_ms {0}
 Periodic flush interval; zero flushes each record. More...
 
bool fixed_filename {false}
 Use <app>.log plus numeric backups when true. More...
 
bool append {false}
 Continue the active/latest file instead of starting a new file. More...
 
bool block_when_full {false}
 When true, block all producers; Error/Fatal are always protected. More...
 
bool use_utc {false}
 Format timestamps and filenames in UTC. More...
 

Detailed Description

Construction-time queue, file and formatting settings.

Member Data Documentation

◆ app_name

std::string vlink::LoggerBackend::Config::app_name

Application name used by fixed-name rotation.

◆ append

bool vlink::LoggerBackend::Config::append {false}

Continue the active/latest file instead of starting a new file.

◆ block_when_full

bool vlink::LoggerBackend::Config::block_when_full {false}

When true, block all producers; Error/Fatal are always protected.

◆ fixed_filename

bool vlink::LoggerBackend::Config::fixed_filename {false}

Use <app>.log plus numeric backups when true.

◆ flush_interval_ms

uint32_t vlink::LoggerBackend::Config::flush_interval_ms {0}

Periodic flush interval; zero flushes each record.

◆ log_path

std::string vlink::LoggerBackend::Config::log_path

Base directory for generated log files.

◆ max_file_size

size_t vlink::LoggerBackend::Config::max_file_size {0}

Rotation threshold in bytes; must be non-zero.

◆ max_files

size_t vlink::LoggerBackend::Config::max_files {0}

Timestamp retention target, or fixed-name backups excluding the active file.

◆ queue_size

size_t vlink::LoggerBackend::Config::queue_size {0}

Dispatcher queue capacity; zero is clamped to one.

◆ use_utc

bool vlink::LoggerBackend::Config::use_utc {false}

Format timestamps and filenames in UTC.


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