An AVP extractor object. More...

#include <efd.h>

Inheritance diagram for FDExtractorAvp:

Public Member Functions
	FDExtractorAvp (FDExtractor &extractor, FDDictionaryEntryAVP &de, Bool dedel=false)
	Class constructor. More...

virtual	~FDExtractorAvp ()
	Class destructor. More...

eFDExtractorType	getExtractorType ()
	Retrieves the extractor type. More...

Void	setAvp (struct avp *a)
	Assigns the underlying freeDiameter AVP to this extractor. More...

struct avp *	getAvp ()
	Retrieves the underlying freeDiameter AVP pointer. More...

union avp_value *	getAvpValue ()
	Retrieves the underlying freeDiameter AVP value pointer. More...

Bool	exists ()
	Determines if this extractor exists in the underlying freeDiameter message or grouped AVP. More...

Bool	get (int32_t &v)
	Retrieves an int32_t AVP value. Returns True if the value is successfully retrieved. More...

Bool	get (uint32_t &v)
	Retrieves an uint32_t AVP value. Returns True if the value is successfully retrieved. More...

Bool	get (uint64_t &v)
	Retrieves an uint64_t AVP value. Returns True if the value is successfully retrieved. More...

Bool	get (float &v)
	Retrieves a float AVP value. More...

Bool	get (double &v)
	Retrieves a double AVP value. More...

Bool	get (int64_t &v)
	Retrieves an int64_t AVP value. More...

Bool	get (std::string &v)
	Retrieves a string AVP value. More...

Bool	get (char *data, size_t &len)
	Retrieves an octet string AVP value. More...

Bool	get (uint8_t *data, size_t &len)
	Retrieves an octet string AVP value. More...

Bool	get (sSS &ss)
	Retrieves an IP address AVP value. More...

Bool	get (ETime &t)
	Retrieves a time AVP value. More...

Void	dump ()
	Prints the contents of this AVP to the screen. More...

Bool	getJson (std::string &json)
	Retrieves the JSON string representing the AVP values for this AVP. More...

Public Member Functions inherited from FDExtractorBase
	FDExtractorBase (FDDictionaryEntryAVP *de)
	Class constructor. More...

virtual	~FDExtractorBase ()
	Class destructor. More...

Int	getIndex ()
	Retrieves the location of the AVP in the parent (message or AVP). More...

Int	setIndex (Int idx)
	Assigns the index of this AVP. More...

Bool	getResolved ()
	Retrieves the resolved status. Being resolved means that the underlying freeDiameter AVP has been located and assigned. More...

Bool	setResolved (Bool resolved=true)
	Assigns the resolved state. More...

Bool	exists ()
	Retrieves status indicating if the AVP is present/exists in the message. More...

FDDictionaryEntryAVP *	getDictionaryEntry ()
	Retrieves the dictionary entry associated with the AVP. More...

Detailed Description

An AVP extractor object.

Constructor & Destructor Documentation

◆ FDExtractorAvp()

FDExtractorAvp::FDExtractorAvp	(	FDExtractor &	extractor,
		FDDictionaryEntryAVP &	de,
		Bool	dedel = `false`
	)

Class constructor.

Parameters

extractor	the parent extractor.
de	the dictionary for this AVP extractor.
dedel	indicates if the dictionary entry object is to be destroyed when this object is destroyed.

◆ ~FDExtractorAvp()

FDExtractorAvp::~FDExtractorAvp ( )

virtual

Class destructor.

Member Function Documentation

◆ dump()

Void FDExtractorAvp::dump ( )

Prints the contents of this AVP to the screen.

◆ exists()

Bool FDExtractorAvp::exists ( )

Determines if this extractor exists in the underlying freeDiameter message or grouped AVP.

Returns: True if the AVP has been found in the message or grouped AVP.

◆ get() [1/11]

Bool FDExtractorAvp::get	(	char *	data,
		size_t &	len
	)

inline

Retrieves an octet string AVP value.

Parameters

data	the variable to populate.
len	the maximum length of the octet string.

Returns: True if the value was retrieved, otherwise False.

◆ get() [2/11]

Bool FDExtractorAvp::get ( double & v )

inline

Retrieves a double AVP value.

Parameters

v	the variable to populate.

Returns: True if the value was retrieved, otherwise False.

◆ get() [3/11]

Bool FDExtractorAvp::get ( ETime & t )

inline

Retrieves a time AVP value.

Parameters

t	the variable to populate.

Returns: True if the value was retrieved, otherwise False.

Exceptions

FDException

◆ get() [4/11]

Bool FDExtractorAvp::get ( float & v )

inline

Retrieves a float AVP value.

Parameters

v	the variable to populate.

Returns: True if the value was retrieved, otherwise False.

◆ get() [5/11]

Bool FDExtractorAvp::get ( int32_t & v )

inline

Retrieves an int32_t AVP value. Returns True if the value is successfully retrieved.

Parameters

v	the variable to populate.

Returns: True if the value was retrieved, otherwise False.

◆ get() [6/11]

Bool FDExtractorAvp::get ( int64_t & v )

inline

Retrieves an int64_t AVP value.

Parameters

v	the variable to populate.

Returns: True if the value was retrieved, otherwise False.

◆ get() [7/11]

Bool FDExtractorAvp::get ( sSS & ss )

inline

Retrieves an IP address AVP value.

Parameters

ss	the variable to populate.

Returns: True if the value was retrieved, otherwise False.

◆ get() [8/11]

Bool FDExtractorAvp::get ( std::string & v )

inline

Retrieves a string AVP value.

Parameters

v	the variable to populate.

Returns: True if the value was retrieved, otherwise False.

◆ get() [9/11]

Bool FDExtractorAvp::get ( uint32_t & v )

inline

Retrieves an uint32_t AVP value. Returns True if the value is successfully retrieved.

Parameters

v	the variable to populate.

Returns: True if the value was retrieved, otherwise False.

◆ get() [10/11]

Bool FDExtractorAvp::get ( uint64_t & v )

inline

Retrieves an uint64_t AVP value. Returns True if the value is successfully retrieved.

Parameters

v	the variable to populate.

Returns: True if the value was retrieved, otherwise False.

◆ get() [11/11]

Bool FDExtractorAvp::get	(	uint8_t *	data,
		size_t &	len
	)

inline

Retrieves an octet string AVP value.

Parameters

data	the variable to populate.
len	the maximum length of the octet string.

Returns: True if the value was retrieved, otherwise False.

◆ getAvp()

struct avp* FDExtractorAvp::getAvp ( )

inline

Retrieves the underlying freeDiameter AVP pointer.

Returns: the underlying freeDiameter AVP pointer.

◆ getAvpValue()

union avp_value* FDExtractorAvp::getAvpValue ( )

inline

Retrieves the underlying freeDiameter AVP value pointer.

Returns: the underlying freeDiameter AVP value pointer.

◆ getExtractorType()

eFDExtractorType FDExtractorAvp::getExtractorType ( )

inlinevirtual

Retrieves the extractor type.

Returns: the extractor type.

Implements FDExtractorBase.

◆ getJson()

Bool FDExtractorAvp::getJson ( std::string & json )

Retrieves the JSON string representing the AVP values for this AVP.

Parameters

json	the JSON string to populate.

Returns: True if the JSON string was populated, otherwise False.

◆ setAvp()

Void FDExtractorAvp::setAvp ( struct avp * a )

inline

Assigns the underlying freeDiameter AVP to this extractor.

Parameters

a	the underlying freeDiameter AVP pointer.

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

/home/vagrant/share/code/epctools/include/epc/efd.h
/home/vagrant/share/code/epctools/src/efd.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FDExtractorAvp()

◆ ~FDExtractorAvp()

Member Function Documentation

◆ dump()

◆ exists()

◆ get() [1/11]

◆ get() [2/11]

◆ get() [3/11]

◆ get() [4/11]

◆ get() [5/11]

◆ get() [6/11]

◆ get() [7/11]

◆ get() [8/11]

◆ get() [9/11]

◆ get() [10/11]

◆ get() [11/11]

◆ getAvp()

◆ getAvpValue()

◆ getExtractorType()

◆ getJson()

◆ setAvp()