libjf API reference guide

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

jf_journal_t Struct Reference

#include <jf_journal.h>


Data Fields

jf_offset_t ctrl_recs
jf_word_t file_id_mask
jf_word_t file_id_mask_shift
jf_word_t file_num
jf_offset_t file_size
jf_journal_file_tab_t file_table
jf_offset_t journal_recs
jf_word_t magic_number
jf_journal_opts_s open_opts
jf_journal_currec_s r
jf_word_t size_mask
jf_word_t size_mask_shift
uint32_t status
jf_word_t version


Detailed Description

PUBLIC CLASS
Journal object

Definition at line 383 of file jf_journal.h.


Field Documentation

jf_offset_t jf_journal_t::ctrl_recs
 

Starting point of journaled file control records Definition at line 429 of file jf_journal.h.

Referenced by jf_journal_create(), jf_journal_load(), jf_journal_trace(), and jf_journal_update_file_table().

jf_word_t jf_journal_t::file_id_mask
 

Mask used to isolate the file_id inside a journal control word Definition at line 396 of file jf_journal.h.

Referenced by jf_journal_apply_changes(), jf_journal_cold_recovery(), jf_journal_cold_recovery_prep_pool(), jf_journal_cold_recovery_update_lists(), jf_journal_commit_int(), jf_journal_create(), jf_journal_load(), jf_journal_remove_changes(), jf_journal_rollback_int(), jf_journal_scan_search(), jf_journal_scan_undo(), jf_journal_trace(), jf_journal_trace_record(), and jf_journal_write_record().

jf_word_t jf_journal_t::file_id_mask_shift
 

File id mask (left) shift entity Definition at line 400 of file jf_journal.h.

Referenced by jf_journal_apply_changes(), jf_journal_cold_recovery(), jf_journal_cold_recovery_prep_pool(), jf_journal_cold_recovery_update_lists(), jf_journal_commit_int(), jf_journal_create(), jf_journal_load(), jf_journal_remove_changes(), jf_journal_rollback_int(), jf_journal_scan_search(), jf_journal_scan_undo(), jf_journal_trace(), jf_journal_trace_record(), and jf_journal_write_record().

jf_word_t jf_journal_t::file_num
 

Number of old journal must be kept Definition at line 416 of file jf_journal.h.

Referenced by jf_journal_commit_int(), jf_journal_create(), jf_journal_load(), jf_journal_rollback_int(), jf_journal_shift_files(), and jf_journal_trace().

jf_offset_t jf_journal_t::file_size
 

(Max) size (bytes) of a journal file Definition at line 412 of file jf_journal.h.

Referenced by jf_journal_add_byte_data(), jf_journal_commit_int(), jf_journal_create(), jf_journal_load(), jf_journal_rollback_int(), and jf_journal_trace().

jf_journal_file_tab_t jf_journal_t::file_table
 

Definition at line 421 of file jf_journal.h.

Referenced by jf_journal_add_byte_data(), jf_journal_analyze(), jf_journal_apply_changes(), jf_journal_attach_file(), jf_journal_close(), jf_journal_close_detach_file(), jf_journal_cold_recovery(), jf_journal_cold_recovery_analyze(), jf_journal_cold_recovery_patch(), jf_journal_cold_recovery_patch_seq(), jf_journal_cold_recovery_prep_pool(), jf_journal_cold_recovery_update_lists(), jf_journal_commit_int(), jf_journal_create(), jf_journal_get_byte_data(), jf_journal_get_jfile(), jf_journal_get_stream(), jf_journal_is_all_sync(), jf_journal_is_sync(), jf_journal_load(), jf_journal_new_unit_of_work(), jf_journal_open(), jf_journal_open_attach_file(), jf_journal_remove_changes(), jf_journal_reopen_files(), jf_journal_rollback_int(), jf_journal_rotate(), jf_journal_scan_undo(), jf_journal_set_all_sync(), jf_journal_shift_files(), jf_journal_sync(), jf_journal_trace(), jf_journal_update_file_table(), jf_journal_util_leave(), jf_journal_util_rename(), jf_journal_write_record(), and jf_journal_write_records().

jf_offset_t jf_journal_t::journal_recs
 

Starting point of journal (do/undo) records Definition at line 433 of file jf_journal.h.

Referenced by jf_journal_create(), jf_journal_fetch_record(), jf_journal_load(), jf_journal_rotate(), and jf_journal_trace().

jf_word_t jf_journal_t::magic_number
 

Journal File magic number Definition at line 387 of file jf_journal.h.

Referenced by jf_journal_create(), jf_journal_load(), and jf_journal_trace().

struct jf_journal_opts_s jf_journal_t::open_opts
 

Journal options specified at open time; this field is not persistent and may changed at every jf_journal_open function call Definition at line 439 of file jf_journal.h.

Referenced by jf_journal_close_detach_file(), jf_journal_commit_int(), jf_journal_get_open_opts_flags(), jf_journal_init(), jf_journal_reset(), jf_journal_rollback_int(), jf_journal_rotate(), jf_journal_sync(), and jf_journal_trace().

struct jf_journal_currec_s jf_journal_t::r
 

Journal record; this field is a convenience field and is not persistent Definition at line 444 of file jf_journal.h.

Referenced by jf_journal_init().

jf_word_t jf_journal_t::size_mask
 

Mask used to isolate the size inside a journal control word Definition at line 404 of file jf_journal.h.

Referenced by jf_journal_apply_changes(), jf_journal_create(), jf_journal_fetch_ctrl_code(), jf_journal_fetch_record(), jf_journal_load(), jf_journal_remove_changes(), jf_journal_trace(), jf_journal_trace_record(), and jf_journal_write_record().

jf_word_t jf_journal_t::size_mask_shift
 

Size mask (left) shift entity Definition at line 408 of file jf_journal.h.

Referenced by jf_journal_apply_changes(), jf_journal_create(), jf_journal_fetch_ctrl_code(), jf_journal_fetch_record(), jf_journal_load(), jf_journal_remove_changes(), jf_journal_trace(), jf_journal_trace_record(), and jf_journal_write_record().

uint32_t jf_journal_t::status
 

Journal (and correlated journaled file) current status Definition at line 425 of file jf_journal.h.

jf_word_t jf_journal_t::version
 

Journal File version Definition at line 391 of file jf_journal.h.

Referenced by jf_journal_create(), jf_journal_load(), and jf_journal_trace().


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