include/anna/diameter/helpers/dcca/functions.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_helpers_dcca_functions_hpp
  38 #define anna_diameter_helpers_dcca_functions_hpp
  39
  40
  41 #include <anna/core/RuntimeException.hpp>
  42
  43 #include <anna/diameter/helpers/dcca/defines.hpp>
  44
  45 // STL
  46 #include <string>
  47
  48 //------------------------------------------------------------------------------
  49 //---------------------------------------------------------------------- #define
  50 //------------------------------------------------------------------------------
  51
  52 namespace anna {
  53 class DataBlock;
  54 }
  55
  56
  57
  58 namespace anna {
  59
  60 namespace diameter {
  61
  62 namespace helpers {
  63
  64 namespace dcca {
  65
  66 /**
  67 * Type of charging context
  68 */
  69 struct ChargingContext { enum _v { Unknown = -1, Data, Voice, Content, SMS, MMS }; };
  70
  71
  72 struct ChargingContextAndDomainSuffix {
  73
  74   /** Charging context and domain suffic for data traffic */
  75   static const char Data[];
  76
  77   /** Charging context and domain suffic for voice traffic */
  78   static const char Voice[];
  79
  80   /** Charging context and domain suffic for content traffic */
  81   static const char Content[];
  82
  83   /** Charging context and domain suffic for SMS traffic */
  84   static const char SMS[];
  85
  86   /** Charging context and domain suffic for MMS traffic */
  87   static const char MMS[];
  88 };
  89
  90
  91 struct functions {
  92
  93   // getters & helpers
  94
  95   /**
  96   * Subscription-Id-Data for provided Subscription-Id-Type within a command.
  97   *
  98   * @param db Provided Message DataBlock
  99   * @param Subscription-Id-Type value to filter the search. END_USER_E164 by default.
 100   *
 101   * @return Subscription-Id-Data for type provided. Empty string when not found.
 102   */
 103   static std::string getSubscriptionIdData(const anna::DataBlock &db,
 104       int subscriptionIdType = AVPVALUES__Subscription_Id_Type::END_USER_E164) throw(anna::RuntimeException);
 105
 106
 107   /**
 108   * Service-Context-Id from datablock provided.
 109   *
 110   * @param db Provided Message DataBlock
 111   * @param chargingContext Detected charging context
 112   *
 113   * @return Service-Context-Id
 114   */
 115   static std::string getServiceContextId(const anna::DataBlock &db, ChargingContext::_v &chargingContext) throw(anna::RuntimeException);
 116
 117   /**
 118   * Service-Context-Id from datablock provided.
 119   *
 120   * @param db Provided Message DataBlock
 121   *
 122   * @return Service-Context-Id
 123   */
 124   static std::string getServiceContextId(const anna::DataBlock &db) throw(anna::RuntimeException) {
 125     ChargingContext::_v dummy;
 126     return getServiceContextId(db, dummy);
 127   }
 128 };
 129
 130
 131 }
 132 }
 133 }
 134 }
 135
 136
 137 #endif
 138