code::ZlibWriter Class Reference

Inheritance diagram for code::ZlibWriter:

List of all members.

---

Detailed Description

Writer subclass that handles writing to a zlib compression format.

This writer also handles Gzip file writing if introduced as Gzip. TypeName:: "zlib", TypeName::GzippedFile

Author:

Lakshman

Version:

Id

code_ZlibWriter.h,v 1.4 2009/06/02 20:17:40 lakshman Exp

See also:

ZlibReader

Public Member Functions
virtual int	writeOut (const Buffer &buf, const char *dirName, const char *fileName) const
	To write into the storage device.
virtual	~ZlibWriter ()
	Empty virtual destructor, to permit subclassing.
int	writeOut (const Buffer &b, const std::string &dev, const std::string &msg) const
int	writeOut (const Buffer &b, const std::string &filename) const
int	writeXMLDocument (const XML::Document &, const std::string &deviceName, const std::string &messageName)
	Given a document created from its root element, the contents (in textual form) will be written out.
Static Public Member Functions
static void	introduceSelf ()
	Announce oneself to the system.
static void	introduceAsGzip ()
	Announce that this Writer will be used to implement Gzip.
static SmartPtr< Writer >	getWriter (const std::string &)
	Obtain the storage type's Writer.
Protected Member Functions
	ZlibWriter (bool actAsGzip)
	Should be used only by subclasses; all others should use the factory method getReader() in Reader.

---

Constructor & Destructor Documentation

virtual code::ZlibWriter::~ZlibWriter

(

)

[inline, virtual]

Empty virtual destructor, to permit subclassing.

code::ZlibWriter::ZlibWriter

(

bool

actAsGzip

)

[inline, protected]

Should be used only by subclasses; all others should use the factory method getReader() in Reader.

---

Member Function Documentation

static SmartPtr< Writer > code::Writer::getWriter

(

const std::string &

)

[static, inherited]

Obtain the storage type's Writer.

Pass in as StorageType::FlatFile, etc. Of course, you can pass in the std::string itself.

On error, return SmartPtr that evaluates to NULL (or 0).

Parameters:

const_string&

storage type

static void code::ZlibWriter::introduceAsGzip

(

)

[static]

Announce that this Writer will be used to implement Gzip.

This function needs to be invoked before ZlibWriter can be used for gzip.

static void code::ZlibWriter::introduceSelf

(

)

[static]

Announce oneself to the system.

This function needs to be invoked before ZlibWriter can be used. In the case of baseline CODE, it will be invoked by the initialize function of Introducer. For new development, it has to be done explicitly.

int code::Writer::writeOut	(	const Buffer &	b,
		const std::string &	filename
	)			const [inline, inherited]

int code::Writer::writeOut	(	const Buffer &	b,
		const std::string &	dev,
		const std::string &	msg
	)			const [inline, inherited]

virtual int code::ZlibWriter::writeOut	(	const Buffer &	buf,
		const char *	dirName,
		const char *	fileName
	)			const [virtual]

To write into the storage device.

Returns:

zero on success and negative on error.

Implements code::Writer.

int code::Writer::writeXMLDocument	(	const XML::Document &	,
		const std::string &	deviceName,
		const std::string &	messageName
	)			[inherited]

Given a document created from its root element, the contents (in textual form) will be written out.

This method writes out the entire document.

See also:

XMLOutputter

XMLDocument

Returns:

zero on success and negative on error.

---