include/anna/diameter/codec/Format.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_diameter_codec_Format_hpp
  38 #define anna_diameter_codec_Format_hpp
  39
  40
  41 #include <anna/core/RuntimeException.hpp>
  42 #include <anna/core/define.autoenum.hpp>
  43
  44 // STL
  45 #include <string>
  46
  47
  48 namespace anna {
  49
  50 namespace diameter {
  51
  52 namespace codec {
  53
  54 /**
  55 * Diameter RFC3588 Avp Data Format definition
  56 */
  57 struct Format {
  58   enum _v {
  59     None = -1,        // Initialized
  60
  61 // Reserved
  62     Unknown,          // Unregistered at diameter dictionary
  63     Any,              // used on generic AVP
  64 // RFC 3588
  65     OctetString,      // S8*  n (possible zero-padding)
  66     Integer32,        // S32  4
  67     Integer64,        // S64  8
  68     Unsigned32,       // U32  4
  69     Unsigned64,       // U64  8
  70     Float32,          // F32  4
  71     Float64,          // F64  8
  72     Grouped,          // U32* 4*n
  73     Address,          // S8*  4 (IPv4) or 16 (IPv6)
  74     Time,             // S8*  4
  75     UTF8String,       // S8*  n (possible zero-padding)
  76     DiameterIdentity, // S8*  n (possible zero-padding)
  77     DiameterURI,      // S8*  n (possible zero-padding)
  78     Enumerated,       // S32  4
  79     IPFilterRule,     // S8*  n (possible zero-padding)
  80     QoSFilterRule     // S8*  n (possible zero-padding)
  81   };
  82
  83   anna_declare_enum(diameter::codec::Format);
  84
  85   /**
  86   * Format description
  87   *
  88   * @param v Format type
  89   *
  90   * @return Format description
  91   */
  92   static const char* asText(const Format::_v v) throw(anna::RuntimeException) {
  93     return asCString(v);
  94   }
  95
  96
  97   /**
  98   * Boolean about if format type is reserved (API internal use)
  99   *
 100   * @param formatName Format text name
 101   *
 102   * @return Boolean 'true' if reserved for internal use, 'false' if is user format type (RFC 3588 or application-specific)
 103   */
 104   static bool isReserved(const std::string & formatName) {
 105     if(formatName == asText(Format::Unknown)) return true;
 106
 107     if(formatName == asText(Format::Any)) return true;
 108
 109     return false;
 110   }
 111
 112
 113   /**
 114   * Boolean about if format type belongs to RFC 3588
 115   * @param formatName Format text name
 116   * @return Boolean 'true' if belongs to RFC 3588, 'false' if is application-specific)
 117   */
 118   static bool isRFC3588(const std::string & formatName) {
 119     if(isReserved(formatName)) return false;
 120
 121     return (asEnum(formatName) != None);
 122   }
 123
 124 };
 125
 126
 127 }
 128 }
 129 }
 130
 131
 132 #endif
 133