stringContentHandler Class Reference

#include <stringContentHandler.hpp>

Inheritance diagram for stringContentHandler:

Collaboration diagram for stringContentHandler:

Public Member Functions
	stringContentHandler ()
	stringContentHandler (const string &buffer, const vmime::encoding &enc=NO_ENCODING)
	stringContentHandler (const utility::stringProxy &str, const vmime::encoding &enc=NO_ENCODING)
	stringContentHandler (const string &buffer, const size_t start, const size_t end, const vmime::encoding &enc=NO_ENCODING)
	~stringContentHandler ()
	stringContentHandler (const stringContentHandler &cts)
stringContentHandler &	operator= (const stringContentHandler &cts)
shared_ptr< contentHandler >	clone () const
void	setData (const utility::stringProxy &str, const vmime::encoding &enc=NO_ENCODING)
void	setData (const string &buffer, const vmime::encoding &enc=NO_ENCODING)
void	setData (const string &buffer, const size_t start, const size_t end, const vmime::encoding &enc=NO_ENCODING)
stringContentHandler &	operator= (const string &buffer)
void	generate (utility::outputStream &os, const vmime::encoding &enc, const size_t maxLineLength=lineLengthLimits::infinite) const
void	extract (utility::outputStream &os, utility::progressListener *progress=NULL) const
void	extractRaw (utility::outputStream &os, utility::progressListener *progress=NULL) const
size_t	getLength () const
bool	isEncoded () const
const vmime::encoding &	getEncoding () const
bool	isEmpty () const
bool	isBuffered () const
void	setContentTypeHint (const mediaType &type)
const mediaType	getContentTypeHint () const
Public Member Functions inherited from contentHandler
virtual	~contentHandler ()

Additional Inherited Members
Static Public Attributes inherited from contentHandler
static const vmime::encoding	NO_ENCODING
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Constructor & Destructor Documentation

stringContentHandler() [1/5]

stringContentHandler

(

)

stringContentHandler() [2/5]

stringContentHandler	(	const string &	buffer,
		const vmime::encoding &	enc = NO_ENCODING
	)

stringContentHandler() [3/5]

stringContentHandler	(	const utility::stringProxy &	str,
		const vmime::encoding &	enc = NO_ENCODING
	)

stringContentHandler() [4/5]

stringContentHandler	(	const string &	buffer,
		const size_t	start,
		const size_t	end,
		const vmime::encoding &	enc = NO_ENCODING
	)

~stringContentHandler()

~stringContentHandler

(

)

stringContentHandler() [5/5]

stringContentHandler

(

const stringContentHandler &

cts

)

Member Function Documentation

clone()

shared_ptr< contentHandler > clone ( ) const

virtual

Return a copy of this object.

Returns

copy of this object

Implements contentHandler.

References vmime::dynamicCast().

extract()

void extract ( utility::outputStream &  os, utility::progressListener *  progress = NULL  ) const

virtual

Extract the contents into the specified stream.

If needed, data will be decoded before being written into the stream.

Exceptions

exceptions::no_encoder_available

if the encoding is not supported

Parameters

os	output stream
progress	progress listener, or NULL if you do not want to receive progress notifications

Implements contentHandler.

References vmime::dynamicCast(), stringProxy::extract(), encoding::getEncoder(), stringContentHandler::getLength(), stringContentHandler::isEncoded(), and stringProxy::length().

extractRaw()

void extractRaw ( utility::outputStream &  os, utility::progressListener *  progress = NULL  ) const

virtual

Extract the contents into the specified stream, without decoding it.

It may be useful in case the encoding is not supported and you want to extract raw data.

Parameters

os	output stream
progress	progress listener, or NULL if you do not want to receive progress notifications

Implements contentHandler.

References vmime::dynamicCast(), stringProxy::extract(), and stringProxy::length().

generate()

void generate ( utility::outputStream &  os, const vmime::encoding &  enc, const size_t  maxLineLength = lineLengthLimits::infinite  ) const

virtual

Output the contents into the specified stream.

Data will be encoded before being written into the stream. This is used internally by the body object to generate the message, you may not need to use this (see contentHandler::extract() if you want to get the contents).

Parameters

os	output stream
enc	encoding for output
maxLineLength	maximum line length for output

Implements contentHandler.

References vmime::dynamicCast(), stringProxy::extract(), encoding::getEncoder(), mediaType::getType(), stringContentHandler::isEncoded(), and vmime::mediaTypes::TEXT.

getContentTypeHint()

const mediaType getContentTypeHint ( ) const

virtual

Returns a hint about the kind of data managed by this object.

Returns

type content media type

Implements contentHandler.

getEncoding()

const vmime::encoding & getEncoding ( ) const

virtual

Returns the encoding used for data (or "binary" if not encoded).

Returns

encoding used for data

Implements contentHandler.

getLength()

size_t getLength ( ) const

virtual

Returns the actual length of data.

WARNING: this can return 0 if no length was specified when setting data of this object, or if the length is not known).

Returns

length of data

Implements contentHandler.

References stringProxy::length().

Referenced by stringContentHandler::extract().

isBuffered()

bool isBuffered ( ) const

virtual

Indicates whether the extract() method can be called multiple times.

Returns

true if the data can be extracted multiple times, or false if not (ie. streamed data from socket)

Implements contentHandler.

isEmpty()

bool isEmpty ( ) const

virtual

Returns 'true' if there is no data set.

Returns

true if no data is managed by this object, false otherwise

Implements contentHandler.

References stringProxy::length().

isEncoded()

bool isEncoded ( ) const

virtual

Returns 'true' if data managed by this object is encoded.

Returns

true if data is encoded, false otherwise

Implements contentHandler.

References contentHandler::NO_ENCODING.

Referenced by stringContentHandler::extract(), and stringContentHandler::generate().

operator=() [1/2]

stringContentHandler & operator=

(

const string &

buffer

)

References vmime::dynamicCast(), contentHandler::NO_ENCODING, and stringContentHandler::setData().

operator=() [2/2]

stringContentHandler & operator=

(

const stringContentHandler &

cts

)

References vmime::dynamicCast().

setContentTypeHint()

void setContentTypeHint ( const mediaType &  type )

virtual

Gives a hint about the kind of data managed by this object.

Parameters

type	content media type

Implements contentHandler.

setData() [1/3]

void setData	(	const string &	buffer,
		const size_t	start,
		const size_t	end,
		const vmime::encoding &	enc = NO_ENCODING
	)

References vmime::dynamicCast(), vmime::end(), and stringProxy::set().

setData() [2/3]

void setData	(	const string &	buffer,
		const vmime::encoding &	enc = NO_ENCODING
	)

References vmime::dynamicCast(), and stringProxy::set().

setData() [3/3]

void setData	(	const utility::stringProxy &	str,
		const vmime::encoding &	enc = NO_ENCODING
	)

References vmime::dynamicCast().

Referenced by stringContentHandler::operator=().

---

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

• stringContentHandler.hpp
• stringContentHandler.cpp