include/anna/diameter.comm/Timer.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_comm_Timer_hpp
  38 #define anna_diameter_comm_Timer_hpp
  39
  40 #include <anna/core/RuntimeException.hpp>
  41 #include <anna/core/Allocator.hpp>
  42 #include <anna/timex/Transaction.hpp>
  43
  44
  45 namespace anna {
  46
  47 namespace diameter {
  48
  49 namespace comm {
  50
  51
  52 class Session;
  53 class Response;
  54 class LocalServer;
  55 class TimerManager;
  56
  57
  58 class Timer : public anna::timex::Transaction {
  59
  60 public:
  61   struct Type { enum _v { ResponseExpiration, SessionUnbind, SessionRecover, LocalServerAttach }; };
  62
  63   // getters for responses
  64   Response* getResponse() throw() { return reinterpret_cast <Response*>(getContext()); }
  65   const Response* getResponse() const throw() { return reinterpret_cast <const Response*>(getContext()); }
  66
  67   // getters for session (client-session at the moment)
  68   Session* getSession() throw() { return reinterpret_cast <Session*>(getContext()); }
  69   const Session* getSession() const throw() { return reinterpret_cast <const Session*>(getContext()); }
  70
  71   // getters for local server
  72   LocalServer* getLocalServer() throw() { return reinterpret_cast <LocalServer*>(getContext()); }
  73   const LocalServer* getLocalServer() const throw() { return reinterpret_cast <const LocalServer*>(getContext()); }
  74
  75   std::string asString() const throw();
  76
  77 private:
  78   Timer() {;}
  79
  80
  81   Type::_v a_type;
  82
  83   void expire(anna::timex::Engine*) throw(anna::RuntimeException);
  84
  85   Type::_v getType() const throw() { return a_type; }
  86   void setType(const Type::_v type)  throw() { a_type = type; }
  87   static const char* asText(const Type::_v) throw();
  88
  89
  90   friend class TimerManager;
  91   friend class anna::Allocator<Timer>;
  92 };
  93
  94 }
  95 }
  96 }
  97
  98 #endif
  99