1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
17 // * Neither the name of the copyright holder 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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
37 #ifndef anna_diameter_codec_Format_hpp
38 #define anna_diameter_codec_Format_hpp
41 #include <anna/core/RuntimeException.hpp>
42 #include <anna/core/define.autoenum.hpp>
55 * Diameter RFC3588 Avp Data Format definition
59 None = -1, // Initialized
62 Unknown, // Unregistered at diameter dictionary
63 Any, // used on generic AVP
65 OctetString, // S8* n (possible zero-padding)
73 Address, // S8* 4 (IPv4) or 16 (IPv6)
75 UTF8String, // S8* n (possible zero-padding)
76 DiameterIdentity, // S8* n (possible zero-padding)
77 DiameterURI, // S8* n (possible zero-padding)
79 IPFilterRule, // S8* n (possible zero-padding)
80 QoSFilterRule // S8* n (possible zero-padding)
83 anna_declare_enum(diameter::codec::Format);
88 * @param v Format type
90 * @return Format description
92 static const char* asText(const Format::_v v) throw(anna::RuntimeException) {
98 * Boolean about if format type is reserved (API internal use)
100 * @param formatName Format text name
102 * @return Boolean 'true' if reserved for internal use, 'false' if is user format type (RFC 3588 or application-specific)
104 static bool isReserved(const std::string & formatName) {
105 if(formatName == asText(Format::Unknown)) return true;
107 if(formatName == asText(Format::Any)) return true;
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)
118 static bool isRFC3588(const std::string & formatName) {
119 if(isReserved(formatName)) return false;
121 return (asEnum(formatName) != None);