include/anna/core/oam/CounterRecorder.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_core_oam_CounterRecorder_hpp
  38 #define anna_core_oam_CounterRecorder_hpp
  39
  40 #include <string>
  41
  42 #include <anna/core/RuntimeException.hpp>
  43
  44 namespace anna {
  45
  46 namespace oam {
  47
  48 class Counter;
  49
  50 /**
  51    Interfaz que deben implementar los objetos encargados de transferir los contadores de una
  52    aplicacion a un medio fisico.
  53
  54    Esta clase se invocara automaticamente al invocar al metodo record() de un modulo oam.
  55 */
  56 class CounterRecorder {
  57 public:
  58   /**
  59      Inicia el proceso de grabacion.
  60   */
  61   virtual void open() throw(RuntimeException) = 0;
  62
  63   /**
  64      Transfiere el contador recibido como parametro al medio fisico. Solo nos llegaran los
  65      contadores modificados desde la ultima vez que se ejecuto el proceso de grabacion.
  66      \param counter Contador que debemos transferir al medio fisico.
  67   */
  68   virtual void apply(const Counter& counter) throw(RuntimeException) = 0;
  69
  70   /**
  71      Termina el proceso de grabacion.
  72   */
  73   virtual void close() throw() = 0;
  74
  75   /**
  76      Devuelve una cadena con la informacion relevante de este objeto.
  77      \return Una cadena con la informacion relevante de este objeto.
  78   */
  79   virtual std::string asString() const throw() = 0;
  80 };
  81
  82 }
  83 }
  84
  85 #endif
  86