libjf API reference guide

Main Page | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

jf_journal_opts_s Struct Reference

#include <jf_journal.h>


Data Fields

jf_word_t file_num
jf_offset_t file_size
uint32_t flags
jf_journal_file_opts_s journal_file_opts
uint32_t recovery_analyze_flags
int recovery_damaged_journal
int recovery_enabled
double rotation_threshold


Detailed Description

PUBLIC STRUCT
This struct is used to pass optional parameters for journal and related journaled files initialization

Definition at line 286 of file jf_journal.h.


Field Documentation

jf_word_t jf_journal_opts_s::file_num
 

number of old journal must be kept (meaningless if the journal already exists). Use 0 to specify default value
Definition at line 338 of file jf_journal.h.

Referenced by jf_journal_create(), and jf_set_default_journal_opts().

jf_offset_t jf_journal_opts_s::file_size
 

(max) size (bytes) of journal file: the value is an approximation because check is done only at jf_journal_close time (meaningless if the journal already exists). Use 0 to specify default value
Definition at line 332 of file jf_journal.h.

Referenced by jf_journal_create(), and jf_set_default_journal_opts().

uint32_t jf_journal_opts_s::flags
 

Journal properties:
one among
JF_JOURNAL_PROP_VIRTMEM_LOW / JF_JOURNAL_PROP_VIRTMEM_MEDIUM / JF_JOURNAL_PROP_VIRTMEM_HIGH / JF_JOURNAL_PROP_VIRTMEM_ENV_VAR / JF_JOURNAL_PROP_VIRTMEM_DEFAULT /
OR-ed with one among
JF_JOURNAL_PROP_SYNC_FAST / JF_JOURNAL_PROP_SYNC_SAFE / JF_JOURNAL_PROP_SYNC_ENV_VAR / JF_JOURNAL_PROP_SYNC_DEFAULT / JF_JOURNAL_PROP_SYNC_SUGGESTED
OR-ed with any of
JF_JOURNAL_PROP_OPEN_O_CREAT JF_JOURNAL_PROP_OPEN_O_EXCL
Definition at line 305 of file jf_journal.h.

Referenced by bench_X0_ljf_pre(), jf_file_open(), jf_journal_close_detach_file(), jf_journal_get_open_opts_flags(), jf_journal_init(), jf_journal_open(), jf_journal_rotate(), jf_journal_sync(), jf_set_default_journal_opts(), and main().

struct jf_journal_file_opts_s jf_journal_opts_s::journal_file_opts
 

Journal file specific options
Definition at line 349 of file jf_journal.h.

Referenced by jf_file_open(), jf_journal_create(), and jf_set_default_journal_opts().

uint32_t jf_journal_opts_s::recovery_analyze_flags
 

Flags will be used to dump data if an automatic journal recovery phase is executed; available values are "0" or a combination (|) of the following:

Definition at line 324 of file jf_journal.h.

Referenced by jf_journal_cold_recovery(), jf_journal_cold_recovery_analyze(), jf_journal_cold_recovery_prep_pool(), jf_set_default_journal_opts(), and main().

int jf_journal_opts_s::recovery_damaged_journal
 

Boolean value used to specify if jf_journal_open can perform a (cold) recovery when opening a damaged journal
Definition at line 315 of file jf_journal.h.

Referenced by jf_journal_cold_recovery(), jf_journal_cold_recovery_analyze(), jf_journal_cold_recovery_prep_pool(), jf_set_default_journal_opts(), and main().

int jf_journal_opts_s::recovery_enabled
 

Boolean value used to specify if jf_journal_open can perform a (cold) recovery when opening journal
Definition at line 310 of file jf_journal.h.

Referenced by jf_journal_cold_recovery(), jf_journal_util_join(), jf_journal_util_leave(), jf_journal_util_rename(), jf_set_default_journal_opts(), and main().

double jf_journal_opts_s::rotation_threshold
 

Fractional value between 0.0 and 1.0; when threshold is reached, journal rotation will be perfomed at first global (JF_JOURNAL_GLOBAL_FILE_ID) sync point (rollback or commit)
Definition at line 345 of file jf_journal.h.

Referenced by jf_journal_commit_int(), jf_journal_rollback_int(), jf_journal_trace(), and jf_set_default_journal_opts().


The documentation for this struct was generated from the following file:
Copyright 2005 © Tiian