CClientInfo Class Reference

A classe que representa um cliente e que tambem e cada elemento do heap. More...

#include <StreamControl.h>

Inherits CLeakBucket.

Public Member Functions
	CClientInfo (unsigned int MaxCredits, unsigned long long int TimeBetweenCredits, int ip, int port)
	CClientInfo construtor da classe, chamado quando um objeto e criado usando o comando new.
	~CClientInfo ()
	~CClientInfo destrutor da classe, chamado quando um objeto e removido com o comando delete.
int	Insert (FragmentInfo *fip)
	Insert Insere um objeto FragmentInfo no final da fila do objeto associado ao cliente.
FragmentInfo *	Remove ()
	Remove remove um dos elementos do inicio da fila do um objeto associado ao cliente, se a fila nao estiver vazia e se este objeto possuir creditos.
void	UpdateCredits ()
	UpdateCredits atualiza, se necessario, o numero de creditos de um objeto associado ao cliente.
bool	MustRemoveClient ()
	MustRemoveClient verifica se o cliente associado ao objeto deve ser removido porque esta inativo por muito tempo.
int	GetIPAddress ()
	GetIPAddress retorna o endereco IP do cliente associado ao objeto.
int	GetPort ()
	GetPort retorna a porta do cliente associado ao objeto.
Private Attributes
int	IP
	Endereco IP do cliente (na ordem da rede).
int	Port
	Porta IP do cliente (na ordem da rede).
unsigned int	IdleCount
	Contador usado para detectar a inatividade do cliente.
pthread_mutex_t	m_AccessFragmentQueue
	Mutex para garantir o acesso exclusivo a fila do LeakBucket.

---

Detailed Description

A classe que representa um cliente e que tambem e cada elemento do heap.

Para cada um dos clientes sera criado um objeto da classe CClientInfo.

Definition at line 443 of file StreamControl.h.

---

Constructor & Destructor Documentation

CClientInfo::CClientInfo	(	unsigned int	MaxCredits,
		unsigned long long int	TimeBetweenCredits,
		int	ip,
		int	port
	)

CClientInfo construtor da classe, chamado quando um objeto e criado usando o comando new.

Esta classe e derivada da classe CLeakBucket, descrita anteriormente. Cada objeto desta classe sera associado a um cliente com trafego de tempo real conectado ao servidor.

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.
	ip	endereco IP do cliente associado ao objeto da classe que esta sendo criado.
	port	porta do cliente associado ao objeto da classe que esta sendo criado.

Definition at line 904 of file StreamControl.cpp.

          :CLeakBucket( MaxCredits, TimeBetweenCredits )
{
    #ifdef RIO_DEBUG1
    RioErr << "[CClientInfo - Construtor] Start" << endl;
    #endif

    // Inicializa as variaveis da classe.
    IP = ip; // IP do cliente (na ordem da rede).
    Port = port; // Porta do cliente (na ordem da rede).
    IdleCount = MAXIDLECOUNT; // Inicializa o contador de inatividade.
    // Cria o mutex para garantir o acesso exclusivo a fila do LeakBucket.
    pthread_mutex_init( &m_AccessFragmentQueue, NULL );

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

CClientInfo::~CClientInfo

(

)

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

Definition at line 926 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CClientInfo - Destrutor] Start" << endl;
    #endif

    // Remove o mutex para garantir o acesso exclusivo a fila do LeakBucket.
    pthread_mutex_destroy( &m_AccessFragmentQueue );

    #ifdef RIO_DEBUG1
    RioErr << "[CClientInfo - Destrutor] Finish" << endl;
    #endif
}

---

Member Function Documentation

int CClientInfo::GetIPAddress

(

)

GetIPAddress retorna o endereco IP do cliente associado ao objeto.

Returns:

endereco IP do cliente.

Definition at line 1033 of file StreamControl.cpp.

{
    return IP; // Retorna o IP do cliente.
}

int CClientInfo::GetPort

(

)

GetPort retorna a porta do cliente associado ao objeto.

Returns:

porta do cliente.

Definition at line 1039 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CClientInfo - GetPort] Single" << endl;
    #endif

    return Port; // Retorna a porta do cliente.
}

int CClientInfo::Insert

(

FragmentInfo *

fip

)

[virtual]

Insert Insere um objeto FragmentInfo no final da fila do objeto associado ao cliente.

Alem disso, como o cliente passou a ter interacao com o servidor, pois temos fragmentos a serem enviados para ele, resetaremos o contador de usado para detectar que um cliente esta inativo.

Parameters:

fip

ponteiro para o objeto a ser inserido no final da fila.

Returns:

S_OK se o objeto foi corretamente inserido na fila, e valor diferente de S_OK se algum erro ocorreu ao inserir o objeto.

Reimplemented from CFragmentQueue.

Definition at line 943 of file StreamControl.cpp.

{
    int result;

    #ifdef RIO_DEBUG1
    RioErr << "[CClientInfo - Insert] Start" << endl;
    #endif

    // Obtem o acesso ao mutex para garantir o acesso exclusivo a fila do 
    // LeakBucket.
    pthread_mutex_lock( &m_AccessFragmentQueue );
    // Inicializa o contador de inatividade com o valor maximo.
    IdleCount = MAXIDLECOUNT;
    // Chama a funcao da classe pai para inserir o fragmento na fila.
    result = CLeakBucket::Insert( fip );
    // Libera o mutex para garantir o acesso exclusivo a fila do LeakBucket.
    pthread_mutex_unlock( &m_AccessFragmentQueue );

    #ifdef RIO_DEBUG1
    RioErr << "[CClientInfo - Insert] Finish" << endl;
    #endif

    return result;    
}

bool CClientInfo::MustRemoveClient

(

)

MustRemoveClient verifica se o cliente associado ao objeto deve ser removido porque esta inativo por muito tempo.

Isso ocorrera se o contador de inatividade for igual a 0.

Returns:

true se o cliente deve ser removido, ou false em caso contrario.

Definition at line 1021 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CClientInfo - MustRemoveClient] Single" << endl;
    #endif

    return ( IdleCount == 0 ); // Se o contador for zero, entao o cliente 
                               // devera ser removido. Em caso contrario, ainda
                               // nao devera ser removido.
}

FragmentInfo * CClientInfo::Remove

(

void

)

[virtual]

Remove remove um dos elementos do inicio da fila do um objeto associado ao cliente, 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 CLeakBucket.

Definition at line 970 of file StreamControl.cpp.

{
    FragmentInfo *fip;

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

    // Obtem o acesso ao mutex para garantir o acesso exclusivo a fila do 
    // LeakBucket.
    pthread_mutex_lock( &m_AccessFragmentQueue );
    // Chama a funcao da classe pai para remover o fragmento na fila.
    fip = CLeakBucket::Remove();
    // Libera o mutex para garantir o acesso exclusivo a fila do LeakBucket.
    pthread_mutex_unlock( &m_AccessFragmentQueue );

    #ifdef RIO_DEBUG1
    RioErr << "[CClientInfo - Remove] Finish" << endl;
    #endif

    return fip;    
}

void CClientInfo::UpdateCredits

(

)

[virtual]

UpdateCredits atualiza, se necessario, o numero de creditos de um objeto associado ao cliente.

Se o tempo entre as atualizacoes nao passou, o credito nao sera atualizado e um contador, usado para detectar se o cliente esta inativo, sera decrementado caso a fila do cliente esteja vazia. Em caso contrario, o credito sera incrementado, 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 from CLeakBucket.

Definition at line 996 of file StreamControl.cpp.

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

    // Obtem o acesso ao mutex para garantir o acesso exclusivo a fila do 
    // LeakBucket.
    pthread_mutex_lock( &m_AccessFragmentQueue );
    // Verifica se a fila FIFO esta vazia, pois neste caso deveremos decrementar
    // o contador de inatividade em uma unidade (se ele nao for zero).
    if( ( IsEmpty() ) && ( IdleCount > 0 ) )
        IdleCount--;
    // Libera o mutex para garantir o acesso exclusivo a fila do LeakBucket.
    pthread_mutex_unlock( &m_AccessFragmentQueue );
    // Chama a funcao da classe pai para atualizar os creditos do cliente.
    CLeakBucket::UpdateCredits();    

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

---

Field Documentation

unsigned int CClientInfo::IdleCount [private]

Contador usado para detectar a inatividade do cliente.

Quando o contador for nulo, isso significa que o cliente devera ser removido do heap e do mapa.

Definition at line 454 of file StreamControl.h.

int CClientInfo::IP [private]

Endereco IP do cliente (na ordem da rede).

Definition at line 447 of file StreamControl.h.

pthread_mutex_t CClientInfo::m_AccessFragmentQueue [private]

Mutex para garantir o acesso exclusivo a fila do LeakBucket.

Definition at line 456 of file StreamControl.h.

int CClientInfo::Port [private]

Porta IP do cliente (na ordem da rede).

Definition at line 449 of file StreamControl.h.

---

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

• StreamControl.h
• StreamControl.cpp