include/anna/timex/Transaction.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_timex_Transaction_hpp
  38 #define anna_timex_Transaction_hpp
  39
  40 #include <anna/core/functions.hpp>
  41
  42 #include <anna/timex/TimeEvent.hpp>
  43 #include <anna/timex/Meter.hpp>
  44
  45 namespace anna {
  46
  47 namespace timex {
  48
  49 /**
  50    Clase base para las transacciones. Se activa una unica vez y cuando transcurren los milisegundos
  51    establecidos por TimeEvent::getTimeout se invoca al metodo #expire. La implementacion de este metodo
  52    sera particular para cada uno de las transacciones.
  53
  54    Incorpora capacidades que facilitan evaluar la duración media de cada
  55    transacción, que son usadas directamente desde anna::timex::Context, aunque podrían ser usadas
  56    por cualquier otro código.
  57
  58    @see Clock
  59    @see Timer
  60    \see Context
  61 */
  62 class Transaction : public TimeEvent, public Meter {
  63 public:
  64   /**
  65      Constructor.
  66   */
  67   Transaction() : a_context(NULL) {;}
  68
  69   /**
  70      Contructor.
  71      \param id Identificador de este evento.
  72      \param timeout La duracion de este evento indicada en milisegundos.
  73   */
  74   Transaction(const Id id, const Millisecond & timeout) :
  75     TimeEvent(id, timeout),
  76     a_context(NULL)
  77   {;}
  78
  79   /**
  80      Contructor.
  81      \param id Identificador de este evento.
  82      \param timeout La duracion de este evento indicada en milisegundos.
  83      \param context Contexto asociado a esta transaccion.
  84   */
  85   Transaction(const Id id, const Millisecond & timeout, void* context) :
  86     TimeEvent(id, timeout),
  87     a_context(context)
  88   {;}
  89
  90   /**
  91      Devuelve el contexto asociado a esta transaccion.
  92      \return El contexto asociado a esta transaccion.
  93   */
  94   void* getContext() throw() { return a_context; }
  95
  96   /**
  97      Devuelve el contexto asociado a esta transaccion.
  98      \return El contexto asociado a esta transaccion.
  99   */
 100   const void* getContext() const throw() { return a_context; }
 101
 102   /**
 103      Establece el contexto asociado a esta transaccion.
 104      \param context Contexto asociado a esta transaccion.
 105   */
 106   void setContext(void* context) throw() { a_context = context; }
 107
 108   /**
 109      Devuelve una cadena con la informacion referente a este temporizador.
 110      \return Una cadena con la informacion referenta a este temporizador.
 111   */
 112   virtual std::string asString() const
 113   throw() {
 114     std::string msg("Transaction { ");
 115     msg += TimeEvent::asString();
 116     msg += " | Contexto: ";
 117     msg += (a_context == NULL) ? "(null)" : functions::asHexString(anna_ptrnumber_cast(a_context));
 118     return msg += " }";
 119   }
 120
 121 private:
 122   void* a_context;
 123
 124   Transaction(const Transaction&);
 125 };
 126
 127 }
 128 }
 129
 130 #endif
 131
 132