CLeakBucket Class Reference

Classe para implementar a estrutura de dados usada pelo Leak Bucket. More...

#include <StreamControl.h>

Inherits CFragmentQueue.

Inherited by CClientInfo, and CSendData.

Public Member Functions
	CLeakBucket (unsigned int MaxCredits, unsigned long long int TimeBetweenCredits)
	CLeakBucket construtor da classe, chamado quando um novo objeto e criado com o comando new.
virtual	~CLeakBucket ()
	~CLeakBucket destrutor da classe, chamado quando um objeto e removido com o comando delete.
virtual bool	VerifyCredits ()
	VerifyCredits verifica se um objeto da classe possui creditos.
virtual FragmentInfo *	Remove ()
	Remove remove um dos elementos do inicio da fila FIFO de um objeto da classe, se a fila nao estiver vazia e se este objeto possuir creditos.
virtual void	UpdateCredits ()
	UpdateCredits atualiza, se necessario, o numero de creditos de um objeto da classe.
virtual unsigned long long int	NextTimeToUpdateCredits ()
	NextTimeToUpdateCredits retorna o tempo, em microsegundos, da proxima atualizacao do credito.
Protected Member Functions
unsigned int	GetCredits ()
	GetCredits retorna o numero de creditos de um objeto da classe.
unsigned int	GetMaxCredits ()
	GetMaxCredits retorna o numero maximo de creditos de um objeto da classe.
virtual void	AddCredits (unsigned int Value)
	AddCredits adiciona creditos ao numero de creditos de um objeto da classe.
virtual void	DecCredits ()
	DecCredits decrementa o numero de creditos de um objeto da classe em 1 unidade.
Private Member Functions
void	SetMaxCredits (unsigned int Value)
	SetMaxCredits altera o numero maximo de creditos a serem contabilizados por um objeto da classe.
void	SetTimeBetweenCredits (unsigned long long int Value)
	SetTimeBetweenCredits altera o tempo (em microsegundos) entre duas atualizacoes do credito de um objeto da classe.
Private Attributes
unsigned int	m_MaxCredits
	Numero maximo de creditos.
unsigned int	m_Credits
	Numero de creditos atual.
unsigned long long int	m_LastUpdateCredits
	Tempo da ultima atualizacao dos creditos (em microsegundos).
unsigned long long int	m_TimeBetweenCredits
	Tempo que deve ser passado entre as atualizacoes (em microsegundos).

---

Detailed Description

Classe para implementar a estrutura de dados usada pelo Leak Bucket.

Esta estrutura sera uma fila FIFO. Logo, a funcao de insercao colocara um objeto no final da lista e a funcao de remocao retirara o objeto do inicio da fila. A classe tambem ira implementar um mutex para acessar a classe, pois as funcoes Insert e Remove serao usadas por threads diferentes, assim como as funcoes que gerenciam os creditos (AddCredits, MaxCredits, AvaliableCredits e VerifyCredits).

Definition at line 154 of file StreamControl.h.

---

Constructor & Destructor Documentation

CLeakBucket::CLeakBucket	(	unsigned int	MaxCredits,
		unsigned long long int	TimeBetweenCredits
	)

CLeakBucket construtor da classe, chamado quando um novo objeto e criado com o comando new.

Parameters:

	MaxCredits	valor inteiro (nao sinalizado), definindo o numero maximo de creditos a serem contabilizados pelo objeto criado.
	TimeBetweenCredits	tempo em microsegundos entre duas atualizacoes do credito do objeto.

Definition at line 277 of file StreamControl.cpp.

{
    struct timeval CreateTime;

    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - Construtor] Start" << endl;
    #endif

    // Inicializa as variaveis da classe.
    SetMaxCredits( MaxCredits );
    SetTimeBetweenCredits( TimeBetweenCredits );
    m_Credits = 1; //MaxCredits;
    gettimeofday( &CreateTime, NULL );
    m_LastUpdateCredits = ( ( unsigned long long int ) CreateTime.tv_sec ) 
                          * 1000000ull + 
                          ( ( unsigned long long int ) CreateTime.tv_usec );
    #ifdef RIO_DEBUG2
    PrintLeakBucketInfo( "Construtor da classe" );
    #endif

    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - Construtor] Finish" << endl;
    #endif
} 

CLeakBucket::~CLeakBucket

(

)

[virtual]

~CLeakBucket destrutor da classe, chamado quando um objeto e removido com o comando delete.

Definition at line 304 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - Destrutor] Single" << endl;
    #endif
}

---

Member Function Documentation

void CLeakBucket::AddCredits

(

unsigned int

Value

)

[protected, virtual]

AddCredits adiciona creditos ao numero de creditos de um objeto da classe.

Parameters:

Value

numero de creditos a serem adicionados ao credito do objeto.

Definition at line 378 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - AddCredits] Start" << endl;
    #endif

    if( m_Credits < m_MaxCredits )
    {
        // Soma Value a m_Credits.
        m_Credits = m_Credits + Value;
        // Garante que o valor de m_Credits nao e maior do que m_MaxCredits.
        if( m_Credits > m_MaxCredits )
            m_Credits = m_MaxCredits;
        #ifdef RIO_DEBUG2
        // Imprime as informacoes do LeakBucket, apos a atualizacao.
        PrintLeakBucketInfo( "Ao adicionar creditos" );
        #endif
    } 

    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - AddCredits] Finish" << endl;
    #endif
}

void CLeakBucket::DecCredits

(

)

[protected, virtual]

DecCredits decrementa o numero de creditos de um objeto da classe em 1 unidade.

Reimplemented in CSendData.

Definition at line 403 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - DecCredits] Start" << endl;
    #endif

    // Subtrai um credito de m_Credits  
    if( m_Credits > 0 )
    {
        m_Credits = m_Credits - 1;
        #ifdef RIO_DEBUG2
        // Imprime as informacoes do LeakBucket, apos a atualizacao.
        PrintLeakBucketInfo( "Ao decrementar creditos" );
        #endif
    }    

    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - DecCredits] Finish" << endl;
    #endif
}

unsigned int CLeakBucket::GetCredits

(

)

[protected]

GetCredits retorna o numero de creditos de um objeto da classe.

Returns:

numero de creditos do objeto.

Definition at line 358 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - GetCredits] Single" << endl;
    #endif

    return m_Credits;
} 

unsigned int CLeakBucket::GetMaxCredits

(

)

[protected]

GetMaxCredits retorna o numero maximo de creditos de um objeto da classe.

Returns:

numero maximo de creditos do objeto.

Definition at line 368 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - GetMaxCredits] Single" << endl;
    #endif

    return m_MaxCredits;
} 

unsigned long long int CLeakBucket::NextTimeToUpdateCredits

(

)

[virtual]

NextTimeToUpdateCredits retorna o tempo, em microsegundos, da proxima atualizacao do credito.

Este tempo e o mesmo dado pela funcao gettimeofday da biblioteca C do Linux, isto e, o numero de segundos decorridos desde 0 horas 0 minutos e 0 segundos de 1 de janeiro de 1970 (isso e chamado de "Epoch" no Linux, e e formalmente definido como "00:00:00 UTC, January 1, 1970").

Returns:

tempo da proxima atualizacao do credito.

Definition at line 518 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - NextTimeToUpdateCredits] Single" << endl;
    #endif

    return m_LastUpdateCredits + m_TimeBetweenCredits;
}

FragmentInfo * CLeakBucket::Remove

(

void

)

[virtual]

Remove remove um dos elementos do inicio da fila FIFO de um objeto da classe, se a fila nao estiver vazia e se este objeto possuir creditos.

Depois da remocao do elemento do inicio da fila, o numero de creditos do objeto sera decrementado em 1 unidade.

Returns:

ponteiro para o elemento do inicio da fila que foi removido, se o objeto possuir creditos e a fila nao estiver vazia, ou NULL em caso contrario (isto e, se a fila estiver vazia ou se o objeto nao possuir creditos).

Reimplemented from CFragmentQueue.

Reimplemented in CSendData, and CClientInfo.

Definition at line 438 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - Remove] Start" << endl;
    #endif

    if( ( !IsEmpty() ) && ( VerifyCredits() ) )
    {
        // Se existe um objeto FragmentInfo no LeakBucket e o cliente possuir
        // mais de um credito para envia-lo.
        DecCredits();

        #ifdef RIO_DEBUG1
        RioErr << "[CLeakBucket - Remove] Finish1" << endl;
        #endif

        // Remove o fragmento da fila FIFO, usando a funcao da classe pai.
        return CFragmentQueue::Remove();
    }
    else 
    {

        #ifdef RIO_DEBUG1
        RioErr << "[CLeakBucket - Remove] Finish2" << endl;
        #endif

        // Se nao existirem objetos FragmentInfo no LeakBucket ou se o cliente
        // nao possuir creditos.
        return NULL;
    }
}

void CLeakBucket::SetMaxCredits

(

unsigned int

Value

)

[private]

SetMaxCredits altera o numero maximo de creditos a serem contabilizados por um objeto da classe.

Parameters:

Value

novo valor para o numero maximo de creditos.

Definition at line 312 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - SetMaxCredits] Start" << endl;
    #endif

    // Altera o valor m_MaxCredits, com o numero maximo de creditos.
    m_MaxCredits = Value;
    // Garante que o valor de m_Credits nao e maior do que m_MaxCredits.
    if( m_Credits > m_MaxCredits )
        m_Credits = m_MaxCredits;

    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - SetMaxCredits] Finish" << endl;
    #endif
}

void CLeakBucket::SetTimeBetweenCredits

(

unsigned long long int

Value

)

[private]

SetTimeBetweenCredits altera o tempo (em microsegundos) entre duas atualizacoes do credito de um objeto da classe.

Parameters:

Value

novo tempo entre as duas atualizacoes de credito.

Definition at line 330 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - SetTimeBetweenCredits] Single" << endl;
    #endif

    // Altera o valor m_TimeBetweenCredits, com o numero maximo de creditos.
    m_TimeBetweenCredits = Value;
}

void CLeakBucket::UpdateCredits

(

)

[virtual]

UpdateCredits atualiza, se necessario, o numero de creditos de um objeto da classe.

Se o tempo entre as atualizacoes nao passou, o credito nao sera atualizado, e se mais tempo passou, o numero de creditos sera aumentado de acordo (por exemplo, se decorreu um tempo tres vezes maior do que o da atualizacao, o credito sera aumentado em 3 unidades).

Reimplemented in CSendData, and CClientInfo.

Definition at line 475 of file StreamControl.cpp.

{
    struct timeval tvUpdateTime;
    unsigned long long int UpdateTime, IntervalTime, Credits, RestTime;

    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - UpdateCredits] Start" << endl;
    #endif

    // Obtem o tempo em que a funcao UpdateCredits foi executada. 
    gettimeofday( &tvUpdateTime, NULL );
    // Converte o tempo para microsegundos.
    UpdateTime = ( ( unsigned long long int ) tvUpdateTime.tv_sec ) 
                 * 1000000ull + 
                 ( ( unsigned long long int ) tvUpdateTime.tv_usec );
    // Calcula o intervalo de tempo entre esta chamada e a anterior.
    IntervalTime = UpdateTime - m_LastUpdateCredits;
    // Verifica se devemos atualizar o numero de creditos.
    if( IntervalTime >= m_TimeBetweenCredits ) {
        // Como o intervalo entre as chamadas e maior ou igual ao valor de
        // m_TimeBetweenCredits, deveremos atualizar o credito de acordo com
        // o tempo passado, e ajustar a variavel m_LastUpdateCredits de
        // acordo.
        Credits = IntervalTime / m_TimeBetweenCredits;
        RestTime = IntervalTime % m_TimeBetweenCredits;
        #ifdef RIO_DEBUG2
        RioErr << "CLeakBucket::UpdateCredits Intervalo = " << IntervalTime 
               << ", m_TimeBetweenCredits = " << m_TimeBetweenCredits 
               << ", Credits = " << Credits << ", UpdateTime = " 
               << UpdateTime << ", RestTime = " << RestTime 
               << ", m_LastUpdateCredits = " << m_LastUpdateCredits << endl; 
        #endif
        AddCredits( Credits );
        m_LastUpdateCredits = UpdateTime - RestTime;
    }

    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - UpdateCredits] Finish" << endl;
    #endif
}

bool CLeakBucket::VerifyCredits

(

)

[virtual]

VerifyCredits verifica se um objeto da classe possui creditos.

Returns:

true se o objeto possuir creditos, ou false em caso contrario.

Definition at line 425 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CLeakBucket - VerifyCredits] Single" << endl;
    #endif

    return  m_Credits > 0;
}

---

Field Documentation

unsigned int CLeakBucket::m_Credits [private]

Numero de creditos atual.

Definition at line 160 of file StreamControl.h.

unsigned long long int CLeakBucket::m_LastUpdateCredits [private]

Tempo da ultima atualizacao dos creditos (em microsegundos).

Definition at line 162 of file StreamControl.h.

unsigned int CLeakBucket::m_MaxCredits [private]

Numero maximo de creditos.

Definition at line 158 of file StreamControl.h.

unsigned long long int CLeakBucket::m_TimeBetweenCredits [private]

Tempo que deve ser passado entre as atualizacoes (em microsegundos).

Definition at line 166 of file StreamControl.h.

---

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

• StreamControl.h
• StreamControl.cpp