Disk ARchive  2.5.11
Full featured and portable backup and archiving tool
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules
Public Member Functions | Protected Member Functions | List of all members
libdar::fichier_local Class Reference

filesystem local files More...

#include <fichier_local.hpp>

Inherits libdar::fichier_global.

Public Member Functions

 fichier_local (user_interaction &dialog, const std::string &chemin, gf_mode m, U_I permission, bool fail_if_exists, bool erase, bool furtive_mode)
 
 fichier_local (const std::string &chemin, bool furtive_mode=false)
 
 fichier_local (const fichier_local &ref)
 
const fichier_localoperator= (const fichier_local &ref)
 
virtual void change_ownership (const std::string &user, const std::string &group)
 set the ownership of the file
 
virtual void change_permission (U_I perm)
 change the permission of the file
 
infinint get_size () const
 return the size of the file
 
void fadvise (advise adv) const
 set posix_fadvise for the whole file
 
bool skippable (skippability direction, const infinint &amount)
 
bool skip (const infinint &pos)
 
bool skip_to_eof ()
 skip to the end of file
 
bool skip_relative (S_I x)
 skip relatively to the current position
 
infinint get_position () const
 get the current read/write position
 
S_I give_fd_and_terminate ()
 
- Public Member Functions inherited from libdar::fichier_global
 fichier_global (const user_interaction &dialog, gf_mode mode)
 
 fichier_global (const fichier_global &ref)
 
virtual void fadvise (advise adv) const =0
 set posix_fadvise for the whole file
 
- Public Member Functions inherited from libdar::generic_file
 generic_file (gf_mode m)
 main constructor
 
 generic_file (const generic_file &ref)
 copy constructor
 
virtual ~generic_file () throw (Ebug)
 virtual destructor, this let inherited destructor to be called even from a generic_file pointer to an inherited class
 
void terminate () const
 destructor-like call, except that it is allowed to throw exceptions
 
const generic_fileoperator= (const generic_file &ref)
 assignment operator
 
gf_mode get_mode () const
 retreive the openning mode for this object
 
virtual void read_ahead (const infinint &amount)
 
void ignore_read_ahead (bool mode)
 
U_I read (char *a, U_I size)
 read data from the generic_file More...
 
void write (const char *a, U_I size)
 write data to the generic_file More...
 
void write (const std::string &arg)
 write a string to the generic_file More...
 
S_I read_back (char &a)
 skip back one char, read on char and skip back one char
 
S_I read_forward (char &a)
 read one char
 
virtual void copy_to (generic_file &ref)
 copy all data from current position to the object in argument
 
virtual void copy_to (generic_file &ref, const infinint &crc_size, crc *&value)
 copy all data from the current position to the object in argument and computes a CRC value of the transmitted data More...
 
U_32 copy_to (generic_file &ref, U_32 size)
 small copy (up to 4GB) with CRC calculation
 
infinint copy_to (generic_file &ref, infinint size)
 copy the given amount to the object in argument
 
bool diff (generic_file &f, const infinint &me_read_ahead, const infinint &you_read_ahead, const infinint &crc_size, crc *&value)
 compares the contents with the object in argument More...
 
bool diff (generic_file &f, const infinint &me_read_ahead, const infinint &you_read_ahead, const infinint &crc_size, crc *&value, infinint &err_offset)
 
void reset_crc (const infinint &width)
 reset CRC on read or writen data More...
 
bool crc_status () const
 to known whether CRC calculation is activated or not
 
crc * get_crc ()
 get CRC of the transfered date since last reset More...
 
void sync_write ()
 write any pending data
 
void flush_read ()
 be ready to read at current position, reseting all pending data for reading, cached and in compression engine for example
 
- Public Member Functions inherited from libdar::on_pool
void * operator new (size_t n_byte)
 
void * operator new (size_t n_byte, const std::nothrow_t &nothrow_value)
 
void * operator new[] (size_t n_byte)
 
void * operator new[] (size_t n_byte, const std::nothrow_t &nothrow_value)
 
void * operator new (size_t n_byte, memory_pool *p)
 
void * operator new[] (size_t n_byte, memory_pool *p)
 
void operator delete (void *ptr, memory_pool *p)
 this operator is called by the compiler if an exception is throw from the constructor of the allocated object
 
void operator delete[] (void *ptr, memory_pool *p)
 this operator is called by the compiler if an exception is throw from the constructor of the allocated objects
 
void operator delete (void *ptr)
 this is the usual delete operator, modified to handle allocated objects allocated on a memory pool or not
 
void operator delete[] (void *ptr)
 this is the usual delete[] operator, modified to handle allocated objects allocated on a memory pool or not
 
- Public Member Functions inherited from libdar::thread_cancellation
 thread_cancellation ()
 the constructor
 
virtual ~thread_cancellation () throw (Ebug)
 the destructor
 
void check_self_cancellation () const
 Checkpoint test : whether the current libdar call must abort or not. More...
 
void block_delayed_cancellation (bool mode)
 
- Public Member Functions inherited from libdar::mem_ui
 mem_ui (const user_interaction &dialog)
 constructor More...
 
 mem_ui (user_interaction *dialog)
 
 mem_ui (const mem_ui &ref)
 the copy constructor More...
 
virtual ~mem_ui () throw (Ebug)
 destructor More...
 
const mem_uioperator= (const mem_ui &ref)
 assignement operator More...
 

Protected Member Functions

void inherited_read_ahead (const infinint &amount)
 
void inherited_sync_write ()
 write down any pending data More...
 
void inherited_flush_read ()
 
void inherited_terminate ()
 destructor-like call, except that it is allowed to throw exceptions More...
 
U_I fichier_global_inherited_write (const char *a, U_I size)
 
bool fichier_global_inherited_read (char *a, U_I size, U_I &read, std::string &message)
 
- Protected Member Functions inherited from libdar::generic_file
void set_mode (gf_mode x)
 
bool is_terminated () const
 
- Protected Member Functions inherited from libdar::on_pool
memory_pool * get_pool () const
 
template<class T >
void meta_new (T *&ptr, size_t num)
 
template<class T >
void meta_delete (T *ptr)
 
- Protected Member Functions inherited from libdar::mem_ui
user_interactionget_ui () const
 get access to the user_interaction cloned object More...
 

Additional Inherited Members

- Public Types inherited from libdar::fichier_global
enum  advise {
  advise_normal, advise_sequential, advise_random, advise_noreuse,
  advise_willneed, advise_dontneed
}
 
- Public Types inherited from libdar::generic_file
enum  skippability { skip_backward, skip_forward }
 
- Static Public Member Functions inherited from libdar::thread_cancellation
static U_I count ()
 method for debugging/control purposes
 

Detailed Description

filesystem local files

Definition at line 59 of file fichier_local.hpp.

Member Function Documentation

bool libdar::fichier_local::fichier_global_inherited_read ( char *  a,
U_I  size,
U_I &  read,
std::string &  message 
)
protectedvirtual

replaces generic_file::inherited_read() method, to allow the return of partial reading

a partial reading is signaled by the inherited class by returning false

Parameters
[in]apoints to the area where to store read data
[in]sizeis the available place to store data
[out]readis the total amount of data read so far
[out]messageis the request to send to the user upon partial reading
Returns
true if the reading is full (either read the maximum allowed data or reached end of file) false is returned if a user interaction can let the reading go further the message to display to the user asking him for action. He will also be proposed to abort the current operation.

Implements libdar::fichier_global.

U_I libdar::fichier_local::fichier_global_inherited_write ( const char *  a,
U_I  size 
)
protectedvirtual

replaces generic_file::inherited_write() method, to allow the return of partial writings

a partial writing is allowed when no space is available for writing this let global_ficher interact with the user asking whether it can make place or if (s)he wants to abord

Parameters
[in]apoints to the start of the area of data to write
[in]sizeis the size in byte of the data to write
Returns
the amount of byte wrote. If the returned value is less than size, this is a partial write, and is assumed that free storage space is missing to complete the operation

Implements libdar::fichier_global.

S_I libdar::fichier_local::give_fd_and_terminate ( )
inline

provide the low level filedescriptor to the call and terminate()

Note
this the caller duty to close() the provided filedescriptor

Definition at line 104 of file fichier_local.hpp.

References libdar::generic_file::terminate().

void libdar::fichier_local::inherited_flush_read ( )
inlineprotectedvirtual

reset internal engine, flush caches in order to read the data at current position

Note
when the object relies on external object or system object to fetch the data from for reading, when a call to (inherited_)flush_read() occurs, the current object must not assume that any previously read data is still valid if it has internal buffers or the like and it should flush them asap. This call must not propagate the flush_read to any other gneric_file object it could rely on

Implements libdar::generic_file.

Definition at line 110 of file fichier_local.hpp.

void libdar::fichier_local::inherited_read_ahead ( const infinint amount)
inlineprotectedvirtual

tells the object that several calls to read() will follow to probably obtain at least the given amount of data

Parameters
[in]amountis the maximum expected amount of data that is known to be read
Note
this call may be implemented as a do-nothing call, its presence is only to allow optimization when possible, like in multi-threaded environment

Implements libdar::generic_file.

Definition at line 108 of file fichier_local.hpp.

void libdar::fichier_local::inherited_sync_write ( )
inlineprotectedvirtual

write down any pending data

Note
called after sanity checks from generic_file::sync_write() this method's role is to write down any data pending for writing in the current object it has not to be propagated to other gneric_file object this object could rely on

Implements libdar::generic_file.

Definition at line 109 of file fichier_local.hpp.

void libdar::fichier_local::inherited_terminate ( )
inlineprotectedvirtual

destructor-like call, except that it is allowed to throw exceptions

Note
this method must never be called directly but using terminate() instead, generic_file class manages it to never be called more than once

Implements libdar::generic_file.

Definition at line 111 of file fichier_local.hpp.

References fadvise().

bool libdar::fichier_local::skip ( const infinint pos)
virtual

skip at the absolute position

Parameters
[in]posthe offset in byte where next read/write operation must start
Returns
true if operation was successfull and false if the requested position is not valid (after end of file)
Note
if requested position is not valid the reading/writing cursor must be set to the closest valid position

Implements libdar::generic_file.

bool libdar::fichier_local::skippable ( skippability  direction,
const infinint amount 
)
inlinevirtual

whether the implementation is able to skip

Note
the capability to skip does not mean that skip_relative() or skip() will succeed, but rather that the inherited class implementation does not by construction forbid the requested skip (like inherited class providing a generic_file interface of an anonymous pipe for example)

Implements libdar::generic_file.

Definition at line 95 of file fichier_local.hpp.


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