libdar::zapette Class Reference

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.

List of all members.

Public Member Functions
	zapette (user_interaction &dialog, generic_file *input, generic_file *output, bool by_the_end)
	zapette constructor
bool	skip (const infinint &pos)
	skip at the absolute position
bool	skip_to_eof ()
	skip to the end of file
bool	skip_relative (S_I x)
	skip relatively to the current position
infinint	get_position ()
	get the current read/write position
void	set_info_status (const std::string &s)
bool	is_an_old_start_end_archive () const
const label &	get_data_name () const
Protected Member Functions
U_I	inherited_read (char *a, U_I size)
	implementation of read() operation
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

zapette emulate a file that is remotely controlled by slave_zapette

class zapette sends order to slave_zapette throw a a first pipe and receive informations or data in return from a second pipe from slave_zapette

Definition at line 53 of file zapette.hpp.

---

Constructor & Destructor Documentation

libdar::zapette::zapette	(	user_interaction &	dialog,
		generic_file *	input,
		generic_file *	output,
		bool	by_the_end
	)

zapette constructor

Parameters:

[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

---

Member Function Documentation

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

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::zapette::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 80 of file zapette.hpp.

void libdar::zapette::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.

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

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

• zapette.hpp