Diff: call_box_manager.h

Revision:

74:81c47fff88a5

Child:

78:1353744f01e1

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/call_box_manager.h	Mon Nov 24 16:43:16 2014 +0000
@@ -0,0 +1,55 @@
+#ifndef __CALL_BOX_MANAGER_H__
+#define __CALL_BOX_MANAGER_H__
+
+#include "mbed.h"
+#include "EthernetInterface.h"
+#include "debug.h"
+#include "vz_protocol.h"
+#include "vector.h"
+#include "call_box.h"
+#include "parallelcpld.h"
+
+/**
+ * @Synopsis Busca por um determinado Call_box no vetor de Call_box usando como chave de busca o ramal.
+ *
+ * @param v_cb O vetor contendo todos os Call_box conhecidos pela Header em determinado momento.
+ * @param ext O ramal pelo qual se irá buscar o CBx.
+ *
+ * @return NULL caso não tenha sido encontrado nenhum CBx com esse ramal; retorna um ponteiro para o Call_box que possui esse ramal,
+ * caso o mesmo tenha sido encontrado.
+ *
+ * Exemplo:
+ * @code
+ * ...
+ *  Vector * v_cb = new Vector();
+ *      //assumindo que esse vetor de Call_Box já foi populado.
+ *  int ext = 5218;
+ *  Call_Box * cb = __find_CB__( v_cb, ext );
+ * ...
+ * @endcode
+ */
+Call_Box * __find_CB__( Vector * v_cb, int ext );
+
+/**
+ * @Synopsis Função responsavel por "envelhecer" os registros na Header, na prática, é essa função que pergunta de tempo
+ * 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
+ * assossiado.
+ *
+ * @param v_cb Um vetor contendo todos os Call_box conhecidos pela Header em um determinado momento.
+ * @param data Usado para a criação do pacote de "ping" que a Header irá enviar para o CBx.
+ * @param write_buffer Local de memória onde efetivamente irá ser montado o pacote para envio ao CBx do pacote de "ping" ( Registry ).
+ *
+ * Exemplo:
+ * @code
+ * ...
+ *  Vector * v_cb = new Vector();
+ *      //assumindo que esse vetor de Call_Box já foi populado.
+ *  uint8_t buffer[ 300 ];
+ *      uint8_t write_buffer[ 300 ];
+ *  registry_aging( v_cb, buffer, write_buffer );
+ * ...
+ * @endcode
+ */
+void registry_aging( Vector * v_cb, uint8_t * data, uint8_t * write_buffer );
+
+#endif
\ No newline at end of file