output_filter_bzip2 Class Reference

#include <bzip2.h>

Inheritance diagram for output_filter_bzip2:

Public Member Functions
virtual	~output_filter_bzip2 ()
Static Public Member Functions
static pointer	create (const output::pointer &deeper)
Protected Member Functions
long	ftell_inner (void) const
void	write_inner (const void *data, size_t length)
nstring	type_name (void) const
void	end_of_line_inner (void)
Private Types
enum	{ BUFFER_SIZE = 1 << 14 }
Private Member Functions
	output_filter_bzip2 (const output::pointer &deeper)
void	bzlib_fatal_error (int err)
	output_filter_bzip2 ()
	output_filter_bzip2 (const output_filter_bzip2 &)
output_filter_bzip2 &	operator= (const output_filter_bzip2 &)
Private Attributes
bz_stream	stream
char *	buf
long	pos
bool	bol

---

Detailed Description

The output_filter_bzip2 class is used to represent an output filter which compresses the data before writing it to the deeper output stream.

Definition at line 30 of file bzip2.h.

---

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

BUFFER_SIZE

Definition at line 77 of file bzip2.h.

---

Constructor & Destructor Documentation

virtual output_filter_bzip2::~output_filter_bzip2

(

)

[virtual]

The destructor.

output_filter_bzip2::output_filter_bzip2

(

const output::pointer &

deeper

)

[private]

The constructor. It is private on purpose, use the create class method instead.

Parameters:

deeper

the output stream this filter will write its output to.

output_filter_bzip2::output_filter_bzip2

(

)

[private]

The default constructor. Do not use.

output_filter_bzip2::output_filter_bzip2

(

const output_filter_bzip2 &

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

void output_filter_bzip2::bzlib_fatal_error

(

int

err

)

[private]

The bzlib_fatal_error method is used to report a fatal error from the bzip2 engine.

static pointer output_filter_bzip2::create

(

const output::pointer &

deeper

)

[static]

The create class method is used to create new dynamically allocated instances of this class.

Parameters:

deeper

the output stream this filter will write its output to.

void output_filter_bzip2::end_of_line_inner

(

void

)

[protected, virtual]

The end_of_line_inner method is used to ensure that the current output position is at the beginning of a line, without taking the buffering into account.

Reimplemented from output_filter.

long output_filter_bzip2::ftell_inner

(

void

)

const [protected, virtual]

The ftell_inner method is used to determine the current file position, without taking the buffering into account.

Reimplemented from output_filter.

output_filter_bzip2& output_filter_bzip2::operator=

(

const output_filter_bzip2 &

)

[private]

The assignment operator. Do not use.

nstring output_filter_bzip2::type_name

(

void

)

const [protected, virtual]

The type_name method is used to determine the name of this output device or file or type.

Reimplemented from output_filter.

void output_filter_bzip2::write_inner	(	const void *	data,
		size_t	length
	)		[protected, virtual]

The write_inner method is used write data to the output, without taking the buffering into account.

Reimplemented from output_filter.

---

Field Documentation

bool output_filter_bzip2::bol [private]

The bol instance variable is used to remember whether or not the output is positioned at the beginning of a lone.

Definition at line 95 of file bzip2.h.

char* output_filter_bzip2::buf [private]

The buf instance variable is used to remember the buffered output data.

Definition at line 83 of file bzip2.h.

long output_filter_bzip2::pos [private]

The pos instance variable is used to remember the current output position.

Definition at line 89 of file bzip2.h.

bz_stream output_filter_bzip2::stream [private]

The stream instance variable is used to remember somthign that the bzip2 code wants to remember. It is opaque to us.

Definition at line 75 of file bzip2.h.

---

The documentation for this class was generated from the following file:

• /home/archives/aegis/branch.4/branch.25/delta28933.505/libaegis/output/filter/bzip2.h