#include <emptyContentHandler.hpp>
Public Member Functions | |
| emptyContentHandler () | |
| shared_ptr< contentHandler > | clone () const |
| 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
◆ emptyContentHandler()
Member Function Documentation
◆ clone()
|
virtual |
Return a copy of this object.
- Returns
- copy of this object
Implements contentHandler.
References vmime::dynamicCast().
◆ extract()
|
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 progressListener::start(), and progressListener::stop().
◆ extractRaw()
|
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 progressListener::start(), and progressListener::stop().
◆ generate()
|
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.
◆ getContentTypeHint()
Returns a hint about the kind of data managed by this object.
- Returns
- type content media type
Implements contentHandler.
◆ getEncoding()
|
virtual |
Returns the encoding used for data (or "binary" if not encoded).
- Returns
- encoding used for data
Implements contentHandler.
References contentHandler::NO_ENCODING.
◆ getLength()
|
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.
◆ isBuffered()
|
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()
|
virtual |
Returns 'true' if there is no data set.
- Returns
- true if no data is managed by this object, false otherwise
Implements contentHandler.
◆ isEncoded()
|
virtual |
Returns 'true' if data managed by this object is encoded.
- Returns
- true if data is encoded, false otherwise
Implements contentHandler.
◆ setContentTypeHint()
Gives a hint about the kind of data managed by this object.
- Parameters
-
type content media type
Implements contentHandler.
The documentation for this class was generated from the following files:
