Fawkes API  Fawkes Development Version
bblog_file_header Struct Reference

BBLogger file header definition. More...

#include <file.h>

Public Attributes

uint32_t file_magic
 Magic value to identify file, must be 0xFFBBFFBB (big endian) More...
 
uint32_t file_version
 File version, set to BBLOGGER_FILE_VERSION on write and verify on read (big endian) More...
 
uint32_t endianess: 1
 Endianess, 0 little endian, 1 big endian. More...
 
uint32_t reserved: 31
 Reserved for future use. More...
 
uint32_t num_data_items
 Number of data items in file, if set to zero reader must scan the file for this number. More...
 
char scenario [BBLOG_SCENARIO_SIZE]
 Scenario as defined in config. More...
 
char interface_type [BBLOG_INTERFACE_TYPE_SIZE]
 Interface type. More...
 
char interface_id [BBLOG_INTERFACE_ID_SIZE]
 Interface ID. More...
 
unsigned char interface_hash [BBLOG_INTERFACE_HASH_SIZE]
 Interface Hash. More...
 
uint32_t data_size
 size of one interface data block More...
 
uint64_t start_time_sec
 Start time, timestamp seconds. More...
 
uint64_t start_time_usec
 Start time, timestamp microseconds. More...
 

Detailed Description

BBLogger file header definition.

To identify log files created for different interfaces but belonging to a single run files must be

  • created at the exact same timestamp (filename and start_time_* fields
  • have the same scenario id The file_version is stored in network byte order. Anything beyond this is stored in the native system format, read the endianess field to check whether you must do data conversion.

Definition at line 53 of file file.h.

Member Data Documentation

◆ data_size

uint32_t bblog_file_header::data_size

size of one interface data block

Definition at line 67 of file file.h.

Referenced by BBLoggerThread::set_threadlist().

◆ endianess

uint32_t bblog_file_header::endianess

Endianess, 0 little endian, 1 big endian.

Definition at line 58 of file file.h.

Referenced by BBLoggerThread::set_threadlist().

◆ file_magic

uint32_t bblog_file_header::file_magic

Magic value to identify file, must be 0xFFBBFFBB (big endian)

Definition at line 54 of file file.h.

Referenced by BBLoggerThread::set_threadlist().

◆ file_version

uint32_t bblog_file_header::file_version

File version, set to BBLOGGER_FILE_VERSION on write and verify on read (big endian)

Definition at line 56 of file file.h.

Referenced by BBLoggerThread::set_threadlist().

◆ interface_hash

unsigned char bblog_file_header::interface_hash[BBLOG_INTERFACE_HASH_SIZE]

Interface Hash.

Definition at line 66 of file file.h.

Referenced by BBLoggerThread::set_threadlist().

◆ interface_id

char bblog_file_header::interface_id[BBLOG_INTERFACE_ID_SIZE]

Interface ID.

Definition at line 65 of file file.h.

Referenced by BBLoggerThread::set_threadlist().

◆ interface_type

char bblog_file_header::interface_type[BBLOG_INTERFACE_TYPE_SIZE]

Interface type.

Definition at line 64 of file file.h.

Referenced by BBLoggerThread::set_threadlist().

◆ num_data_items

uint32_t bblog_file_header::num_data_items

Number of data items in file, if set to zero reader must scan the file for this number.

Definition at line 60 of file file.h.

Referenced by BBLogFile::set_num_entries(), and BBLoggerThread::set_threadlist().

◆ reserved

uint32_t bblog_file_header::reserved

Reserved for future use.

Definition at line 59 of file file.h.

◆ scenario

char bblog_file_header::scenario[BBLOG_SCENARIO_SIZE]

Scenario as defined in config.

Definition at line 62 of file file.h.

Referenced by BBLoggerThread::set_threadlist().

◆ start_time_sec

uint64_t bblog_file_header::start_time_sec

Start time, timestamp seconds.

Definition at line 68 of file file.h.

Referenced by BBLoggerThread::set_threadlist().

◆ start_time_usec

uint64_t bblog_file_header::start_time_usec

Start time, timestamp microseconds.

Definition at line 69 of file file.h.

Referenced by BBLoggerThread::set_threadlist().


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