CFPool Class Reference

#include <StreamControl.h>

Inherits CFragmentQueue.

Public Member Functions
	CFPool ()
	CFPool construtor da classe, chamado quando um objeto e criado usando o comando new.
	~CFPool ()
	~CFPool 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.
void	WaitObject ()
	WaitObject funcao usada para esperar que existam objetos na fila FIFO de um objeto da classe.
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.
Private Attributes
pthread_cond_t	m_WaitObject
	Variavel de condicao usada pela thread que processa os clientes para esperar pelo evento indicando que a fila FIFO da classe, com objetos FragmentInfo, deixou de ficar vazia.
pthread_mutex_t	m_AccessFragmentQueue
	Mutex para garantir o acesso exclusivo a fila FIFO.

---

Detailed Description

Definition at line 382 of file StreamControl.h.

---

Constructor & Destructor Documentation

CFPool::CFPool

(

)

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

Definition at line 757 of file StreamControl.cpp.

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

    // Cria a variavel de condicao da classe.
    pthread_cond_init( &m_WaitObject, NULL );
    // Cria o mutex usado para garantir o acesso exclusivo a fila FIFO.
    pthread_mutex_init( &m_AccessFragmentQueue, NULL );

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

CFPool::~CFPool

(

)

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

Definition at line 774 of file StreamControl.cpp.

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

    // Remove a variavel de condicao da classe.
    pthread_cond_destroy( &m_WaitObject );
    // remove o mutex usado para garantir o acesso exclusivo a fila FIFO.
    pthread_mutex_destroy( &m_AccessFragmentQueue );

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

---

Member Function Documentation

int CFPool::Insert

(

FragmentInfo *

fip

)

[virtual]

Insert Insere um objeto FragmentInfo no final da fila.

Se a fila estava vazia antes da insercao do elemento, um sinal sera enviado a thread que foi bloqueada na variavel de condicao m_WaitObject ao executar a funcao Remove dada a seguir, pois agora existem elementos a serem removidos da fila.

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 793 of file StreamControl.cpp.

{
    bool SendSignal;
    int result;

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

    // Usa a funcao Insert da classe pai para inserir o objeto FragmentInfo na
    // fila FIFO.
    // Obtem acesso exclusivo a fila FIFO.
    pthread_mutex_lock( &m_AccessFragmentQueue );
    SendSignal = IsEmpty();
    result = CFragmentQueue::Insert( fip );
    #ifdef RIO_DEBUG2
    // Imprime a lista obtida apos a insercao do objeto.
    CFragmentQueue::PrintFragmentQueue( "Insercao em CFPool" );
    #endif
    // Se nao ocorreu nenhum erro na insercao, devemos gerar um sinal
    // informando que um objeto foi inserido, se o pool estava vazio antes
    // da insercao (obs: devemos usar S_OK ao inves de S_OK?) 
    if( ( result == S_OK ) && ( SendSignal ) ) 
        // Envia um sinal para a variavel de condicao, para desbloquear, se
        // necessario, uma thread que esteja esperando pela condicao, que e a
        // insercao de um objeto FragmentInfo no pool.
        pthread_cond_signal( &m_WaitObject );
    // Libera o acesso exclusivo a fila FIFO.
    pthread_mutex_unlock( &m_AccessFragmentQueue );

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

    return result;
}

FragmentInfo * CFPool::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 da classe 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.

Definition at line 865 of file StreamControl.cpp.

{
    FragmentInfo *fip;

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

    // Usa a funcao Remove da classe pai para tentar remover um objeto
    // FragmentInfo da fila FIFO.
    // Obtem acesso exclusivo a fila FIFO.
    pthread_mutex_lock( &m_AccessFragmentQueue );
    fip = CFragmentQueue::Remove();
    #ifdef RIO_DEBUG2
    // Imprime a lista obtida apos a remocao do objeto.
    CFragmentQueue::PrintFragmentQueue( "Remocao em CFPool" );
    #endif
    // Libera o acesso exclusivo a fila FIFO.
    pthread_mutex_unlock( &m_AccessFragmentQueue );

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

    return fip;
}

void CFPool::WaitObject

(

)

WaitObject funcao usada para esperar que existam objetos na fila FIFO de um objeto da classe.

Se a fila nao estiver vazia, a funcao retornara imediatamente o controle a thread que a executou. Porem, caso a fila esteja vazia, a thread que chamou a funcao sera bloqueada na variavel de condicao m_WaitObject, ate que um elemento seja inserido na fila pela funcao Insert.

Definition at line 834 of file StreamControl.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "[CFPool - WaitObject] Start" << endl;
    #endif

    // Usa a funcao Remove da classe pai para tentar remover um objeto
    // FragmentInfo da fila FIFO.
    // Obtem acesso exclusivo a fila FIFO.
    pthread_mutex_lock( &m_AccessFragmentQueue );
    if( IsEmpty() ) 
    {
        // Espera na variavel de condicao pela chegada de um objeto 
        // FragmentInfo. A thread que chamou Insert sera bloqueada ate que a 
        // funcao Insert seja chamada e gere um sinal para a variavel de 
        // condicao, o que ira em consequencia desbloquear a thread.
        #ifdef RIO_DEBUG2
        RioErr << "CFPool::WaitObject esperando por um objeto." << endl;
        #endif
        pthread_cond_wait( &m_WaitObject, &m_AccessFragmentQueue );
    }
    // Libera o acesso exclusivo a fila FIFO.
    pthread_mutex_unlock( &m_AccessFragmentQueue );

    #ifdef RIO_DEBUG1
    RioErr << "[CFPool - WaitObject] Finish" << endl;
    #endif
}

---

Field Documentation

pthread_mutex_t CFPool::m_AccessFragmentQueue [private]

Mutex para garantir o acesso exclusivo a fila FIFO.

Definition at line 391 of file StreamControl.h.

pthread_cond_t CFPool::m_WaitObject [private]

Variavel de condicao usada pela thread que processa os clientes para esperar pelo evento indicando que a fila FIFO da classe, com objetos FragmentInfo, deixou de ficar vazia.

Definition at line 389 of file StreamControl.h.

---

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

• StreamControl.h
• StreamControl.cpp