Disk ARchive  2.5.2
Full featured and portable backup and archiving tool
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Member Functions | Protected Member Functions
libdar::tuyau Class Reference

pipe implementation under the generic_file interface. More...

#include <tuyau.hpp>

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

List of all members.

Public Member Functions

 tuyau (const user_interaction &dialog, int fd)
 tuyau (const user_interaction &dialog, int fd, gf_mode mode)
 tuyau (const user_interaction &dialog, const std::string &filename, gf_mode mode)
 tuyau (const user_interaction &dialog)
int get_read_fd () const
void close_read_fd ()
 closes the read fd of the anonymous pipe (this is to be used by a writer)
void do_not_close_read_fd ()
 ask to not close the read descriptor upon object destruction (the fd survives the object)
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 (signed int x)
infinint get_position () const
 get the current read/write position
bool has_next_to_read ()

Protected Member Functions

void inherited_read_ahead (const infinint &amount)
virtual U_I inherited_read (char *a, U_I size)
 implementation of read() operation
virtual 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

Detailed Description

pipe implementation under the generic_file interface.

Definition at line 47 of file tuyau.hpp.


Member Function Documentation

closes the read fd of the anonymous pipe (this is to be used by a writer)

Note:
to ensure a proper behavior of the 'eof', the writer must close the read fd this call let this be done, assuming the read has already fetched the fd and forked in a new process
void libdar::tuyau::inherited_flush_read ( ) [inline, protected, virtual]

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 89 of file tuyau.hpp.

virtual U_I libdar::tuyau::inherited_read ( char *  a,
U_I  size 
) [protected, virtual]

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::tuyau::inherited_read_ahead ( const infinint amount) [inline, protected, virtual]

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 85 of file tuyau.hpp.

void libdar::tuyau::inherited_sync_write ( ) [inline, protected, virtual]

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 88 of file tuyau.hpp.

void libdar::tuyau::inherited_terminate ( ) [protected, virtual]

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.

virtual void libdar::tuyau::inherited_write ( const char *  a,
U_I  size 
) [protected, virtual]

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::tuyau::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::tuyau::skippable ( skippability  direction,
const infinint amount 
) [virtual]

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.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines