![]() |
Disk ARchive 2.7.15
Full featured and portable backup and archiving tool
|
generic_file interface to librsync More...
#include <generic_rsync.hpp>
Inherits libdar::generic_file.
Public Member Functions | |
generic_rsync (generic_file *signature_storage, U_I signature_block_size, generic_file *below) | |
constructor for "signature" operation | |
generic_rsync (generic_file *base_signature, generic_file *below, const infinint &crc_size, const crc **checksum) | |
constructor for "delta" operation | |
generic_rsync (generic_file *current_data, generic_file *delta) | |
constructor for "patch" operation | |
generic_rsync (const generic_rsync &ref)=delete | |
generic_rsync (generic_rsync &&ref) noexcept=delete | |
generic_rsync & | operator= (const generic_rsync &ref)=delete |
generic_rsync & | operator= (generic_rsync &&ref) noexcept=delete |
virtual bool | skippable (skippability direction, const infinint &amount) override |
whether the implementation is able to skip | |
virtual bool | skip (const infinint &pos) override |
skip at the absolute position | |
virtual bool | skip_to_eof () override |
skip to the end of file | |
virtual bool | skip_relative (S_I x) override |
skip relatively to the current position | |
virtual bool | truncatable (const infinint &pos) const override |
whether the implementation is able to truncate to the given position | |
virtual infinint | get_position () const override |
get the current read/write position | |
![]() | |
generic_file (gf_mode m) | |
main constructor | |
generic_file (const generic_file &ref) | |
copy constructor | |
generic_file (generic_file &&ref) noexcept | |
move constructor | |
generic_file & | operator= (const generic_file &ref) |
assignment operator | |
generic_file & | operator= (generic_file &&ref) noexcept |
move operator | |
~generic_file () noexcept(false) | |
virtual destructor, | |
void | terminate () |
destructor-like call, except that it is allowed to throw exceptions | |
bool | operator== (generic_file &ref) |
bool | operator!= (generic_file &ref) |
gf_mode | get_mode () const |
retreive the openning mode for this object | |
void | read_ahead (const infinint &amount) |
void | ignore_read_ahead (bool mode) |
virtual U_I | read (char *a, U_I size) override |
read data from the generic_file inherited from proto_generic_file | |
virtual void | write (const char *a, U_I size) override |
write data to the generic_file inherited from proto_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 | truncate (const infinint &pos) |
truncate file at the given offset | |
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 | |
![]() | |
proto_generic_file (const proto_generic_file &ref)=default | |
copy constructor | |
proto_generic_file (proto_generic_file &&ref) noexcept=default | |
move constructor | |
proto_generic_file & | operator= (const proto_generic_file &ref)=default |
assignment operator | |
proto_generic_file & | operator= (proto_generic_file &&ref) noexcept=default |
move operator | |
virtual | ~proto_generic_file () noexcept(false) |
virtual destructor | |
Protected Member Functions | |
virtual void | inherited_read_ahead (const infinint &amount) override |
tells the object that several calls to read() will follow to probably obtain at least the given amount of data | |
virtual U_I | inherited_read (char *a, U_I size) override |
implementation of read() operation | |
virtual void | inherited_write (const char *a, U_I size) override |
implementation of the write() operation | |
virtual void | inherited_truncate (const infinint &pos) override |
truncate file at the give offset | |
virtual void | inherited_sync_write () override |
write down any pending data | |
virtual void | inherited_flush_read () override |
reset internal engine, flush caches in order to read the data at current position | |
virtual void | inherited_terminate () override |
destructor-like call, except that it is allowed to throw exceptions | |
![]() | |
void | set_mode (gf_mode x) |
bool | is_terminated () const |
Private Types | |
enum | { sign , delta , patch } |
Private Member Functions | |
bool | step_forward (const char *buffer_in, U_I &avail_in, bool shift_input, char *buffer_out, U_I &avail_out) |
feed librsync using rs_job_iter | |
void | free_job () |
void | send_eof () |
Private Attributes | |
enum libdar::generic_rsync:: { ... } | status |
generic_file * | x_below |
underlying layer to read from / write to | |
generic_file * | x_input |
generic_file * | x_output |
bool | initial |
char * | working_buffer |
U_I | working_size |
bool | patching_completed |
crc * | data_crc |
Additional Inherited Members | |
![]() | |
enum | skippability { skip_backward , skip_forward } |
generic_file interface to librsync
Definition at line 50 of file generic_rsync.hpp.
|
private |
Definition at line 120 of file generic_rsync.hpp.
libdar::generic_rsync::generic_rsync | ( | generic_file * | signature_storage, |
U_I | signature_block_size, | ||
generic_file * | below | ||
) |
constructor for "signature" operation
in this mode the generic_rsync object is read only, all data read from it is fetched unchanged from "below" while the signature is computed. The file signature is output to signature_storage
[in] | signature_storage | is write only mode generic_file |
[in] | signature_block_size | the block len to use to build the signature |
[in] | below | is read only to fetch data from |
libdar::generic_rsync::generic_rsync | ( | generic_file * | base_signature, |
generic_file * | below, | ||
const infinint & | crc_size, | ||
const crc ** | checksum | ||
) |
constructor for "delta" operation
in this mode the generic_rsync object is also read only, all data read from it is the resulting delta of the data read from "below" based the given base_signature.
[in] | base_signature | is read only |
[in] | below | is the plain file to read from and for which to compute the delta based on base_signature |
[in] | crc_size | is the size of the crc to create if checksum is not nullptr |
[in] | checksum | if not null, the *checksum will be set to the address of a newly allocated crc that will receive the calculated crc of the below object, this CRC is calcuated for the data of "below". Caller has the duty to release this object when no more needed but never before this generic_rsync object has been destroyed. |
libdar::generic_rsync::generic_rsync | ( | generic_file * | current_data, |
generic_file * | delta | ||
) |
constructor for "patch" operation
in this mode the generic_rsync object is read only, the data read from it is built from the current file's data and the delta signature.
[in] | current_data | is a read_only object that contains the data to be used as base for the patch (this data is not modified) |
[in] | delta | is read only and contains the patch to apply |
|
inlineoverridevirtual |
get the current read/write position
Implements libdar::generic_file.
Definition at line 108 of file generic_rsync.hpp.
References libdar::generic_file::get_position(), and x_below.
Referenced by inherited_truncate(), and truncatable().
|
inlineoverrideprotectedvirtual |
reset internal engine, flush caches in order to read the data at current position
Implements libdar::generic_file.
Definition at line 116 of file generic_rsync.hpp.
|
overrideprotectedvirtual |
implementation of read() operation
[in,out] | a | where to put the data to read |
[in] | size | says how much data to read |
Implements libdar::generic_file.
|
inlineoverrideprotectedvirtual |
tells the object that several calls to read() will follow to probably obtain at least the given amount of data
[in] | amount | is the maximum expected amount of data that is known to be read |
Implements libdar::generic_file.
Definition at line 111 of file generic_rsync.hpp.
|
inlineoverrideprotectedvirtual |
write down any pending data
Implements libdar::generic_file.
Definition at line 115 of file generic_rsync.hpp.
|
overrideprotectedvirtual |
destructor-like call, except that it is allowed to throw exceptions
Implements libdar::generic_file.
|
inlineoverrideprotectedvirtual |
truncate file at the give offset
Implements libdar::generic_file.
Definition at line 114 of file generic_rsync.hpp.
References get_position().
|
overrideprotectedvirtual |
implementation of the write() operation
[in] | a | what data to write |
[in] | size | amount of data to write |
Implements libdar::generic_file.
|
inlineoverridevirtual |
skip at the absolute position
[in] | pos | the offset in byte where next read/write operation must start |
Implements libdar::generic_file.
Definition at line 104 of file generic_rsync.hpp.
|
inlineoverridevirtual |
skip relatively to the current position
Implements libdar::generic_file.
Definition at line 106 of file generic_rsync.hpp.
|
inlineoverridevirtual |
skip to the end of file
Implements libdar::generic_file.
Definition at line 105 of file generic_rsync.hpp.
|
inlineoverridevirtual |
whether the implementation is able to skip
Implements libdar::generic_file.
Definition at line 103 of file generic_rsync.hpp.
|
private |
feed librsync using rs_job_iter
[in] | buffer_in | bytes of data to give to librsync |
[in,out] | avail_in | is the amount of byte available, and after the call the amount of not yet read bytes remaining at the beginning of the buffer_in buffer (when shift_input is set to true) or at the end of buffer_in if shift is set to false. |
[in] | shift_input | |
[out] | buffer_out | where to drop the data from librsync |
[in,out] | avail_out | is the size of the allocated memory pointed to by buffer_out and after the call the amount of byte that has been dropped to the buffer_out buffer. |
|
inlineoverridevirtual |
whether the implementation is able to truncate to the given position
Implements libdar::generic_file.
Definition at line 107 of file generic_rsync.hpp.
References get_position().
|
private |
Definition at line 129 of file generic_rsync.hpp.
|
private |
Definition at line 125 of file generic_rsync.hpp.
|
private |
Definition at line 128 of file generic_rsync.hpp.
|
private |
Definition at line 126 of file generic_rsync.hpp.
|
private |
Definition at line 127 of file generic_rsync.hpp.
|
private |
underlying layer to read from / write to
Definition at line 122 of file generic_rsync.hpp.
Referenced by get_position().
|
private |
Definition at line 123 of file generic_rsync.hpp.
|
private |
Definition at line 124 of file generic_rsync.hpp.