include/anna/diameter/codec/basetypes/Time.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_basetypes_Time_hpp
  38 #define anna_diameter_codec_basetypes_Time_hpp
  39
  40
  41 // Local
  42 #include <anna/diameter/codec/basetypes/OctetString.hpp>
  43
  44 #include <anna/config/defines.hpp>
  45 //#include <anna.time.Date.h> // TIMESTAMP_OFFSET_NTP1900_OVER_UNIX1970
  46
  47
  48 namespace anna {
  49
  50 namespace diameter {
  51
  52 namespace codec {
  53
  54 class Avp;
  55
  56 namespace basetypes {
  57
  58 /**
  59 * Diameter Time container (NTP timestamp)
  60 */
  61 class Time : OctetString {
  62
  63   U32 a_ntpTimestamp; // NTP
  64
  65
  66   // Only for derived diameter type:
  67   void updateBasic() throw(anna::RuntimeException);
  68   void setPrintableString(const char * printableString) throw(anna::RuntimeException);
  69
  70
  71 public:
  72
  73
  74   // Class-specific ////////////////////////////////////////////////////////////////////////////////////
  75   //
  76   /**
  77   * Type of timestamps (NTP since 0h on 1 January 1900 UTC, UNIX since 0h on 1 January 1970 UTC)
  78   */
  79   struct Timestamp {
  80     enum _v {
  81       NTP = 0,
  82       UNIX = 1
  83     };
  84
  85     /**
  86     * Timestamp type description
  87     * @param v Timestamp type
  88     * @return Timestamp description
  89     */
  90     static const char* asText(const Timestamp::_v v) throw() { // anna_declare_enum is not safe, because labels don't have to match a sequence
  91       if(v == Timestamp::NTP) return "NTP";
  92       else if(v == Timestamp::UNIX) return "UNIX";
  93
  94       return NULL;
  95     }
  96   };
  97
  98   /**
  99   * Gets the timestamp value
 100   *
 101   * @param timestampType Timestamp reference (NTP/Unix)
 102   *
 103   * @return timestamp value
 104   */
 105   U32 getTimestamp(Timestamp::_v timestampType = Timestamp::NTP) const throw();
 106
 107   /**
 108   * Sets the timestamp value
 109   *
 110   * @param timestamp timestamp value
 111   * @param timestampType Timestamp reference (NTP/Unix)
 112   */
 113   void setTimestamp(const U32& timestamp, Timestamp::_v timestampType = Timestamp::NTP) throw();
 114   //
 115   //////////////////////////////////////////////////////////////////////////////////////////////////////
 116
 117   // gets
 118
 119   std::string getFormatName() const throw() { return "Time"; }
 120
 121
 122   // helpers
 123
 124   std::string asPrintableString() throw(anna::RuntimeException) {
 125     return anna::functions::asString(a_ntpTimestamp);
 126   }
 127
 128   std::string asString() throw(anna::RuntimeException);
 129
 130
 131   // sets
 132
 133   void decode(const char* buffer, const int size) throw(anna::RuntimeException);
 134
 135
 136   // exports /////////////////////////////
 137   using AvpData::getSize;
 138   using AvpData::code;
 139   //using OctetString::asPrintableString;
 140   using AvpData::asDataBlockString;
 141   //using OctetString::asString;
 142   using AvpData::asHexString;
 143   //using OctetString::decode;
 144   using AvpData::fromPrintableString;
 145   using AvpData::fromHexString;
 146 };
 147
 148 }
 149 }
 150 }
 151 }
 152
 153 #endif
 154