include/anna/comm/IndexedDelivery.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_comm_IndexedDelivery_hpp
  38 #define anna_comm_IndexedDelivery_hpp
  39
  40 #include <anna/comm/Service.hpp>
  41
  42 namespace anna {
  43
  44 namespace comm {
  45 class Resource;
  46 }
  47
  48 namespace comm {
  49
  50 /**
  51    Servicio de reparto de peticiones. Selecciona el destino de la proxima peticion en base una clave numerica de forma
  52    que el recurso usado sera el que ocupe la posicicion i-esima. Donde i = key % N, donde key es la clave recibida
  53    y N es el numero total de recursos definidos en este reparto.
  54 */
  55 class IndexedDelivery : public comm::Service {
  56 public:
  57   /**
  58      Define las formas de actuar de comm::IndexedDelivery en caso de error.
  59   */
  60   struct Mode {
  61     enum _v {
  62       Strict, /**< Si el servicio seleccionado no esta disponible aborta el envio del mensaje */
  63       Flexible /**< Si el servicio seleccionado no esta disponible pasa al siguiente disponible */
  64     };
  65   };
  66
  67   /**
  68      Constructor.
  69      \param name Nombre logico del servicio de reparto de carga.
  70      \param isCritical Indica las caracteristicas del reparto de carga. Debe valor \em true si el
  71      reparto de carga a crear es critico o \em false en otro caso.
  72      \param mode Modo de actuar en caso de que el recurso seleccionado no este disponible.
  73   */
  74   IndexedDelivery(const char* name, const bool isCritical, const Mode::_v mode) :
  75     comm::Service(name, isCritical),
  76     a_mode(mode),
  77     a_iikey(0)
  78   {;}
  79
  80   /**
  81      Establece la clave que se usara para decidir el comm::Server al que se va a enviar el mensaje.
  82      \param key Clave usada para calcular el servidor destino.
  83      \warning Este metodo debe invocarse siempre antes de enviar un mensaje.
  84   */
  85   void prepare(const int key) throw(RuntimeException);
  86
  87   std::string asString() const throw();
  88
  89   xml::Node* asXML(xml::Node* parent) const throw();
  90
  91   /**
  92      Metodo que devuelve el nombre completo de este selector de recursos.
  93      Para evitar ambiguedades este nombre incluye la lista completa de \em namespaces
  94      a los que pertenece la clase.
  95      \return Una cadena con el nombre de este selector.
  96   */
  97   static const char* className() throw() { return "anna::comm::IndexedDelivery"; }
  98
  99 private:
 100   //------------------------------------------------------------------------------------
 101   // - a_iiserver: iterador que apunta al servidor que debemos usar.
 102   //------------------------------------------------------------------------------------
 103   const Mode::_v a_mode;
 104   iterator a_iikey;
 105
 106   virtual void do_initialize() throw(RuntimeException) {;}
 107   comm::Resource* do_apply() throw(RuntimeException);
 108 };
 109
 110 }
 111 }
 112
 113 #endif
 114