Disk ARchive  2.4.2
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 (user_interaction &dialog, int fd)
 tuyau (user_interaction &dialog, int fd, gf_mode mode)
 tuyau (user_interaction &dialog, const std::string &filename, gf_mode mode)
 tuyau (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 skip (const infinint &pos)
 skip at the absolute position
bool skip_to_eof ()
 skip to the end of file
bool skip_relative (signed int x)
infinint get_position ()
 get the current read/write position
bool has_next_to_read ()

Protected Member Functions

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_terminate ()
 destructor-like call, except that it is allowed to throw exceptions

Detailed Description

pipe implementation under the generic_file interface.

Definition at line 49 of file tuyau.hpp.


Member Function Documentation

void libdar::tuyau::close_read_fd ( )

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
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_sync_write ( ) [inline, protected, virtual]

write down any pending data

Note:
this method is called after read/write mode checking from sync_write() public method;

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.


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