anna::diameter::app::dcca::Message Class Reference

#include <Message.hpp>

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

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

Public Member Functions
const UTF8String *	getSubscriptionIdData (int subscriptionIdType=helpers::dcca::AVPVALUES__Subscription_Id_Type::END_USER_E164, anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const anna::diameter::codec::Avp *	getMultipleServicesCreditControl (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Unsigned32 *	getServiceIdentifier (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Unsigned32 *	getRatingGroup (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Enumerated *	getTariffChangeUsage (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Unsigned32 *	getValidityTime (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const anna::diameter::codec::Avp *	getRequestedServiceUnit (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const anna::diameter::codec::Avp *	getUsedServiceUnit (int ocurrence=1, anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Enumerated *	getCCRequestType (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Unsigned32 *	getCCRequestNumber (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const Enumerated *	getMultipleServicesIndicator (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const UTF8String *	getServiceContextId (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const UTF8String *	get3GPPNSAPI (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const UTF8String *	get3GPPSelectionMode (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const OctetString *	get3GPPSessionStopIndicator (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const anna::diameter::codec::Avp *	getUserEquipmentInfo (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
const OctetString *	getUserEquipmentInfoValue (int userEquipmentInfoType=helpers::dcca::AVPVALUES__User_Equipment_Info_Type::IMEISV, anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)
virtual const UTF8String *	get3GPPGPRSNegQoSProfile (anna::Exception::Mode::_v emode=anna::Exception::Mode::Throw) noexcept(false)=0
const qosProfile_t &	decode3GPPGPRSNegQoSProfile () noexcept(false)
Public Member Functions inherited from anna::diameter::app::base::Message
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 message for DCCA (diameter credit control application)

Member Function Documentation

decode3GPPGPRSNegQoSProfile()

const qosProfile_t& anna::diameter::app::dcca::Message::decode3GPPGPRSNegQoSProfile ( )

noexcept

Decodes 3GPP-GPRS-Neg-QoS-Profile (as described in 3GPP TS 24.008)

Returns

3GPP-GPRS-Neg-QoS-Profile decoded on struct

get3GPPGPRSNegQoSProfile()

virtual const UTF8String* anna::diameter::app::dcca::Message::get3GPPGPRSNegQoSProfile ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

pure virtualnoexcept

Implemented in anna::diameter::app::dcca::nokia::Message, and anna::diameter::app::dcca::huawei::Message.

get3GPPNSAPI()

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

inlinenoexcept

Avp 3GPP-NSAPI 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::tgpp::AVPID__3GPP_NSAPI)->getUTF8String());
  }

get3GPPSelectionMode()

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

inlinenoexcept

Avp 3GPP-Selection-Mode 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::tgpp::AVPID__3GPP_Selection_Mode)->getUTF8String());
  }

get3GPPSessionStopIndicator()

const OctetString* anna::diameter::app::dcca::Message::get3GPPSessionStopIndicator ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp 3GPP-Session-Stop-Indicator 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::tgpp::AVPID__3GPP_Session_Stop_Indicator)->getOctetString());
  }

getCCRequestNumber()

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

inlinenoexcept

Avp CC_Request_Number 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::dcca::AVPID__CC_Request_Number)->getUnsigned32());
  }

getCCRequestType()

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

inlinenoexcept

Avp CC_Request_Type 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::dcca::AVPID__CC_Request_Type)->getEnumerated());
  }

getMultipleServicesCreditControl()

const anna::diameter::codec::Avp* anna::diameter::app::dcca::Message::getMultipleServicesCreditControl ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp Multiple-Services-Credit-Control 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::dcca::AVPID__Multiple_Services_Credit_Control));
  }

getMultipleServicesIndicator()

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

inlinenoexcept

Avp Multiple-Services-Indicator 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::dcca::AVPID__Multiple_Services_Indicator)->getEnumerated());
  }

getRatingGroup()

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

inlinenoexcept

Avp Rating-Group 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::dcca::AVPID__Multiple_Services_Credit_Control)->getAvp(helpers::dcca::AVPID__Rating_Group)->getUnsigned32());
  }

getRequestedServiceUnit()

const anna::diameter::codec::Avp* anna::diameter::app::dcca::Message::getRequestedServiceUnit ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp Requested-Service-Unit 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::dcca::AVPID__Multiple_Services_Credit_Control)->getAvp(helpers::dcca::AVPID__Requested_Service_Unit));
  }

getServiceContextId()

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

inlinenoexcept

Avp Service-Context-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::dcca::AVPID__Service_Context_Id)->getUTF8String());
  }

getServiceIdentifier()

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

inlinenoexcept

Avp Service-Identifier 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::dcca::AVPID__Multiple_Services_Credit_Control)->getAvp(helpers::dcca::AVPID__Service_Identifier)->getUnsigned32());
  }

getSubscriptionIdData()

const UTF8String* anna::diameter::app::dcca::Message::getSubscriptionIdData ( int  subscriptionIdType = helpers::dcca::AVPVALUES__Subscription_Id_Type::END_USER_E164, anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw  )

inlinenoexcept

Avp Subscription-Id-Data data-part pointer reference.

Parameters

Subscription-Id-Type	value to filter the search. END_USER_E164 by default.
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(
      const anna::diameter::codec::Avp * sid;
      int pos = 1;

      while((sid = getAvp(helpers::dcca::AVPID__Subscription_Id, pos++)))
      if(subscriptionIdType == sid->getAvp(helpers::dcca::AVPID__Subscription_Id_Type)->getEnumerated()->getValue())
        return sid->getAvp(helpers::dcca::AVPID__Subscription_Id_Data)->getUTF8String();
        return NULL;
      );
  }

Here is the call graph for this function:

getTariffChangeUsage()

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

inlinenoexcept

Avp Tariff-Change-Usage 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::dcca::AVPID__Multiple_Services_Credit_Control)->
               getAvp(helpers::dcca::AVPID__Used_Service_Unit)->
               getAvp(helpers::dcca::AVPID__Tariff_Change_Usage)->getEnumerated();
    );
  }

getUsedServiceUnit()

const anna::diameter::codec::Avp* anna::diameter::app::dcca::Message::getUsedServiceUnit ( int  ocurrence = 1, anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw  )

inlinenoexcept

Avp n-th Used-Service-Unit pointer reference

Parameters

ocurrence	Select the n-th USU within the MSCC. First by default.
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::dcca::AVPID__Multiple_Services_Credit_Control)->
               getAvp(helpers::dcca::AVPID__Used_Service_Unit, ocurrence);
    );
  }

getUserEquipmentInfo()

const anna::diameter::codec::Avp* anna::diameter::app::dcca::Message::getUserEquipmentInfo ( anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw )

inlinenoexcept

Avp User-Equipment-Info 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::dcca::AVPID__User_Equipment_Info));
  }

getUserEquipmentInfoValue()

const OctetString* anna::diameter::app::dcca::Message::getUserEquipmentInfoValue ( int  userEquipmentInfoType = helpers::dcca::AVPVALUES__User_Equipment_Info_Type::IMEISV, anna::Exception::Mode::_v  emode = anna::Exception::Mode::Throw  )

inlinenoexcept

Avp User-Equipment-Info-Value data-part pointer reference.

Parameters

User-Equipment-Info-Type	value to filter the search. IMEISV by default.
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(
      const anna::diameter::codec::Avp * uei;
      int pos = 1;

      while((uei = getAvp(helpers::dcca::AVPID__User_Equipment_Info, pos++)))
      if(userEquipmentInfoType == uei->getAvp(helpers::dcca::AVPID__User_Equipment_Info_Type)->getEnumerated()->getValue())
        return uei->getAvp(helpers::dcca::AVPID__User_Equipment_Info_Value)->getOctetString();
        return NULL;
      );
  }

Here is the call graph for this function:

getValidityTime()

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

inlinenoexcept

Avp Validity-Time 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::dcca::AVPID__Multiple_Services_Credit_Control)->getAvp(helpers::dcca::AVPID__Validity_Time)->getUnsigned32());
  }

---

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

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