joedb::Stream_File Class Reference

#include <joedb/journal/Stream_File.h>

Inheritance diagram for joedb::Stream_File:

Collaboration diagram for joedb::Stream_File:

Public Member Functions
	Stream_File (std::streambuf &streambuf, Open_Mode mode)
size_t	pread (char *data, size_t size, int64_t offset) const override
	Read a range of bytes.
void	pwrite (const char *data, size_t size, int64_t offset) override
	Write a range of bytes. Extend file size if necessary.
int64_t	get_size () const override
	Get the size of the file, or -1 if it is unknown.
Public Member Functions inherited from joedb::Abstract_File
	Abstract_File (Open_Mode mode)
bool	is_shared () const noexcept
bool	is_readonly () const noexcept
Open_Mode	get_mode () const noexcept
virtual void	sync ()
	Write data durably (including file-size change)
virtual void	datasync ()
	Write data durably (no file-size change)
virtual void	shared_lock (int64_t start, int64_t size)
	Lock a range of bytes for reading (prevents writes, not reads)
virtual void	exclusive_lock (int64_t start, int64_t size)
	Lock a range of bytes for writing (prevents both writes and reads)
virtual void	unlock (int64_t start, int64_t size) noexcept
	Remove a lock. The range should match the range of a corresponding lock.
void	exclusive_lock_tail ()
void	unlock_tail () noexcept
void	exclusive_lock_head ()
void	shared_lock_head ()
void	unlock_head () noexcept
std::string	read_blob (Blob blob) const
virtual void	copy_to (Abstract_File &destination, int64_t start, int64_t size) const
virtual bool	equal_to (const Abstract_File &destination, int64_t from, int64_t until) const
void	copy_to (Abstract_File &destination) const
virtual	~Abstract_File ()=default

Static Public Attributes
static constexpr bool	lockable = false
static constexpr bool	has_broken_posix_locking = false

Additional Inherited Members
Static Public Member Functions inherited from joedb::Abstract_File
static void	reading_past_end_of_file ()
Protected Member Functions inherited from joedb::Abstract_File
void	make_readonly ()
void	make_writable ()
Static Protected Attributes inherited from joedb::Abstract_File
static constexpr int64_t	last_position = (1ULL << 63) - 1

Detailed Description

Definition at line 11 of file Stream_File.h.

Constructor & Destructor Documentation

Stream_File()

joedb::Stream_File::Stream_File	(	std::streambuf &	streambuf,
		Open_Mode	mode
	)

Definition at line 7 of file Stream_File.cpp.

Member Function Documentation

get_size()

int64_t joedb::Stream_File::get_size ( ) const

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 26 of file Stream_File.cpp.

pread()

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

overridevirtual

For very large reads, the returned value may be less than size, even if the end of the file is not reached. It is assumed that small reads (such as the 41 bytes of the joedb header) will not be truncated. 0 is returned if the end of the file is reached.

Reimplemented from joedb::Abstract_File.

Definition at line 57 of file Stream_File.cpp.

pwrite()

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

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 67 of file Stream_File.cpp.

Member Data Documentation

has_broken_posix_locking

constexpr bool joedb::Stream_File::has_broken_posix_locking = false

staticconstexpr

Definition at line 20 of file Stream_File.h.

lockable

constexpr bool joedb::Stream_File::lockable = false

staticconstexpr

Definition at line 19 of file Stream_File.h.

---

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

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