encoderFactory Class Reference

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

List of all members.

Classes
class	registeredEncoder
	Information about a registered encoder. More...
class	registeredEncoderImpl
Public Member Functions
template<class E >
void	registerName (const string &name)
ref< encoder >	create (const string &name)
const ref< const registeredEncoder >	getEncoderByName (const string &name) const
int	getEncoderCount () const
const ref< const registeredEncoder >	getEncoderAt (const int pos) const
const std::vector< ref< const registeredEncoder > >	getEncoderList () const
Static Public Member Functions
static encoderFactory *	getInstance ()

---

Detailed Description

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

---

Member Function Documentation

ref< 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

Referenced by encoderFactory::getEncoderByName().

const ref< const encoderFactory::registeredEncoder > getEncoderAt

(

const int

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

const ref< 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 encoderFactory::create().

int getEncoderCount

(

)

const

Return the number of registered encoders.

Returns:

number of registered encoders

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

(

)

const

Return a list of all registered encoders.

Returns:

list of registered encoders

encoderFactory * getInstance

(

)

[static]

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

void registerName

(

const string &

name

)

Register a new encoder by its encoding name.

Parameters:

name

encoding name

References stringUtils::toLower().

---

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

• encoderFactory.hpp
• encoderFactory.cpp