joedb::Posix_FD Class Reference

#include <joedb/journal/Posix_File.h>

Inheritance diagram for joedb::Posix_FD:

Collaboration diagram for joedb::Posix_FD:

Public Member Functions
	Posix_FD (int fd, Open_Mode mode)
	Posix_FD (const char *file_name, Open_Mode mode)
	Posix_FD (const Posix_FD &)=delete
Posix_FD &	operator= (const Posix_FD &)=delete
int64_t	get_size () const override
	Get the size of the file, or -1 if it is unknown.
size_t	pread (char *buffer, size_t size, int64_t offset) const override
	Read a range of bytes.
void	pwrite (const char *buffer, size_t size, int64_t offset) override
	Write a range of bytes. Extend file size if necessary.
void	sync () override
	Write data and meta-data (such as file size) durably to permanent storage.
void	shared_lock (int64_t start, int64_t size) override
	Lock a range of bytes for reading (prevents writes, not reads)
void	exclusive_lock (int64_t start, int64_t size) override
	Lock a range of bytes for writing (prevents both writes and reads)
void	unlock (int64_t start, int64_t size) noexcept override
	Remove a lock. The range should match the range of a corresponding lock.
	~Posix_FD () override
Public Member Functions inherited from joedb::Buffered_File
	Buffered_File (Open_Mode mode)
void	flush ()
void	flush_for_writing ()
void	exclusive_lock_tail ()
void	unlock_tail () noexcept
bool	tail_is_locked () const noexcept
void	shared_lock_head ()
void	exclusive_lock_head ()
void	unlock_head () noexcept
bool	is_shared () const noexcept
bool	is_readonly () const noexcept
void	set_position (int64_t position)
int64_t	get_position () const noexcept
virtual void	copy_to (Buffered_File &destination, int64_t start, int64_t size) const
virtual bool	equal_to (Buffered_File &destination, int64_t from, int64_t until) const
void	copy_to (Buffered_File &destination) const
template<typename T >
void	write (T x)
template<typename T >
T	read ()
template<typename T >
void	compact_write (T x)
template<typename T >
T	compact_read ()
template<typename T >
T	read_strong_type ()
void	write_reference (Record_Id id)
Record_Id	read_reference ()
void	write_string (const std::string &s)
std::string	read_string ()
std::string	safe_read_string (int64_t max_size)
void	write_blob (Blob blob)
Blob	read_blob ()
void	write_data (const char *data, size_t n)
size_t	read_data (char *data, const size_t n)
void	ignore (const int64_t n)
std::string	read_blob (Blob blob) const
Public Member Functions inherited from joedb::Sequential_File
void	sequential_seek (int64_t new_position)
size_t	sequential_read (char *data, size_t size)
void	sequential_write (const char *data, size_t size)
int64_t	get_position () const
Public Member Functions inherited from joedb::Abstract_File
virtual void	datasync ()
	Write data durably to permanent storage.
virtual	~Abstract_File ()=default

Static Public Member Functions
static void	throw_last_error (const char *action, const char *file_name)
Static Public Member Functions inherited from joedb::Buffered_File
static void	reading_past_end_of_file ()

Protected Member Functions
bool	try_exclusive_lock (int64_t start, int64_t size)
Protected Member Functions inherited from joedb::Buffered_File
void	destructor_flush () noexcept
void	make_readonly ()
void	make_writable ()

Additional Inherited Members
Static Public Attributes inherited from joedb::Buffered_File
static constexpr int64_t	last_position = (1ULL << 63) - 1

Detailed Description

Definition at line 16 of file Posix_File.h.

Constructor & Destructor Documentation

Posix_FD() [1/3]

joedb::Posix_FD::Posix_FD ( int  fd, Open_Mode  mode  )

inline

Definition at line 29 of file Posix_File.h.

Posix_FD() [2/3]

joedb::Posix_FD::Posix_FD	(	const char *	file_name,
		Open_Mode	mode
	)

Definition at line 151 of file Posix_File.cpp.

Posix_FD() [3/3]

joedb::Posix_FD::Posix_FD ( const Posix_FD &  )

delete

~Posix_FD()

joedb::Posix_FD::~Posix_FD ( )

override

Definition at line 204 of file Posix_File.cpp.

Member Function Documentation

exclusive_lock()

void joedb::Posix_FD::exclusive_lock ( int64_t  start, int64_t  size  )

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 75 of file Posix_File.cpp.

get_size()

int64_t joedb::Posix_FD::get_size ( ) const

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 192 of file Posix_File.cpp.

operator=()

Posix_FD & joedb::Posix_FD::operator= ( const Posix_FD &  )

delete

pread()

size_t joedb::Posix_FD::pread ( char *  data, size_t  size, int64_t  offset  ) const

overridevirtual

The returned value may be less than size, even if the end of the file is not reached. 0 is returned if the end of the file is reached.

Reimplemented from joedb::Abstract_File.

Definition at line 90 of file Posix_File.cpp.

pwrite()

void joedb::Posix_FD::pwrite ( const char *  data, size_t  size, int64_t  offset  )

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 102 of file Posix_File.cpp.

shared_lock()

void joedb::Posix_FD::shared_lock ( int64_t  start, int64_t  size  )

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 67 of file Posix_File.cpp.

sync()

void joedb::Posix_FD::sync ( )

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 125 of file Posix_File.cpp.

throw_last_error()

void joedb::Posix_FD::throw_last_error ( const char *  action, const char *  file_name  )

static

Definition at line 31 of file Posix_File.cpp.

try_exclusive_lock()

bool joedb::Posix_FD::try_exclusive_lock ( int64_t  start, int64_t  size  )

protected

Definition at line 60 of file Posix_File.cpp.

unlock()

void joedb::Posix_FD::unlock ( int64_t  start, int64_t  size  )

overridevirtualnoexcept

Reimplemented from joedb::Abstract_File.

Definition at line 83 of file Posix_File.cpp.

---

The documentation for this class was generated from the following files:

• /home/rcoulom/repos/joedb/src/joedb/journal/Posix_File.h
• /home/rcoulom/repos/joedb/src/joedb/journal/Posix_File.cpp