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

#include <trivial_sar.hpp>

Inherits libdar::generic_file, libdar::contextual, and libdar::mem_ui.

Public Member Functions

 trivial_sar (const user_interaction &dialog, gf_mode open_mode, const std::string &base_name, const std::string &extension, const entrepot &where, const label &internal_nale, const label &data_name, const std::string &execute, bool allow_over, bool warn_over, bool force_permission, U_I permission, hash_algo x_hash, const infinint &min_digits, bool format_07_compatible)
 constructor to build a new single sliced archive
 trivial_sar (const user_interaction &dialog, const std::string &pipename, bool lax)
 constructor to read a (single sliced) archive from a pipe
 trivial_sar (const user_interaction &dialog, generic_file *f, const label &internal_name, const label &data_name, bool format_07_compatible, const std::string &execute)
 constructor to write a (single sliced) archive to a anonymous pipe
 trivial_sar (const trivial_sar &ref)
 copy constructor (disabled)
 ~trivial_sar ()
 destructor
const trivial_saroperator= (const trivial_sar &ref)
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
bool is_an_old_start_end_archive () const
const label & get_data_name () const
const infinintget_slice_header_size () const
 size of the slice header
- 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
void write (const char *a, U_I size)
 write data to the generic_file
void write (const std::string &arg)
 write a string to the generic_file
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
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
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
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
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::contextual
virtual void set_info_status (const std::string &s)
virtual std::string get_info_status () const
 get the current contextual value
virtual bool is_an_old_start_end_archive () const =0
 returns whether the archive is a old archive (format < 8)
virtual const label & get_data_name () const =0

Protected Member Functions

void inherited_read_ahead (const infinint &amount)
U_I inherited_read (char *a, U_I size)
 implementation of read() operation
void inherited_write (const char *a, U_I size)
 implementation of the write() operation
void inherited_sync_write ()
 write down any pending data
void inherited_flush_read ()
void inherited_terminate ()
 destructor-like call, except that it is allowed to throw exceptions
- 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
 mem_ui (const user_interaction &dialog)
 constructor
 mem_ui (user_interaction *dialog)
 mem_ui (const mem_ui &ref)
 the copy constructor
virtual ~mem_ui () throw (Ebug)
 destructor
const mem_uioperator= (const mem_ui &ref)
 assignement operator
user_interactionget_ui () const
 get access to the user_interaction cloned object

Additional Inherited Members

- Public Types inherited from libdar::generic_file
enum  skippability { skip_backward, skip_forward }

Detailed Description

"trivial sar" proposes the same interface a sar but does the work slightly differently using different constructors

depending on the constructor used trivial sar can:

Definition at line 55 of file trivial_sar.hpp.

Member Function Documentation

void libdar::trivial_sar::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 115 of file trivial_sar.hpp.

U_I libdar::trivial_sar::inherited_read ( char *  a,
U_I  size 
)
protectedvirtual

implementation of read() operation

Parameters
[in,out]awhere to put the data to read
[in]sizesays how much data to read
Returns
the exact amount of data read and put into 'a'
Note
read as much byte as requested, up to end of file stays blocked if not enough data is available and EOF not yet met. May return less data than requested only if EOF as been reached. in other worlds, EOF is reached when returned data is stricly less than the requested data Any problem shall be reported by throwing an exception.

Implements libdar::generic_file.

void libdar::trivial_sar::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 111 of file trivial_sar.hpp.

References libdar::generic_file::read_ahead().

void libdar::trivial_sar::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 114 of file trivial_sar.hpp.

void libdar::trivial_sar::inherited_terminate ( )
protectedvirtual

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.

void libdar::trivial_sar::inherited_write ( const char *  a,
U_I  size 
)
protectedvirtual

implementation of the write() operation

Parameters
[in]awhat data to write
[in]sizeamount of data to write
Note
must either write all data or report an error by throwing an exception

Implements libdar::generic_file.

bool libdar::trivial_sar::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::trivial_sar::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 97 of file trivial_sar.hpp.

References libdar::generic_file::skippable().


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