![]() |
Disk ARchive 2.7.18
Full featured and portable backup and archiving tool
|
zapette emulate a file that is remotely controlled by slave_zapette More...
#include <zapette.hpp>
Inherits libdar::generic_file, libdar::contextual, and libdar::mem_ui.
Public Member Functions | |
| zapette (const std::shared_ptr< user_interaction > &dialog, generic_file *input, generic_file *output, bool by_the_end) | |
| zapette constructor | |
| zapette (const zapette &ref)=default | |
| zapette (zapette &&ref) noexcept=default | |
| zapette & | operator= (const zapette &ref)=default |
| zapette & | operator= (zapette &&ref) noexcept=default |
| 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 | |
| virtual void | set_info_status (const std::string &s) override |
| defines the new contextual value | |
| virtual bool | is_an_old_start_end_archive () const override |
| returns whether the archive is a old archive (format < 8) | |
| virtual const label & | get_data_name () const override |
| obtain the data_name of the archive (label associated with the archive's data) | |
| infinint | get_first_slice_header_size () const |
| infinint | get_non_first_slice_header_size () const |
Public Member Functions inherited from libdar::generic_file | |
| 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 | |
Public Member Functions inherited from libdar::proto_generic_file | |
| 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 | |
Public Member Functions inherited from libdar::contextual | |
| contextual (const contextual &ref)=default | |
| contextual (contextual &&ref) noexcept=default | |
| contextual & | operator= (const contextual &ref)=default |
| contextual & | operator= (contextual &&ref) noexcept=default |
| virtual std::string | get_info_status () const |
| get the current contextual value | |
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 | |
Protected Member Functions inherited from libdar::generic_file | |
| void | set_mode (gf_mode x) |
| bool | is_terminated () const |
Protected Member Functions inherited from libdar::mem_ui | |
| user_interaction & | get_ui () const |
| get access to the user_interaction object | |
| std::shared_ptr< user_interaction > | get_pointer () const |
| get access to the shared_ptr pointing to the user_interaction | |
| mem_ui (const std::shared_ptr< user_interaction > &dialog) | |
| constructor | |
| mem_ui (const mem_ui &ref)=default | |
| the copy constructor | |
| mem_ui (mem_ui &&ref) noexcept=default | |
| the move constructor | |
| mem_ui & | operator= (const mem_ui &ref)=default |
| assignement operator | |
| mem_ui & | operator= (mem_ui &&ref) noexcept=default |
| move operator | |
| virtual | ~mem_ui () noexcept(false) |
| destructor | |
Private Member Functions | |
| void | make_transfert (U_16 size, const infinint &offset, char *data, const std::string &info, S_I &lu, infinint &arg) const |
| wrapped formatted method to communicate with the slave_zapette located behind the pair of pipes (= tuyau) | |
Private Attributes | |
| generic_file * | in |
| generic_file * | out |
| infinint | position |
| infinint | file_size |
| char | serial_counter |
Additional Inherited Members | |
Public Types inherited from libdar::generic_file | |
| enum | skippability { skip_backward , skip_forward } |
zapette emulate a file that is remotely controlled by slave_zapette
class zapette sends order to slave_zapette through a a first pipe and receive informations or data in return from a second pipe from slave_zapette
Definition at line 56 of file zapette.hpp.
| libdar::zapette::zapette | ( | const std::shared_ptr< user_interaction > & | dialog, |
| generic_file * | input, | ||
| generic_file * | output, | ||
| bool | by_the_end ) |
zapette constructor
| [in] | dialog | is used to return status information to the user |
| [in] | input | is the pipe (see class tuyau) from which is received the information or data |
| [in] | output | is used to send orders to slave_zapette |
| [in] | by_the_end | if true dar will try to open the archive starting from the end else it will try starting from the first bytes |
|
overridevirtual |
obtain the data_name of the archive (label associated with the archive's data)
Implements libdar::contextual.
| infinint libdar::zapette::get_first_slice_header_size | ( | ) | const |
get the first slice header
| infinint libdar::zapette::get_non_first_slice_header_size | ( | ) | const |
get the non first slice header
|
inlineoverridevirtual |
get the current read/write position
Implements libdar::generic_file.
Definition at line 79 of file zapette.hpp.
References libdar::generic_file::is_terminated().
|
inlineoverrideprotectedvirtual |
reset internal engine, flush caches in order to read the data at current position
Implements libdar::generic_file.
Definition at line 102 of file zapette.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 97 of file zapette.hpp.
|
inlineoverrideprotectedvirtual |
write down any pending data
Implements libdar::generic_file.
Definition at line 101 of file zapette.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 100 of file zapette.hpp.
|
overrideprotectedvirtual |
implementation of the write() operation
| [in] | a | what data to write |
| [in] | size | amount of data to write |
Implements libdar::generic_file.
|
overridevirtual |
returns whether the archive is a old archive (format < 8)
Implements libdar::contextual.
|
private |
wrapped formatted method to communicate with the slave_zapette located behind the pair of pipes (= tuyau)
| [in] | size | is the size of the amount of data we want the zapette to send us |
| [in] | offset | is the byte offset of the portion of the data we want |
| [in,out] | data | is the location where to return the requested data |
| [in] | info | the new contextual string to set to the slave_zapette. |
| [out] | lu | the amount of byte wrote to '*data' |
| [out] | arg | infinint value return for special order (see note below). |
|
overridevirtual |
defines the new contextual value
Reimplemented from libdar::contextual.
|
overridevirtual |
skip at the absolute position
| [in] | pos | the offset in byte where next read/write operation must start |
Implements libdar::generic_file.
|
overridevirtual |
skip relatively to the current position
Implements libdar::generic_file.
|
inlineoverridevirtual |
skip to the end of file
Implements libdar::generic_file.
Definition at line 76 of file zapette.hpp.
References libdar::generic_file::is_terminated().
|
inlineoverridevirtual |
whether the implementation is able to skip
Implements libdar::generic_file.
Definition at line 74 of file zapette.hpp.
|
inlineoverridevirtual |
whether the implementation is able to truncate to the given position
Implements libdar::generic_file.
Definition at line 78 of file zapette.hpp.
|
private |
Definition at line 107 of file zapette.hpp.
|
private |
Definition at line 106 of file zapette.hpp.
|
private |
Definition at line 106 of file zapette.hpp.
|
private |
Definition at line 107 of file zapette.hpp.
|
private |
Definition at line 108 of file zapette.hpp.