VZTECH / Mbed 2 deprecated main_src

Modularizando o src

Dependencies:   EALib EthernetInterface_vz mbed-rtos mbed

Fork of header_main_colinas_V0-20-09-14 by VZTECH

call_box_manager.h@74:81c47fff88a5, 2014-11-24 (annotated)

Committer:
klauss
Date:
Mon Nov 24 16:43:16 2014 +0000
Revision:
74:81c47fff88a5
Child:
78:1353744f01e1
validando organiza??o de arquivos | ainda em desenvolvimento.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
klauss 74:81c47fff88a5 1 #ifndef __CALL_BOX_MANAGER_H__
klauss 74:81c47fff88a5 2 #define __CALL_BOX_MANAGER_H__
klauss 74:81c47fff88a5 3
klauss 74:81c47fff88a5 4 #include "mbed.h"
klauss 74:81c47fff88a5 5 #include "EthernetInterface.h"
klauss 74:81c47fff88a5 6 #include "debug.h"
klauss 74:81c47fff88a5 7 #include "vz_protocol.h"
klauss 74:81c47fff88a5 8 #include "vector.h"
klauss 74:81c47fff88a5 9 #include "call_box.h"
klauss 74:81c47fff88a5 10 #include "parallelcpld.h"
klauss 74:81c47fff88a5 11
klauss 74:81c47fff88a5 12 /**
klauss 74:81c47fff88a5 13 * @Synopsis Busca por um determinado Call_box no vetor de Call_box usando como chave de busca o ramal.
klauss 74:81c47fff88a5 14 *
klauss 74:81c47fff88a5 15 * @param v_cb O vetor contendo todos os Call_box conhecidos pela Header em determinado momento.
klauss 74:81c47fff88a5 16 * @param ext O ramal pelo qual se irá buscar o CBx.
klauss 74:81c47fff88a5 17 *
klauss 74:81c47fff88a5 18 * @return NULL caso não tenha sido encontrado nenhum CBx com esse ramal; retorna um ponteiro para o Call_box que possui esse ramal,
klauss 74:81c47fff88a5 19 * caso o mesmo tenha sido encontrado.
klauss 74:81c47fff88a5 20 *
klauss 74:81c47fff88a5 21 * Exemplo:
klauss 74:81c47fff88a5 22 * @code
klauss 74:81c47fff88a5 23 * ...
klauss 74:81c47fff88a5 24 * Vector * v_cb = new Vector();
klauss 74:81c47fff88a5 25 * //assumindo que esse vetor de Call_Box já foi populado.
klauss 74:81c47fff88a5 26 * int ext = 5218;
klauss 74:81c47fff88a5 27 * Call_Box * cb = __find_CB__( v_cb, ext );
klauss 74:81c47fff88a5 28 * ...
klauss 74:81c47fff88a5 29 * @endcode
klauss 74:81c47fff88a5 30 */
klauss 74:81c47fff88a5 31 Call_Box * __find_CB__( Vector * v_cb, int ext );
klauss 74:81c47fff88a5 32
klauss 74:81c47fff88a5 33 /**
klauss 74:81c47fff88a5 34 * @Synopsis Função responsavel por "envelhecer" os registros na Header, na prática, é essa função que pergunta de tempo
klauss 74:81c47fff88a5 35 * em tempo se o CBx ainda continua ativo; Essa função também é responsavel por remover o CBx do v_cb assim como deletar o elemento cb
klauss 74:81c47fff88a5 36 * assossiado.
klauss 74:81c47fff88a5 37 *
klauss 74:81c47fff88a5 38 * @param v_cb Um vetor contendo todos os Call_box conhecidos pela Header em um determinado momento.
klauss 74:81c47fff88a5 39 * @param data Usado para a criação do pacote de "ping" que a Header irá enviar para o CBx.
klauss 74:81c47fff88a5 40 * @param write_buffer Local de memória onde efetivamente irá ser montado o pacote para envio ao CBx do pacote de "ping" ( Registry ).
klauss 74:81c47fff88a5 41 *
klauss 74:81c47fff88a5 42 * Exemplo:
klauss 74:81c47fff88a5 43 * @code
klauss 74:81c47fff88a5 44 * ...
klauss 74:81c47fff88a5 45 * Vector * v_cb = new Vector();
klauss 74:81c47fff88a5 46 * //assumindo que esse vetor de Call_Box já foi populado.
klauss 74:81c47fff88a5 47 * uint8_t buffer[ 300 ];
klauss 74:81c47fff88a5 48 * uint8_t write_buffer[ 300 ];
klauss 74:81c47fff88a5 49 * registry_aging( v_cb, buffer, write_buffer );
klauss 74:81c47fff88a5 50 * ...
klauss 74:81c47fff88a5 51 * @endcode
klauss 74:81c47fff88a5 52 */
klauss 74:81c47fff88a5 53 void registry_aging( Vector * v_cb, uint8_t * data, uint8_t * write_buffer );
klauss 74:81c47fff88a5 54
klauss 74:81c47fff88a5 55 #endif