encoderFactory Class Reference

#include <encoderFactory.hpp>

Classes
class	registeredEncoder

Public Member Functions
template<class E >
void	registerName (const string &name)
shared_ptr< encoder >	create (const string &name)
const shared_ptr< const registeredEncoder >	getEncoderByName (const string &name) const
size_t	getEncoderCount () const
const shared_ptr< const registeredEncoder >	getEncoderAt (const size_t pos) const
const std::vector< shared_ptr< const registeredEncoder > >	getEncoderList () const

Static Public Member Functions
static shared_ptr< encoderFactory >	getInstance ()

Detailed Description

A factory to create 'encoder' objects for the specified encoding.

Member Function Documentation

create()

shared_ptr< encoder > create

(

const string &

name

)

Create a new encoder instance from an encoding name.

Parameters

name	encoding name (eg. "base64")

Returns

a new encoder instance for the specified encoding

Exceptions

exceptions::no_encoder_available

if no encoder is registered for this encoding

References encoderFactory::create(), and encoderFactory::getEncoderByName().

Referenced by encoderFactory::create().

getEncoderAt()

const shared_ptr< const encoderFactory::registeredEncoder > getEncoderAt

(

const size_t

pos

)

const

Return the registered encoder at the specified position.

Parameters

pos	position of the registered encoder to return

Returns

registered encoder at the specified position

References vmime::dynamicCast().

getEncoderByName()

const shared_ptr< const encoderFactory::registeredEncoder > getEncoderByName

(

const string &

name

)

const

Return information about a registered encoder.

Parameters

name	encoding name

Returns

information about this encoder

Exceptions

exceptions::no_encoder_available

if no encoder is registered for this encoding

References vmime::dynamicCast(), and stringUtils::toLower().

Referenced by encoderFactory::create().

getEncoderCount()

size_t getEncoderCount

(

)

const

Return the number of registered encoders.

Returns

number of registered encoders

getEncoderList()

const std::vector< shared_ptr< const encoderFactory::registeredEncoder > > getEncoderList

(

)

const

Return a list of all registered encoders.

Returns

list of registered encoders

References vmime::dynamicCast().

getInstance()

shared_ptr< encoderFactory > getInstance ( )

static

References vmime::dynamicCast().

Referenced by SASLContext::decodeB64(), SASLContext::encodeB64(), and encoding::getEncoder().

registerName()

template<class E >

void registerName

(

const string &

name

)

Register a new encoder by its encoding name.

Parameters

name	encoding name

References vmime::dynamicCast().

---

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

• encoderFactory.hpp
• encoderFactory.cpp