anna::diameter::codec::Format Struct Reference

#include <Format.hpp>

Public Types
enum	_v {   None = -1, Unknown, Any, OctetString,   Integer32, Integer64, Unsigned32, Unsigned64,   Float32, Float64, Grouped, Address,   Time, UTF8String, DiameterIdentity, DiameterURI,   Enumerated, IPFilterRule, QoSFilterRule }

Public Member Functions
	anna_declare_enum (diameter::codec::Format)

Static Public Member Functions
static const char *	asText (const Format::_v v) noexcept(false)
static bool	isReserved (const std::string &formatName)
static bool	isRFC3588 (const std::string &formatName)

Detailed Description

Diameter RFC3588 Avp Data Format definition

Member Enumeration Documentation

_v

enum anna::diameter::codec::Format::_v

Enumerator
None
Unknown
Any
OctetString
Integer32
Integer64
Unsigned32
Unsigned64
Float32
Float64
Grouped
Address
Time
UTF8String
DiameterIdentity
DiameterURI
Enumerated
IPFilterRule
QoSFilterRule

          {
    None = -1,        // Initialized

// Reserved
    Unknown,          // Unregistered at diameter dictionary
    Any,              // used on generic AVP
// RFC 3588
    OctetString,      // S8*  n (possible zero-padding)
    Integer32,        // S32  4
    Integer64,        // S64  8
    Unsigned32,       // U32  4
    Unsigned64,       // U64  8
    Float32,          // F32  4
    Float64,          // F64  8
    Grouped,          // U32* 4*n
    Address,          // S8*  4 (IPv4) or 16 (IPv6)
    Time,             // S8*  4
    UTF8String,       // S8*  n (possible zero-padding)
    DiameterIdentity, // S8*  n (possible zero-padding)
    DiameterURI,      // S8*  n (possible zero-padding)
    Enumerated,       // S32  4
    IPFilterRule,     // S8*  n (possible zero-padding)
    QoSFilterRule     // S8*  n (possible zero-padding)
  };

Member Function Documentation

anna_declare_enum()

anna::diameter::codec::Format::anna_declare_enum

(

diameter::codec::Format

)

asText()

static const char* anna::diameter::codec::Format::asText ( const Format::_v  v )

inlinestaticnoexcept

Format description

Parameters

v	Format type

Returns

Format description

                                                              {
    return asCString(v);
  }

isReserved()

static bool anna::diameter::codec::Format::isReserved ( const std::string &  formatName )

inlinestatic

Boolean about if format type is reserved (API internal use)

Parameters

formatName

Format text name

Returns

Boolean 'true' if reserved for internal use, 'false' if is user format type (RFC 3588 or application-specific)

                                                       {
    if(formatName == asText(Format::Unknown)) return true;

    if(formatName == asText(Format::Any)) return true;

    return false;
  }

Here is the call graph for this function:

isRFC3588()

static bool anna::diameter::codec::Format::isRFC3588 ( const std::string &  formatName )

inlinestatic

Boolean about if format type belongs to RFC 3588

Parameters

formatName

Format text name

Returns

Boolean 'true' if belongs to RFC 3588, 'false' if is application-specific)

                                                      {
    if(isReserved(formatName)) return false;

    return (asEnum(formatName) != None);
  }

Here is the call graph for this function:

---

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

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