anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer > Class Template Reference

#include <ByRangeDelivery.hpp>

Inheritance diagram for anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >:

Collaboration diagram for anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >:

Classes
struct	Range

Public Types
typedef std::vector< Range * >	range_container
typedef range_container::iterator	range_iterator
typedef range_container::const_iterator	const_range_iterator
Public Types inherited from anna::comm::Delivery
typedef std::vector< Resource * >	Resources
typedef Resources::iterator	iterator
typedef Resources::const_iterator	const_iterator

Public Member Functions
	ByRangeDelivery (const char *name, const bool isCritical)
virtual	~ByRangeDelivery ()
range_iterator	createRange (const TKey &bottom, const TKey &top) noexcept(false)
void	attach (range_iterator &ii, Server *server) noexcept(false)
void	prepare (const TKey &key) noexcept(false)
std::string	asString () const
xml::Node *	asXML (xml::Node *parent) const
Public Member Functions inherited from anna::comm::Service
	Service (const char *name, const bool isCritical)
bool	isCritical () const
void	attach (Server *server) noexcept(false)
comm::Server *	send (Message &message) noexcept(false)
comm::Server *	send (Message *message) noexcept(false)
int	broadcast (Message &message)
int	broadcast (Message *message)
std::string	asString () const
xml::Node *	asXML (xml::Node *parent) const
Public Member Functions inherited from anna::comm::Delivery
virtual	~Delivery ()
const std::string &	getName () const
void	initialize () noexcept(false)
bool	wasAvailable () const
const Millisecond &	getRecoveryTime () const
void	setRecoveryTime (const Millisecond &recoveryTime)
virtual bool	isAvailable () const
Resource *	apply () noexcept(false)
bool	fault (const Resource *resource)
bool	recover (const Resource *resource)
bool	contains (const Resource *resource) const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
int	size () const
const_iterator	end () const
Public Member Functions inherited from anna::Mutex
	Mutex (const Mode::_v mode=Mode::Recursive)
virtual	~Mutex ()
virtual void	lock () noexcept(false)
virtual void	unlock ()
bool	trylock () noexcept(false)
	operator const pthread_mutex_t * () const

Static Public Member Functions
static const char *	className ()
Static Public Member Functions inherited from anna::comm::Service
static Server *	server (iterator &ii)
static const Server *	server (const_iterator &ii)
Static Public Member Functions inherited from anna::comm::Delivery
static Resource *	resource (iterator &ii)
static const Resource *	resource (const_iterator &ii)

Protected Member Functions
range_iterator	range_begin ()
range_iterator	range_end ()
const_range_iterator	range_begin () const
const_range_iterator	range_end () const
virtual void	do_initialize () noexcept(false)
Protected Member Functions inherited from anna::comm::Delivery
	Delivery (const char *name)
void	add (Resource *resource) noexcept(false)
virtual bool	do_contains (const Resource *resource) const
Protected Member Functions inherited from anna::Safe
	Safe ()

Static Protected Member Functions
static Range *	range (range_iterator &ii)
static const Range *	range (const_range_iterator &ii)

Additional Inherited Members
Static Public Attributes inherited from anna::comm::Delivery
static const Millisecond	DefaultRecoveryTime

Detailed Description

template<typename TKey, typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>
class anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >

Servicio de reparto de carga permite selecionar el servidor al que enviar la peticion en base al valor de una clave previamente indicada.

A diferencia de los comm::Service habituales la asociacion entre el servicio y el proceso no debe hacerse mediante comm::Service::attach, sino mediante comm::ByRangeDelivery::attach.

Parameters

TKey	Tipo de clave usada para indexar los servicios de reparto.
TDelivery	Tipo de reparto usado en cada rango.
TSerializer	Clase que es capaz de convertir la TKey en una cadena. Debe implementar un metodo asString que recibe una instancia de TKey y devuelva una cadena.

La clase Delivery debe implementar los mismos metodos que un comm::Service.

Member Typedef Documentation

const_range_iterator

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

typedef range_container::const_iterator anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::const_range_iterator

range_container

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

typedef std::vector<Range*> anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::range_container

range_iterator

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

typedef range_container::iterator anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::range_iterator

Constructor & Destructor Documentation

ByRangeDelivery()

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::ByRangeDelivery ( const char *  name, const bool  isCritical  )

inline

Constructor.

Parameters

name	Nombre logico del servicio de reparto de carga.
isCritical	Indica las caracteristicas del reparto de carga. Debe valor true si el reparto de carga a crear es critico o false en otro caso.

                                                           :
    comm::Service(name, isCritical),
    a_currentRange(NULL)
  {;}

~ByRangeDelivery()

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

virtual anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::~ByRangeDelivery ( )

inlinevirtual

Destructor.

                             {
    for(range_iterator ii = range_begin(), maxii = range_end(); ii != maxii; ii ++)
      delete range(ii)->delivery;

    a_ranges.clear();
  }

Member Function Documentation

asString()

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

std::string anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::asString ( ) const

inlinevirtual

Devuelve una cadena con la informacion referente a este objeto.

Returns

Una cadena con la informacion referente a este objeto.

Reimplemented from anna::comm::Delivery.

  {
    std::string result = className();
    result += " { ";
    result += comm::Delivery::asString();
    result += " | Ranges: ";

    for(const_range_iterator ii = range_begin(), maxii = range_end(); ii != maxii; ii ++)  {
      result += "\n\t";
      result += range(ii)->asString();
    }

    return result += "}";
  }

Here is the call graph for this function:

asXML()

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

xml::Node* anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::asXML ( xml::Node *  parent ) const

inlinevirtual

Devuelve un nodo XML con la informacion referente a este objeto.

Parameters

parent

Nodo XML a partir del cual introducir la informacion.

Returns

Un nodo XML con la informacion referente a este objeto.

Reimplemented from anna::comm::Delivery.

  {
    xml::Node* result = parent->createChild("anna.comm.ByRangeDelivery");
    xml::Node* node = comm::Service::asXML(result);

    for(const_range_iterator ii = range_begin(), maxii = range_end(); ii != maxii; ii ++)
      range(ii)->asXML(node);

    return result;
  }

Here is the call graph for this function:

attach()

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

void anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::attach ( range_iterator &  ii, Server *  server  )

inlinenoexcept

Asocia el comm::Server recibido como parametro al rango representado por el iterador recibido.

Parameters

ii	Iterador de rango al que asociar el servicio. Debe ser resultado de invocar a createRange.
server	Instancia del comm::Server a incorporar dentro del rango.

                                                                  {
    range(ii)->delivery->attach(server);
    comm::Service::attach(server);
  }

Here is the call graph for this function:

className()

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

static const char* anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::className ( )

inlinestatic

Metodo que devuelve el nombre completo de este selector de recursos. Para evitar ambigüedades este nombre incluye la lista completa de namespaces a los que pertenece la clase.

Returns

Una cadena con el nombre de este selector.

{ return "anna::comm::ByRangeDelivery"; }

createRange()

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

range_iterator anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::createRange ( const TKey &  bottom, const TKey &  top  )

inlinenoexcept

Instancia un rango de reparto con los parametros definidos como parametros. Una vez que obtengamos el comm::Delivery asociado al rango creado debemos asociar tantos comm::Resource como sea necesario.

Parameters

bottom	Valor minimo del rango.
top	Valor maximo del rango.

Returns

La instancia del servicio de reparto asociado a este rango.

                  {
    Range* result;

    if(bottom > top) {
      std::string msg(asString());
      msg += " | Bottom: ";
      msg += TSerializer::asString(bottom);
      msg += " | Invalid range (bottom > top)";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    if((result = find(bottom)) != NULL) {
      std::string msg(asString());
      msg += " | Bottom: ";
      msg += TSerializer::asString(bottom);
      msg += " | Overlapped with ";
      msg += result->asString();
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    if((result = find(top)) != NULL) {
      std::string msg(asString());
      msg += " | top: ";
      msg += TSerializer::asString(top);
      msg += " | Overlapped with ";
      msg += result->asString();
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    a_ranges.push_back(result = new Range(getName(), bottom, top));
    return range_begin() + a_ranges.size() - 1;
  }

Here is the call graph for this function:

do_initialize()

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

virtual void anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::do_initialize ( )

inlineprotectedvirtualnoexcept

Inicializa el reparto de recursos.

Implements anna::comm::Delivery.

                  {
    for(range_iterator ii = range_begin(), maxii = range_end(); ii != maxii; ii ++)
      range(ii)->delivery->initialize();
  }

prepare()

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

void anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::prepare ( const TKey &  key )

inlinenoexcept

Establece la clave que se usara para decidir que pareja de maquinas usar para enviar el mensaje.

Parameters

key	Clave usada para calcular el reparto.

Warning

Este metodo debe invocarse siempre antes de usar este servicio de reparto.

                                                {
    Range* w = find(key);

    if(w == NULL && Logger::isActive(Logger::Warning)) {
      std::string msg(asString());
      msg += " | TKey: ";
      msg += TSerializer::asString(key);
      msg += " | No range associated";
      Logger::warning(msg, ANNA_FILE_LOCATION);
    } else
      a_currentRange = w;

    if(a_currentRange == NULL) {
      std::string msg(asString());
      msg += " | TKey: ";
      msg += TSerializer::asString(key);
      msg += " | No delivery service associated has been found";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }
  }

Here is the call graph for this function:

range() [1/2]

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

static Range* anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::range ( range_iterator &  ii )

inlinestaticprotected

{ return *ii; }

range() [2/2]

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

static const Range* anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::range ( const_range_iterator &  ii )

inlinestaticprotected

{ return *ii; }

range_begin() [1/2]

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

range_iterator anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::range_begin ( )

inlineprotected

{ return a_ranges.begin(); }

range_begin() [2/2]

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

const_range_iterator anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::range_begin ( ) const

inlineprotected

{ return a_ranges.begin(); }

range_end() [1/2]

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

range_iterator anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::range_end ( )

inlineprotected

{ return a_ranges.end(); }

range_end() [2/2]

template<typename TKey , typename TDelivery = RoundRobinDelivery, typename TSerializer = anna::functions>

const_range_iterator anna::comm::ByRangeDelivery< TKey, TDelivery, TSerializer >::range_end ( ) const

inlineprotected

{ return a_ranges.end(); }

---

The documentation for this class was generated from the following file:

• /tmp/anna/include/anna/comm/ByRangeDelivery.hpp