1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
17 // * Neither the name of the copyright holder 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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
37 #ifndef anna_timex_Transaction_hpp
38 #define anna_timex_Transaction_hpp
40 #include <anna/core/functions.hpp>
42 #include <anna/timex/TimeEvent.hpp>
43 #include <anna/timex/Meter.hpp>
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.
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.
62 class Transaction : public TimeEvent, public Meter {
67 Transaction() : a_context(NULL) {;}
71 \param id Identificador de este evento.
72 \param timeout La duracion de este evento indicada en milisegundos.
74 Transaction(const Id id, const Millisecond & timeout) :
75 TimeEvent(id, timeout),
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.
85 Transaction(const Id id, const Millisecond & timeout, void* context) :
86 TimeEvent(id, timeout),
91 Devuelve el contexto asociado a esta transaccion.
92 \return El contexto asociado a esta transaccion.
94 void* getContext() throw() { return a_context; }
97 Devuelve el contexto asociado a esta transaccion.
98 \return El contexto asociado a esta transaccion.
100 const void* getContext() const throw() { return a_context; }
103 Establece el contexto asociado a esta transaccion.
104 \param context Contexto asociado a esta transaccion.
106 void setContext(void* context) throw() { a_context = context; }
109 Devuelve una cadena con la informacion referente a este temporizador.
110 \return Una cadena con la informacion referenta a este temporizador.
112 virtual std::string asString() const
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));
124 Transaction(const Transaction&);