Fawkes API  Fawkes Development Version
bblog_file_header Struct Reference

BBLogger file header definition. More...

#include <file.h>

List of all members.

Public Attributes

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

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.

Member Data Documentation

size of one interface data block

Definition at line 67 of file file.h.

Endianess, 0 little endian, 1 big endian.

Definition at line 58 of file file.h.

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

Definition at line 54 of file file.h.

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

Definition at line 56 of file file.h.

unsigned char bblog_file_header::interface_hash[BBLOG_INTERFACE_HASH_SIZE]

Interface Hash.

Definition at line 66 of file file.h.

char bblog_file_header::interface_id[BBLOG_INTERFACE_ID_SIZE]

Interface ID.

Definition at line 65 of file file.h.

char bblog_file_header::interface_type[BBLOG_INTERFACE_TYPE_SIZE]

Interface type.

Definition at line 64 of file file.h.

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().

Reserved for future use.

Definition at line 59 of file file.h.

char bblog_file_header::scenario[BBLOG_SCENARIO_SIZE]

Scenario as defined in config.

Definition at line 62 of file file.h.

Start time, timestamp seconds.

Definition at line 68 of file file.h.

Start time, timestamp microseconds.

Definition at line 69 of file file.h.


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