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 ()
Public Member Functions inherited from libdar::generic_file
	generic_file (gf_mode m)
	main constructor
	generic_file (const generic_file &ref)
	copy constructor
void	terminate () const
	virtual destructor, this let inherited destructor to be called even from a generic_file pointer to an inherited class
const generic_file &	operator= (const generic_file &ref)
	assignment operator
gf_mode	get_mode () const
	retreive the openning mode for this object
U_I	read (char *a, U_I size)
	read data from the generic_file
void	write (const char *a, U_I size)
	write data to the 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 bool	skip_relative (S_I x)=0
	skip relatively to the current position
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 &crc_size, crc *&value)
	compares the contents with the object in argument
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
Public Member Functions inherited from libdar::thread_cancellation
	thread_cancellation ()
	the constructor
virtual	~thread_cancellation ()
	the destructor
void	check_self_cancellation () const
	Checkpoint test : whether the current libdar call must abort or not.
void	block_delayed_cancellation (bool mode)

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
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
	mem_ui (user_interaction &dialog)
	constructor
	mem_ui (const mem_ui &ref)
	the copy constructor
virtual	~mem_ui ()
	destructor
const mem_ui &	operator= (const mem_ui &ref)
	assignement operator
user_interaction &	get_ui () const
	get access to the user_interaction cloned object

Additional Inherited Members
Static Public Member Functions inherited from libdar::thread_cancellation
static void	init ()
	mandatory initialization static method
static U_I	count ()
	method for debugging/control purposes

---

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  )

protectedvirtual

implementation of read() operation

Parameters:

[in,out]	a	where to put the data to read
[in]	size	says 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 ( )

inlineprotectedvirtual

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 ( )

protectedvirtual

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  )

protectedvirtual

implementation of the write() operation

Parameters:

[in]	a	what data to write
[in]	size	amount 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]

pos

the 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:

• tuyau.hpp