#include <AvpData.hpp>

Inheritance diagram for anna::diameter::codec::basetypes::AvpData:

[legend]

Public Member Functions
	AvpData ()

virtual std::string	getFormatName () const =0

virtual int	getSize () const =0

void	code (char *buffer, int &size) noexcept(false)

virtual std::string	asPrintableString () noexcept(false)

std::string	asDataBlockString () noexcept(false)

virtual std::string	asString () noexcept(false)

std::string	asHexString () noexcept(false)

virtual void	decode (const char *buffer, const int size) noexcept(false)=0

void	fromPrintableString (const char *printableString) noexcept(false)

void	fromHexString (const std::string &hexString) noexcept(false)

Protected Member Functions
std::string	assertPrintable (const char *buffer, const int size) const noexcept(false)

Detailed Description

Diameter avp abstract data container

All diameter types inherit from this class. Basic types with one level, derived ones with two levels. Three or more inheritance levels have no sense. Each level has own private members and updateBasic() will be implemented at derived types to keep coherence towards parent ones. This coherence implies to call updateBasic when private members are updated.

  Basic diameter types are:      OctetString, Integer32, Integer64, Unsigned32, Unsigned64, Float32, Float64
  Derived diameter types are:    Address, Time, UTF8String, DiameterIdentity, DiameterURI, IPFilterRule, QoSFilterRule (derived from OctetString)
                                 Enumerated (derived from Integer32)
  Printable derived types are:   UTF8String, DiameterIdentity, DiameterURI, IPFilterRule, QoSFilterRule

  User application could create new diameter types derived for any basic one, and reimplement the methods to adjust its behaviour.

There are setters/getters at any level, and a lot of helpers to decode/interpret the stored data. Then, this class could be used as container and/or helper tool. Parent setters won't modify child members and vice versa, but helpers syncronizes both levels through parent 'code()' and child 'decode()' methods.

Derived types with own members, must use protected or private inheritance, and export base class methods desired (using declaration). This mechanism guarantees private members coherence between different levels: a derived type instance couldn't directly manipulate base class own members.

Constructor & Destructor Documentation

◆ AvpData()

anna::diameter::codec::basetypes::AvpData::AvpData ( )

inline

Default constructor

118 {};

Here is the call graph for this function:

Member Function Documentation

◆ asDataBlockString()

std::string anna::diameter::codec::basetypes::AvpData::asDataBlockString ( )

inlinenoexcept

Gets DataBlock binary block and ascii representation

Returns: String with DataBlock representation

                                                 {
     int size = getSize();
     char buffer[size];
     code(buffer, size);
     anna::DataBlock db(buffer, size);
     return(db.asString());
   }

Here is the call graph for this function:

◆ asHexString()

std::string anna::diameter::codec::basetypes::AvpData::asHexString ( )

inlinenoexcept

Gets the hexadecimal string representation for avp data Used in diameter message 'hex-data' field

Returns: Hexadecimal string representation for avp data

                                           {
     int size = getSize();
     char buffer[size];
     code(buffer, size);
     anna::DataBlock db(buffer, size);
     return anna::functions::asHexString(db);
   }

Here is the call graph for this function:

◆ asPrintableString()

virtual std::string anna::diameter::codec::basetypes::AvpData::asPrintableString ( )

inlinevirtualnoexcept

Gets the natural/smart string representation for avp data (format-dependent content) Used in diameter message 'data' field Default implementation launch exception when data is not printable

Returns: Natural/smart string representation for avp data

Reimplemented in anna::diameter::codec::basetypes::Address, anna::diameter::codec::basetypes::Time, anna::diameter::helpers::tme::codectypes::Unsigned16, anna::diameter::codec::basetypes::Float32, anna::diameter::codec::basetypes::Float64, anna::diameter::codec::basetypes::Integer32, anna::diameter::codec::basetypes::Integer64, anna::diameter::codec::basetypes::Unsigned32, and anna::diameter::codec::basetypes::Unsigned64.

                                                         {
     int size = getSize();
     char buffer[size];
     code(buffer, size);
     return (assertPrintable(buffer, size));
   }

Here is the call graph for this function:

◆ assertPrintable()

std::string anna::diameter::codec::basetypes::AvpData::assertPrintable	(	const char *	buffer,
		const int	size
	)		const

inlineprotectednoexcept

Asserts printable nature for buffer provided and launch exception if not. Must be invoked from 'updateBasic() and decode()' at derived diameter types, when buffer should be printable

Parameters

buffer	Raw avp data
size	Raw avp data length

Returns: Printable string or <null> if not printable

                                                                                       {
     std::string result;
 
     if(size == 0) return result;
 
     bool printable;
     result = anna::functions::asAsciiString(buffer, size, printable);
 
     if(!printable) {
       std::string ex = getFormatName();
       ex += "::assertPrintable | Non-printable data provided";
       throw anna::RuntimeException(ex, ANNA_FILE_LOCATION);
     }
 
     return result;
   }

Here is the call graph for this function:

◆ asString()

virtual std::string anna::diameter::codec::basetypes::AvpData::asString ( void )

inlinevirtualnoexcept

Class string representation Default implementation invokes raw DataBlock 'asString' method, but it should be different specially with complex application data types.

Returns: String with class content

                                                {
     return(asDataBlockString());
   }

Here is the call graph for this function:

◆ code()

void anna::diameter::codec::basetypes::AvpData::code	(	char *	buffer,
		int &	size
	)

inlinenoexcept

Encodes avp data part over buffer externally allocated

Parameters

buffer	Raw data to be encoded
size	Size of raw data to be encoded

                                                      {
     codeBasic(buffer, size);
   }

◆ decode()

virtual void anna::diameter::codec::basetypes::AvpData::decode	(	const char *	buffer,
		const int	size
	)

pure virtualnoexcept

Decodes provided buffer/size

Derived types must invoke base class 'decode()' at the end in order to keep coherence with parent members. This base class decodification actually sets the base class members with the same buffer provided, being more comfortable than using base class setters.

Parameters

buffer	Raw avp data
size	Raw avp data length

◆ fromHexString()

void anna::diameter::codec::basetypes::AvpData::fromHexString ( const std::string & hexString )

inlinenoexcept

Initializes members from hexadecimal string representation. I.e.: af1233fb01 (even number of digits).

Parameters

hexString Raw avp data in hexadecimal string representation

                                                                  {
     anna::DataBlock db(true);
     anna::functions::fromHexString(hexString, db);
     decode(db.getData(), db.getSize());
   }

Here is the call graph for this function:

◆ fromPrintableString()

void anna::diameter::codec::basetypes::AvpData::fromPrintableString ( const char * printableString )

inlinenoexcept

Initializes members from natural/smart string representation

Parameters

printableString avp data in natural/smart string representation (human-readable)

                                                                          {
     if(!printableString) {
       std::string ex = getFormatName();
       ex += "::fromPrintableString | Null printableString provided";
       throw anna::RuntimeException(ex, ANNA_FILE_LOCATION);
     }
 
     /*std::string dummy =*/assertPrintable(printableString, strlen(printableString));
     setPrintableString(printableString);
   }

Here is the call graph for this function:

◆ getFormatName()

virtual std::string anna::diameter::codec::basetypes::AvpData::getFormatName ( ) const

pure virtual

Gets the avp data format name

Returns: avp data format name

◆ getSize()

virtual int anna::diameter::codec::basetypes::AvpData::getSize ( ) const

pure virtual

Gets the avp data size based on basic container. The AVP Data field is zero or more octets.

Returns: avp data size

Implemented in anna::diameter::codec::basetypes::OctetString, anna::diameter::codec::basetypes::Float32, anna::diameter::codec::basetypes::Float64, anna::diameter::codec::basetypes::Integer32, anna::diameter::codec::basetypes::Integer64, anna::diameter::codec::basetypes::Unsigned32, and anna::diameter::codec::basetypes::Unsigned64.

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

/tmp/anna/include/anna/diameter/codec/basetypes/AvpData.hpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AvpData()

Member Function Documentation

◆ asDataBlockString()

◆ asHexString()

◆ asPrintableString()

◆ assertPrintable()

◆ asString()

◆ code()

◆ decode()

◆ fromHexString()

◆ fromPrintableString()

◆ getFormatName()

◆ getSize()