#include <joedb/journal/SFTP_File.h>

Inheritance diagram for joedb::SFTP_File:

Collaboration diagram for joedb::SFTP_File:

Public Member Functions
	SFTP_File (ssh::SFTP &sftp, const char *file_name)
	SFTP_File (const SFTP_File &)=delete
SFTP_File &	operator= (const SFTP_File &)=delete
size_t	pread (char *data, size_t size, int64_t offset) const override
	Read a range of bytes.
	~SFTP_File () override
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 int64_t	get_size () const
	Get the size of the file, or -1 if it is unknown.
void	full_pread (char *data, size_t size, int64_t offset) const
	Fill the buffer, or throw if the end of the file is reached.
virtual void	pwrite (const char *data, size_t size, int64_t offset)
	Write a range of bytes. Extend file size if necessary.
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, int64_t max_size=std::numeric_limits< int64_t >::max()) 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

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 12 of file SFTP_File.h.

Constructor & Destructor Documentation

◆ SFTP_File() [1/2]

joedb::SFTP_File::SFTP_File	(	ssh::SFTP &	sftp,
		const char *	file_name )

inline

Definition at line 40 of file SFTP_File.h.

◆ SFTP_File() [2/2]

joedb::SFTP_File::SFTP_File ( const SFTP_File & )

delete

◆ ~SFTP_File()

joedb::SFTP_File::~SFTP_File ( )

inlineoverride

Definition at line 65 of file SFTP_File.h.

Member Function Documentation

◆ operator=()

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

delete

◆ pread()

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

inlineoverridevirtual

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 52 of file SFTP_File.h.

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

/home/rcoulom/repos/joedb/src/joedb/journal/SFTP_File.h

Public Member Functions

Additional Inherited Members