| Disk ARchive 2.6.12 Full featured and portable backup and archiving tool

tuyau.hpp
Go to the documentation of this file.
1 /*********************************************************************/
2 // dar - disk archive - a backup/restoration program
3 // Copyright (C) 2002-2020 Denis Corbin
4 //
5 // This program is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU General Public License
7 // as published by the Free Software Foundation; either version 2
8 // of the License, or (at your option) any later version.
9 //
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 //
19 // to contact the author : http://dar.linux.free.fr/email.html
20 /*********************************************************************/
21
30
31 #ifndef TUYAU_HPP
32 #define TUYAU_HPP
33
34 #include "../my_config.h"
35 #include "infinint.hpp"
36 #include "generic_file.hpp"
37 #include "thread_cancellation.hpp"
38 #include "mem_ui.hpp"
39
40 namespace libdar
41 {
42
45
47
48 class tuyau : public generic_file, public thread_cancellation, protected mem_ui
49 {
50 public:
51 tuyau(const std::shared_ptr<user_interaction> & dialog, //< for user interaction
52 int fd); //< fd is the filedescriptor of a pipe extremity already openned
53 tuyau(const std::shared_ptr<user_interaction> & dialog, //< for user interaction
54 int fd, //< fd is the filedescriptor of a pipe extremity already openned
55 gf_mode mode); //< forces the mode if possible
56 tuyau(const std::shared_ptr<user_interaction> & dialog, //< for user interaction
57 const std::string &filename, //< named pipe to open
58 gf_mode mode); //< forces the mode if possible
59
60 tuyau(const std::shared_ptr<user_interaction> & dialog);//< creates a anonymous pipe and bind itself to the writing end. The reading end can be obtained by get_read_side() method
61 tuyau(const tuyau & ref) = default;
62 tuyau(tuyau && ref) noexcept = default;
63 tuyau & operator = (const tuyau & ref) = default;
64 tuyau & operator = (tuyau && ref) noexcept = default;
65 ~tuyau();
66
69 int get_read_fd() const;
70
72
76 void close_read_fd();
77
79 void do_not_close_read_fd();
80
81 // inherited from generic_file
82 virtual bool skippable(skippability direction, const infinint & amount) override;
83 virtual bool skip(const infinint & pos) override;
84 virtual bool skip_to_eof() override;
85 virtual bool skip_relative(signed int x) override;
86 virtual infinint get_position() const override { return position; };
87
88 bool has_next_to_read();
89
90 protected:
91 virtual void inherited_read_ahead(const infinint & amount) override {}; // relying on the operating system
92 virtual U_I inherited_read(char *a, U_I size) override;
93 virtual void inherited_write(const char *a, U_I size) override;
94 virtual void inherited_sync_write() override {};
95 virtual void inherited_flush_read() override {};
96 virtual void inherited_terminate() override;
97
98 private:
99 enum
100 {
101 pipe_fd,
102 pipe_path,
103 pipe_both
104 } pipe_mode;
105 infinint position;
106 int filedesc;
107 int other_end_fd;
108 std::string chemin;
109 bool has_one_to_read;
110 char next_to_read;
111
112 void ouverture();
113
115
118 bool read_and_drop(infinint byte);
119
121 bool read_to_eof();
122 };
123
125
126 } // end of namespace
127
128 #endif
libdar::tuyau::has_one_to_read
bool has_one_to_read
if true, the next char to read is placed in "next_to_read"
Definition: tuyau.hpp:109
libdar::tuyau::position
infinint position
recorded position in the stream
Definition: tuyau.hpp:105
libdar::thread_cancellation
class to be used as parent to provide checkpoints to inherited classes
Definition: thread_cancellation.hpp:69
libdar::tuyau::skip
virtual bool skip(const infinint &pos) override
skip at the absolute position
libdar::tuyau::other_end_fd
int other_end_fd
in pipe_both mode, this holds the reading side of the anonymous pipe
Definition: tuyau.hpp:107
libdar::gf_mode
gf_mode
generic_file openning modes
Definition: gf_mode.hpp:44
infinint.hpp
switch module to limitint (32 ou 64 bits integers) or infinint
libdar::infinint
the arbitrary large positive integer class
Definition: real_infinint.hpp:62
libdar::tuyau::inherited_read_ahead
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 amoun...
Definition: tuyau.hpp:91
libdar::tuyau::inherited_terminate
virtual void inherited_terminate() override
destructor-like call, except that it is allowed to throw exceptions
libdar::tuyau::get_read_fd
int get_read_fd() const
libdar::tuyau::filedesc
int filedesc
file descriptors of the pipe
Definition: tuyau.hpp:106
libdar::tuyau
pipe implementation under the generic_file interface.
Definition: tuyau.hpp:49
libdar::mem_ui
class mem_ui to keep a copy of a user_interaction object
Definition: mem_ui.hpp:55
thread_cancellation.hpp
to be able to cancel libdar operation while running in a given thread.
generic_file.hpp
class generic_file is defined here as well as class fichier
libdar::tuyau::read_and_drop
bool read_and_drop(infinint byte)
skip forward by reading data
libdar::tuyau::get_position
virtual infinint get_position() const override
get the current read/write position
Definition: tuyau.hpp:86
libdar::tuyau::close_read_fd
void close_read_fd()
closes the read fd of the anonymous pipe (this is to be used by a writer)
libdar::generic_file
this is the interface class from which all other data transfer classes inherit
Definition: generic_file.hpp:77
libdar::tuyau::inherited_write
virtual void inherited_write(const char *a, U_I size) override
implementation of the write() operation
libdar::tuyau::inherited_flush_read
virtual void inherited_flush_read() override
reset internal engine, flush caches in order to read the data at current position
Definition: tuyau.hpp:95
libdar::tuyau::chemin
std::string chemin
in pipe_path mode only, this holds the named pipe to be open
Definition: tuyau.hpp:108
libdar::tuyau::inherited_read
virtual U_I inherited_read(char *a, U_I size) override
implementation of read() operation
libdar::tuyau::pipe_path
@ pipe_path
holds a filename to be openned (named pipe)
Definition: tuyau.hpp:102
libdar::tuyau::pipe_mode
enum libdar::tuyau::@4 pipe_mode
defines how the object's status (which possible values defined by the anonymous enum above)
libdar::tuyau::next_to_read
char next_to_read
when has_one_to_read is true, contains the next to read byte
Definition: tuyau.hpp:110
libdar::tuyau::inherited_sync_write
virtual void inherited_sync_write() override
write down any pending data
Definition: tuyau.hpp:94
libdar::tuyau::pipe_both
@ pipe_both
holds a pair of file descriptors
Definition: tuyau.hpp:103
libdar::tuyau::do_not_close_read_fd
void do_not_close_read_fd()
ask to not close the read descriptor upon object destruction (the fd survives the object)
libdar::tuyau::skip_to_eof
virtual bool skip_to_eof() override
skip to the end of file
libdar::tuyau::skippable
virtual bool skippable(skippability direction, const infinint &amount) override
whether the implementation is able to skip
libdar::tuyau::pipe_fd
@ pipe_fd
holds a single file descriptor for the pipe
Definition: tuyau.hpp:101
libdar::tuyau::read_to_eof
bool read_to_eof()
skip to eof by reading data
mem_ui.hpp
class mem_ui definition. This class is to be used as parent class to handle user_interaction object m...
libdar
libdar namespace encapsulate all libdar symbols
Definition: archive.hpp:47