include/anna/diameter/codec/tme/Avp.hpp

   1 // ANNA - Anna is Not Nothingness 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_tme_Avp_hpp
  38 #define anna_diameter_codec_tme_Avp_hpp
  39
  40 // Local
  41 #include <anna/diameter/codec/Avp.hpp>
  42 #include <anna/diameter/helpers/tme/codectypes/codectypes.hpp>
  43
  44 //------------------------------------------------------------------------------
  45 //---------------------------------------------------------------------- #define
  46 //------------------------------------------------------------------------------
  47
  48 namespace anna {
  49 namespace xml {
  50 class Attribute;
  51 }
  52 }
  53
  54
  55
  56 namespace anna {
  57
  58 namespace diameter {
  59
  60 namespace helpers {
  61 namespace tme {
  62 namespace codectypes {
  63 class Unsigned16;
  64 class ISDNNumber;
  65 class ISDNAddress;
  66 }
  67 }
  68 }
  69
  70 namespace codec {
  71
  72 namespace tme {
  73
  74 class Avp;
  75 class Message;
  76 class Engine;
  77
  78
  79 using namespace helpers::tme::codectypes;
  80
  81 /**
  82 * Diameter TME avp generic container
  83 * Manages tme-specific formats (Unsigned16, ISDNAddress, ISDNNumber)
  84 */
  85 class Avp : public anna::diameter::codec::Avp {
  86
  87   // Data containers
  88   ISDNNumber *a_ISDNNumber;
  89   ISDNAddress *a_ISDNAddress;
  90   Unsigned16 *a_Unsigned16;
  91
  92   virtual void initializeByFormat() throw();
  93   virtual U24 getLengthByFormat(const anna::diameter::stack::Format *stackFormat) const throw();
  94   virtual std::string getXMLdataByFormat(bool & isHex, const anna::diameter::stack::Format *stackFormat) const throw();
  95   virtual void fromXMLByFormat(const anna::xml::Attribute* data, const anna::xml::Attribute* hexData, const anna::diameter::stack::Format *stackFormat) throw(anna::RuntimeException);
  96   virtual void codeByFormat(char* dataPart, const anna::diameter::stack::Format *stackFormat) const throw(anna::RuntimeException);
  97   virtual void decodeDataPartByFormat(const char * buffer, int size, const anna::diameter::stack::Format *stackFormat) throw(anna::RuntimeException);
  98   virtual void allocationByFormat(const anna::diameter::stack::Format *stackFormat) throw();
  99   virtual void clearByFormat() throw();
 100
 101 protected:
 102
 103   /** Codec Engine getter: avoids have to create base engine when using its child */
 104   virtual anna::diameter::codec::Engine * getEngine() const throw(anna::RuntimeException);
 105
 106
 107 public:
 108
 109   /**
 110   * Default constructor
 111   */
 112   Avp();
 113
 114   /**
 115   * Identified constructor
 116   * @param id Avp identifier as pair (code,vendorID).
 117   */
 118   Avp(AvpId id);
 119
 120   /**
 121   * Destructor
 122   */
 123   ~Avp();
 124
 125
 126   /** Access content for ISDNNumber Avp in order to set data part */
 127   ISDNNumber *        getISDNNumber() throw(anna::RuntimeException) { assertFormat("ISDNNumber"); return a_ISDNNumber; }
 128   /** Access content for ISDNAddress Avp in order to set data part */
 129   ISDNAddress *        getISDNAddress() throw(anna::RuntimeException) { assertFormat("ISDNAddress"); return a_ISDNAddress; }
 130   /** Access content for Unsigned16 Avp in order to set data part */
 131   Unsigned16 *        getUnsigned16() throw(anna::RuntimeException) { assertFormat("Unsigned16"); return a_Unsigned16; }
 132
 133
 134   /** Access content for ISDNNumber Avp */
 135   const ISDNNumber *         getISDNNumber() const throw(anna::RuntimeException) { assertFormat("ISDNNumber"); return a_ISDNNumber; }
 136   /** Access content for ISDNAddress Avp */
 137   const ISDNAddress *        getISDNAddress() const throw(anna::RuntimeException) { assertFormat("ISDNAddress"); return a_ISDNAddress; }
 138   /** Access content for Unsigned16 Avp */
 139   const Unsigned16 *        getUnsigned16() const throw(anna::RuntimeException) { assertFormat("Unsigned16"); return a_Unsigned16; }
 140
 141
 142
 143
 144   friend class Message;
 145   friend class Engine;
 146 };
 147
 148 }
 149 }
 150 }
 151 }
 152
 153
 154 #endif