code::GzipWriter Class Reference

Inheritance diagram for code::GzipWriter:

List of all members.

---

Detailed Description

Writer subclass that handles writing to gzipped files.

TypeName::GzippedFile

Author:

Lulin Song, Charles Kerr

Version:

Id

code_GzipWriter.h,v 1.11 2009/06/02 20:17:39 lakshman Exp

Public Member Functions
virtual int	writeOut (const Buffer &buf, const char *dirName, const char *fileName) const
	To write into the storage device.
virtual	~GzipWriter ()
	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 SmartPtr< Writer >	getWriter (const std::string &)
	Obtain the storage type's Writer.
Protected Member Functions
	GzipWriter ()
	Hide the default ctor so that only subclasses can use it.

---

Constructor & Destructor Documentation

virtual code::GzipWriter::~GzipWriter

(

)

[inline, virtual]

Empty virtual destructor, to permit subclassing.

code::GzipWriter::GzipWriter

(

)

[inline, protected]

Hide the default ctor so that only subclasses can use it.

All other use the factory.

---

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::GzipWriter::introduceSelf

(

)

[static]

Announce oneself to the system.

This function needs to be invoked before GZipWriter 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::GzipWriter::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.

---