anna::diameter::codec::Engine Class Reference

#include <Engine.hpp>

Inheritance diagram for anna::diameter::codec::Engine:

Collaboration diagram for anna::diameter::codec::Engine:

Public Member Functions
	Engine (const char *className, const stack::Dictionary *dictionary)
void	releaseAvp (Avp *avp)
void	releaseMessage (Message *message)
Public Member Functions inherited from anna::diameter::codec::EngineImpl
Avp *	createAvp (const AvpId *id) noexcept(false)
Message *	createMessage (const CommandId *id) noexcept(false)
	EngineImpl (const char *className, const stack::Dictionary *dictionary)
virtual	~EngineImpl ()
const stack::Dictionary *	getDictionary () const
void	setValidationDepth (const ValidationDepth::_v validationDepth)
ValidationDepth::_v	getValidationDepth () const
void	ignoreFlagsOnValidation (bool ignoreFlags)
bool	ignoreFlagsOnValidation () const
void	setValidationMode (const ValidationMode::_v validationMode)
ValidationMode::_v	getValidationMode () const
void	setFixMode (const FixMode::_v fixMode)
FixMode::_v	getFixMode () const
void	setSingleFailedAVP (bool single=true)
bool	getSingleFailedAVP () const
Avp *	createAvp (AvpId id) noexcept(false)
Avp *	createAvp () noexcept(false)
Message *	createMessage (CommandId id) noexcept(false)
Message *	createMessage () noexcept(false)
Message *	createMessage (const std::string &xmlPathFile_or_string, bool pathfile_or_string=true) noexcept(false)
virtual std::string	asString (void) const
virtual anna::xml::Node *	asXML (anna::xml::Node *parent) const
AvpId	avpIdForName (const char *name) noexcept(false)
CommandId	commandIdForName (const char *name) noexcept(false)
Public Member Functions inherited from anna::Component
virtual	~Component ()
const char *	getClassName () const
Public Member Functions inherited from anna::Mutex
	Mutex (const Mode::_v mode=Mode::Recursive)
virtual	~Mutex ()
virtual void	lock () noexcept(false)
virtual void	unlock ()
bool	trylock () noexcept(false)
	operator const pthread_mutex_t * () const

Protected Member Functions
anna::diameter::codec::Avp *	allocateAvp ()
anna::diameter::codec::Message *	allocateMessage ()
Protected Member Functions inherited from anna::diameter::codec::EngineImpl
void	validationAnomaly (const std::string &description) const noexcept(false)
Protected Member Functions inherited from anna::Component
	Component (const char *className)
	Component (const Component &other)
Protected Member Functions inherited from anna::Safe
	Safe ()

Protected Attributes
anna::Recycler< Avp >	a_avps
anna::Recycler< Message >	a_messages
Protected Attributes inherited from anna::Component
const std::string	a_className

Friends
class	Message
class	Avp

Detailed Description

Standard inheritance for engine component implementation, allocating basic Avp and Message classes.

Constructor & Destructor Documentation

Engine()

anna::diameter::codec::Engine::Engine ( const char *  className, const stack::Dictionary *  dictionary  )

inline

Constructor

Parameters

className

Logical name for the class.

: EngineImpl(className, dictionary) {;}

Member Function Documentation

allocateAvp()

anna::diameter::codec::Avp* anna::diameter::codec::Engine::allocateAvp ( )

inlineprotectedvirtual

Avp allocator method.

It is recommended to use anna::Recycler for Avps creation/releasing.

See also

anna::Recycler

Implements anna::diameter::codec::EngineImpl.

{ return a_avps.create(); }

Here is the call graph for this function:

allocateMessage()

anna::diameter::codec::Message* anna::diameter::codec::Engine::allocateMessage ( )

inlineprotectedvirtual

Message allocator method.

It is recommended to use anna::Recycler for Message creation/releasing.

See also

anna::Recycler

Implements anna::diameter::codec::EngineImpl.

{ return a_messages.create(); }

Here is the call graph for this function:

releaseAvp()

void anna::diameter::codec::Engine::releaseAvp ( Avp *  )

inlinevirtual

Invoked to free Avps.

See also

anna::Recycler

Implements anna::diameter::codec::EngineImpl.

                            {
    if(avp == NULL) return;

    //Avp* aux = static_cast <Avp*> (avp);
//        avp/*aux*/->clear(); // free internal data-part storage specially for grouped avps which will release its childrens
    a_avps.release(avp/*aux*/);
  }

releaseMessage()

void anna::diameter::codec::Engine::releaseMessage ( Message *  )

inlinevirtual

Invoked to free Messages.

See also

anna::Recycler

Implements anna::diameter::codec::EngineImpl.

                                        {
    if(message == NULL) return;

    //Message* aux = static_cast <Message*> (message);
//        message/*aux*/->clear(); // free internal data-part storage specially for childrens releasing
    a_messages.release(message/*aux*/);
  }

Friends And Related Function Documentation

Avp

friend class Avp

friend

Message

friend class Message

friend

Member Data Documentation

a_avps

anna::Recycler<Avp> anna::diameter::codec::Engine::a_avps

protected

a_messages

anna::Recycler<Message> anna::diameter::codec::Engine::a_messages

protected

---

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

• /tmp/anna/include/anna/diameter/codec/Engine.hpp