anna::Resource Class Reference

#include <Resource.hpp>

Inheritance diagram for anna::Resource:

Collaboration diagram for anna::Resource:

Public Member Functions
	Resource (const std::string &name)
const std::string &	getName () const
bool	isEnabled () const
void	setTimeStamp (const Millisecond &timeStamp)
const Millisecond &	getTimeStamp () const
bool	operator== (const std::string &name) const
bool	operator== (const Resource &other) const
void	enable () noexcept(false)
void	disable () noexcept(false)
virtual std::string	asString () const
virtual bool	isAvailable () const noexcept(false)=0
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

Additional Inherited Members
Protected Member Functions inherited from anna::Safe
	Safe ()

Detailed Description

Clase que modela un recurso de acceso compartido.

Constructor & Destructor Documentation

Resource()

anna::Resource::Resource ( const std::string &  name )

inline

Constructor.

Parameters

name	Nombre logico de este recurso remoto.
mode	Modo de actuacion de esta instancia en modo ST cuando montamos una seccion critca sobre este objeto. En modo MT siempre sera Mode::Normal, es decir abre una seccion critica sobre este objeto, que bloqueara a cualquier otro thread que intente acceder a el.

                                  :
    Mutex(),
    a_name(name),
    a_isEnabled(true),
    a_timeStamp(0)
  {;}

Member Function Documentation

asString()

virtual std::string anna::Resource::asString ( ) const

virtual

Devuelve una cadena con la informacin referente a este recurso remoto.

Returns

Una cadena con la informacin referente a este recurso remoto.

Reimplemented in anna::comm::Server, anna::dbms::Connection, anna::dbms::oracle::Connection, and anna::dbms::mysql::Connection.

disable()

void anna::Resource::disable ( )

inlinenoexcept

Evita el uso de este recurso.

Warning

La invocacion a este metodo deberia hacerse en modo exclusivo.

{ Guard guard(this, "Resource"); a_isEnabled = false;  }

enable()

void anna::Resource::enable ( )

inlinenoexcept

Habilita el uso de este recurso. Si no se indica lo contrario un recurso remoto siempre se encuentra habilitado, pero no tiene por que estar disponible.

Warning

La invocacion a este metodo deberia hacerse en modo exclusivo.

{ Guard guard(this, "Resource"); a_isEnabled = true;   }

getName()

const std::string& anna::Resource::getName ( ) const

inline

Devuelve el nombre logico de este recurso remoto.

Returns

El nombre logico de este recurso remoto.

{ return a_name; }

getTimeStamp()

const Millisecond& anna::Resource::getTimeStamp ( ) const

inline

{ return a_timeStamp; }

isAvailable()

virtual bool anna::Resource::isAvailable ( ) const

pure virtualnoexcept

Devuelve el estado de disponibilidad de este recurso.

El recurso no esta preparado para ser usado debido a causas internas.

Para que un recurso pueda ser usado tanto este metodo como isEnabled deberan retornar true.

Returns

false si el recurso no esta preparado para ser usado debido a causas internas o true en otro caso.

Implemented in anna::comm::Server.

isEnabled()

bool anna::Resource::isEnabled ( ) const

inline

Devuelve el estado referente a la habilitacion de este recurso.

La habilitacion o inhabilitacion responde a causas externas a este recurso, es decir, puede ser que el recurso estaria preparado pero por algun motivo deseamos marcarlo como "no usable".

Para que un recurso pueda ser usado tanto este metodo como isAvailable deberan retornar true.

Returns

true Si el recurso esta habilitado o false en otro caso.

{ return a_isEnabled; }

operator==() [1/2]

bool anna::Resource::operator== ( const std::string &  name ) const

inline

Operador de comparacion.

Parameters

name	Nombre con el que comparar.

Returns

Devuelve true si el nombre recibido como parametro coincide con el indicado en el constructor de esta instancia o false en caso contrario.

{ return a_name == name; }

operator==() [2/2]

bool anna::Resource::operator== ( const Resource &  other ) const

inline

Operador de comparacion.

Parameters

other

Instancia con la que comparar.

Returns

Devuelve true si el nombre recibido como parametro coincide con el indicado en el constructor de esta instancia o false en caso contrario.

{ return a_name == other.a_name; }

setTimeStamp()

void anna::Resource::setTimeStamp ( const Millisecond &  timeStamp )

inline

Obtiene el valor de la marca de tiempo asociada a este recurso. Se usa desde las clases de reparto de carga, para marca el momento en que ha sido desactivado el recurso, lo permite volver a comprobar el recurso cada cierto periodo de tiempo.

Parameters

timeStamp

Marca de tiempo asociada al recurso.

{ a_timeStamp = timeStamp; }

---

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

• /tmp/anna/include/anna/core/mt/Resource.hpp