include/anna/diameter/codec/basetypes/OctetString.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_basetypes_OctetString_hpp
  38 #define anna_diameter_codec_basetypes_OctetString_hpp
  39
  40
  41 // Local
  42 #include <anna/diameter/codec/basetypes/AvpData.hpp>
  43
  44
  45 namespace anna {
  46
  47 namespace diameter {
  48
  49 namespace codec {
  50
  51 class Avp;
  52
  53 namespace basetypes {
  54
  55 /**
  56 * Diameter OctetString container
  57 */
  58 class OctetString : public AvpData {
  59
  60   std::string a_value;
  61
  62
  63   // Mandatory for basic diameter type:
  64   void codeBasic(char* buffer, int &size) throw(anna::RuntimeException);
  65   void setPrintableString(const char * printableString) throw(anna::RuntimeException);
  66
  67 protected:
  68
  69   void assertPrintable() const throw(anna::RuntimeException);
  70
  71 public:
  72
  73
  74   // Class-specific ////////////////////////////////////////////////////////////////////////////////////
  75   //
  76   /**
  77   * Gets the OctetString value
  78   *
  79   * @return OctetString value
  80   */
  81   const std::string& getValue() const throw() { return a_value; }
  82
  83   /**
  84   * Sets the OctetString value
  85   *
  86   * @param value OctetString value
  87   */
  88   void setValue(const std::string& value) throw() { a_value = value; }
  89   //
  90   //////////////////////////////////////////////////////////////////////////////////////////////////////
  91
  92
  93   // gets
  94   // virtual for Unknown format container
  95   virtual std::string getFormatName() const throw() { return "OctetString"; }
  96   virtual int getSize() const throw() { return a_value.size(); }
  97
  98
  99   // helpers
 100
 101   // sets
 102
 103   void decode(const char* buffer, const int size) throw(anna::RuntimeException);
 104 };
 105
 106 }
 107 }
 108 }
 109 }
 110
 111 #endif