anna::diameter::app::base::Message Class Reference

#include <Message.hpp>

Inheritance diagram for anna::diameter::app::base::Message:

Collaboration diagram for anna::diameter::app::base::Message:

Public Member Functions
const UTF8String *	getSessionId (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const DiameterIdentity *	getDestinationHost (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const DiameterIdentity *	getDestinationRealm (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const UTF8String *	getUserName (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Enumerated *	getTerminationCause (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Unsigned32 *	getAuthApplicationId (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Time *	getEventTimestamp (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
Public Member Functions inherited from anna::diameter::codec::Message
	Message (Engine *engine=NULL)
	Message (CommandId id, Engine *engine=NULL)
void	setEngine (Engine *engine)
virtual	~Message ()
void	setId (CommandId id) noexcept(false)
void	setId (const char *name) noexcept(false)
void	setVersion (U8 version)
void	setProxiableBit (bool activate=true)
void	setErrorBit (bool activate=true)
void	setPotentiallyReTransmittedMessageBit (bool activate=true)
void	setApplicationId (U32 aid) noexcept(false)
void	setHopByHop (U32 hbh)
void	setEndToEnd (U32 ete)
void	setHeaderToAnswer (const Message &request) noexcept(false)
void	setStandardToAnswer (const Message &request, const std::string &originHost, const std::string &originRealm, int resultCode=helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) noexcept(false)
void	setResultCode (int rc=helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) noexcept(false)
int	getResultCode () const
Avp *	addAvp (AvpId id) noexcept(false)
Avp *	addAvp (const char *name) noexcept(false)
Avp *	addAvp (Avp *avp)
bool	removeAvp (AvpId id, int ocurrence=1) noexcept(false)
bool	removeAvp (const char *name, int ocurrence=1) noexcept(false)
virtual void	clear (bool resetEngine=true) noexcept(false)
void	decode (const anna::DataBlock &db, Message *ptrAnswer=NULL) noexcept(false)
void	fix ()
bool	valid (Message *ptrAnswer=NULL) const noexcept(false)
void	fromXML (const anna::xml::Node *messageNode) noexcept(false)
void	loadXMLFile (const std::string &xmlPathFile) noexcept(false)
void	loadXMLString (const std::string &xmlString) noexcept(false)
const CommandId &	getId () const
U8	getVersion () const
bool	isRequest () const
bool	isAnswer () const
const U32 &	getApplicationId () const
const U32 &	getHopByHop () const
const U32 &	getEndToEnd () const
const anna::diameter::stack::Command *	getStackCommand () const noexcept(false)
bool	requestBit () const
bool	proxiableBit () const
bool	errorBit () const
bool	potentiallyReTransmittedMessageBit () const
const Avp *	getAvp (AvpId id, int ocurrence=1, anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) const noexcept(false)
Avp *	getAvp (AvpId id, int ocurrence=1, anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Avp *	getAvp (const char *name, int ocurrence=1, anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) const noexcept(false)
Avp *	getAvp (const char *name, int ocurrence=1, anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
int	countAvp (AvpId id) const
int	countAvp (const char *name) const noexcept(false)
int	countChilds () const
const anna::DataBlock &	code () noexcept(false)
anna::xml::Node *	asXML (anna::xml::Node *parent) const
std::string	asXMLString (bool normalize=false) const
bool	isLike (const std::string &pattern) const

Additional Inherited Members
Static Public Attributes inherited from anna::diameter::codec::Message
static const int	HeaderLength
static const U8	RBitMask
static const U8	PBitMask
static const U8	EBitMask
static const U8	TBitMask
Protected Member Functions inherited from anna::diameter::codec::Message
virtual Engine *	getEngine () const noexcept(false)
virtual void	initialize ()
Protected Attributes inherited from anna::diameter::codec::Message
Engine *	a_engine

Detailed Description

Diameter base message

Member Function Documentation

getAuthApplicationId()

const Unsigned32* anna::diameter::app::base::Message::getAuthApplicationId ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp Auth-Application-Id data-part pointer reference

Parameters

emode

Excepcion mode handling when avp is not found: Ignore (no action is taken but debug trace), Throw (exception launched, by default), Trace (trace warning).

                                                                                                              {
    ASSERT_APP_GETAVP(return getAvp(helpers::base::AVPID__Auth_Application_Id)->getUnsigned32());
  }

getDestinationHost()

const DiameterIdentity* anna::diameter::app::base::Message::getDestinationHost ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp Destination-Host data-part pointer reference

Parameters

emode

Excepcion mode handling when avp is not found: Ignore (no action is taken but debug trace), Throw (exception launched, by default), Trace (trace warning).

                                                                                                                  {
    ASSERT_APP_GETAVP(return getAvp(helpers::base::AVPID__Destination_Host)->getDiameterIdentity());
  }

getDestinationRealm()

const DiameterIdentity* anna::diameter::app::base::Message::getDestinationRealm ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp Destination-Realm data-part pointer reference

Parameters

emode

Excepcion mode handling when avp is not found: Ignore (no action is taken but debug trace), Throw (exception launched, by default), Trace (trace warning).

                                                                                                                   {
    ASSERT_APP_GETAVP(return getAvp(helpers::base::AVPID__Destination_Realm)->getDiameterIdentity());
  }

getEventTimestamp()

const Time* anna::diameter::app::base::Message::getEventTimestamp ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp Event-Timestamp data-part pointer reference

Parameters

emode

Excepcion mode handling when avp is not found: Ignore (no action is taken but debug trace), Throw (exception launched, by default), Trace (trace warning).

                                                                                                     {
    ASSERT_APP_GETAVP(return getAvp(helpers::radius::AVPID__Event_Timestamp)->getTime());
  }

getSessionId()

const UTF8String* anna::diameter::app::base::Message::getSessionId ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp Session-Id data-part pointer reference

Parameters

emode

Excepcion mode handling when avp is not found: Ignore (no action is taken but debug trace), Throw (exception launched, by default), Trace (trace warning).

                                                                                                      {
    ASSERT_APP_GETAVP(return getAvp(helpers::base::AVPID__Session_Id)->getUTF8String());
  }

getTerminationCause()

const Enumerated* anna::diameter::app::base::Message::getTerminationCause ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp Termination-Cause data-part pointer reference

Parameters

emode

Excepcion mode handling when avp is not found: Ignore (no action is taken but debug trace), Throw (exception launched, by default), Trace (trace warning).

                                                                                                             {
    ASSERT_APP_GETAVP(return getAvp(helpers::base::AVPID__Termination_Cause)->getEnumerated());
  }

getUserName()

const UTF8String* anna::diameter::app::base::Message::getUserName ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp User-Name data-part pointer reference

Parameters

emode

Excepcion mode handling when avp is not found: Ignore (no action is taken but debug trace), Throw (exception launched, by default), Trace (trace warning).

                                                                                                     {
    ASSERT_APP_GETAVP(return getAvp(helpers::radius::AVPID__User_Name)->getUTF8String());
  }

---

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

• /tmp/anna/include/anna/diameter/app/base/Message.hpp