Journal

Files, and joedb file format. More...

Classes
class	joedb::Abstract_File
class	joedb::Async_Reader
class	joedb::Async_Writer
class	joedb::Brotli_Codec
class	joedb::Brotli_Decoder
class	joedb::Brotli_File
class	joedb::Buffer< log_size >
class	joedb::Codec
class	joedb::CURL_File
class	joedb::Decoder
class	joedb::Encoded_File
class	joedb::File_Buffer
class	joedb::File_Hasher
class	joedb::Journal_Hasher
class	joedb::File_Iterator
class	joedb::File_Slice
class	joedb::filebuf
	https://en.cppreference.com/w/cpp/io/basic_streambuf.html More...
class	joedb::fstream
class	joedb::ifstream
class	joedb::ofstream
class	joedb::Identity_Codec
class	joedb::Abstract_Interpreted_File
	This class allows accessing a file in joedbi text format. More...
class	joedb::Interpreted_File
class	joedb::iostream
class	joedb::Journal_Construction_Lock
class	joedb::Memory_File
class	joedb::Portable_File
class	joedb::Posix_File
class	joedb::Readonly_Brotli_File
class	joedb::Readonly_Encoded_File
class	joedb::Readonly_Journal
class	joedb::Readonly_Memory_File
class	joedb::SFTP_File
class	joedb::SHA_256
	Compute SHA 256 hash code: https://en.wikipedia.org/wiki/SHA-2. More...
class	joedb::Stream_File
class	joedb::Upgradable_File< Parent >
class	joedb::Windows_File
class	joedb::Writable_Journal

Enumerations
enum class	joedb::Recovery { joedb::Recovery::none = 0 , joedb::Recovery::ignore_header = 1 , joedb::Recovery::overwrite = 2 }
enum class	joedb::Open_Mode {   joedb::Open_Mode::read_existing , joedb::Open_Mode::write_existing , joedb::Open_Mode::create_new , joedb::Open_Mode::write_existing_or_create_new ,   joedb::Open_Mode::shared_write , joedb::Open_Mode::write_lock , joedb::Open_Mode::truncate , joedb::Open_Mode::mode_count }

Functions
void	joedb::dump_header (std::ostream &out, Abstract_File &file)
void	joedb::about_joedb (std::ostream &out)

Detailed Description

Enumeration Type Documentation

Open_Mode

enum class joedb::Open_Mode

strong

Enumerator
read_existing	fails if does not exist
write_existing	fails if does not exist or locked, locks the file for writing
create_new	fails if already exists, locks the file for writing
write_existing_or_create_new	either write_existing or create_new depending on whether the file exists. Racy in Posix, not in Windows.
shared_write	like write_existing_or_create_new, but does not lock the file, and does not fail if locked
write_lock	like write_existing_or_create_new, but waits instead of failing if already locked
truncate	create new file, or truncate existing file, and locks the file
mode_count	number of modes

Definition at line 7 of file Open_Mode.h.

Recovery

enum class joedb::Recovery

strong

Enumerator
none	default: fail if file size > checkpoint
ignore_header	use file size as checkpoint
overwrite	allow overwriting an uncheckpointed tail

Definition at line 9 of file Journal_Construction_Lock.h.

Function Documentation

about_joedb()

void joedb::about_joedb

(

std::ostream &

out

)

Definition at line 52 of file diagnostics.cpp.

dump_header()

void joedb::dump_header	(	std::ostream &	out,
		Abstract_File &	file
	)

Definition at line 30 of file diagnostics.cpp.