include/anna/comm/RoundRobinDelivery.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_RoundRobinDelivery_hpp
  38 #define anna_comm_RoundRobinDelivery_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 carga mediante un algoritmo RoundRobin, es decir, cada uno de los mensajes enviados tiene como
  52    destino uno de los recursos definidos, cuando en el mensaje i-esimo se alcance el final de la lista de recursos
  53    disponibles se vuelve a empezar por el primero.
  54 */
  55 class RoundRobinDelivery : public comm::Service {
  56 public:
  57   /**
  58      Constructor.
  59      \param name Nombre logico del servicio de reparto de carga.
  60      \param isCritical Indica las caracteristicas del reparto de carga. Debe valor \em true si el
  61      reparto de carga a crear es critico o \em false en otro caso.
  62   */
  63   RoundRobinDelivery(const char* name, const bool isCritical) :
  64     comm::Service(name, isCritical),
  65     a_iiserver(0)
  66   {;}
  67
  68   std::string asString() const throw();
  69
  70   xml::Node* asXML(xml::Node* parent) const throw();
  71
  72   /**
  73      Metodo que devuelve el nombre completo de este selector de recursos.
  74      Para evitar ambiguedades este nombre incluye la lista completa de \em namespaces
  75      a los que pertenece la clase.
  76      \return Una cadena con el nombre de este selector.
  77   */
  78   static const char* className() throw() { return "anna::comm::RoundRobinDelivery"; }
  79
  80 protected:
  81   void do_initialize() throw(RuntimeException);
  82
  83 private:
  84   //------------------------------------------------------------------------------------
  85   // - a_iiserver: iterador que apunta al servidor que debemos usar.
  86   //------------------------------------------------------------------------------------
  87   iterator a_iiserver;
  88
  89   comm::Resource* do_apply() throw(RuntimeException);
  90   iterator advance() throw();
  91 };
  92
  93 }
  94 }
  95
  96 #endif
  97