Modularizando o src

Dependencies:   EALib EthernetInterface_vz mbed-rtos mbed

Fork of header_main_colinas_V0-20-09-14 by VZTECH

Committer:
klauss
Date:
Tue Dec 16 12:13:01 2014 +0000
Revision:
78:1353744f01e1
Parent:
77:e8c0253b57bc
Child:
81:3656f00ab3db
before meeting

Who changed what in which revision?

UserRevisionLine numberNew contents of line
klauss 69:65665afbad5d 1 /**
klauss 69:65665afbad5d 2 * @file call_box.h
klauss 69:65665afbad5d 3 * @Synopsis Implementa as funções de gerenciamento do Call_Box
klauss 69:65665afbad5d 4 * @author Jhonatan Casale
klauss 69:65665afbad5d 5 * @version 1
klauss 69:65665afbad5d 6 * @date 2014-11-06
klauss 69:65665afbad5d 7 * \class Call_Box
klauss 69:65665afbad5d 8 */
klauss 0:4d17cd9c8f9d 9 #ifndef __CALL_BOX_H__
klauss 0:4d17cd9c8f9d 10 #define __CALL_BOX_H__
klauss 0:4d17cd9c8f9d 11
klauss 0:4d17cd9c8f9d 12 #include "mbed.h"
klauss 0:4d17cd9c8f9d 13 #include "object.h"
klauss 0:4d17cd9c8f9d 14 #include "sip.h"
klauss 0:4d17cd9c8f9d 15 #include "debug.h"
klauss 74:81c47fff88a5 16
klauss 78:1353744f01e1 17 #define __RESQUEST_TIME__ 3
klauss 78:1353744f01e1 18
klauss 78:1353744f01e1 19 #define __TIMEOUT__ 250
klauss 69:65665afbad5d 20 ///< O tempo que a Header demora para "pingar" o Call_Box para saber se esta tudo bem.
klauss 78:1353744f01e1 21 #define __RANGE_TO_REGISTER__ 150
klauss 78:1353744f01e1 22 ///< Doc. later
klauss 78:1353744f01e1 23 #define __TIME_TO_REGISTER__ __TIMEOUT__ - __RANGE_TO_REGISTER__
klauss 78:1353744f01e1 24
klauss 78:1353744f01e1 25 #define __CYCLES__ __TIME_TO_REGISTER__ / __RESQUEST_TIME__ // 200 // 3 ~ 66
klauss 78:1353744f01e1 26
klauss 78:1353744f01e1 27 #define REQUEST_REGISTRY -1
klauss 78:1353744f01e1 28 #define REQUEST_PEND -2
klauss 78:1353744f01e1 29 #define REQUEST_PING -4
klauss 78:1353744f01e1 30
klauss 78:1353744f01e1 31 ///< Valor usado como referencia para registro do equipamento CBx.
klauss 55:2f5e7374af9d 32 #define __MAX_ATTEMPTS__ 5
klauss 69:65665afbad5d 33 ///< O numero maximo de vezes que a Header vai tentar pingar o Call_Box
klauss 69:65665afbad5d 34 #define __STEP__ 30
klauss 69:65665afbad5d 35 ///< Usado para aumentar o intervalo entre cada ping, fora de uso atualmente.
klauss 0:4d17cd9c8f9d 36 #define __MAX_TIMEOUT__ __STEP__ * __MAX_ATTEMPTS__
klauss 69:65665afbad5d 37 ///< Usado para limitar o tempo maximo de timeout do Call_Box sem responder o ping, fora de uso.
klauss 0:4d17cd9c8f9d 38
klauss 0:4d17cd9c8f9d 39 #define cb_idle 1
klauss 69:65665afbad5d 40 ///< Representa que o Call_Box esta disponivel
klauss 0:4d17cd9c8f9d 41 #define cb_ringing 2
klauss 69:65665afbad5d 42 ///< Representa o Call_Box no status, discando.
klauss 0:4d17cd9c8f9d 43 #define cb_trying 3
klauss 69:65665afbad5d 44 ///< Representa o Call_Box no status tentando concluir o pedido de ligação.
klauss 0:4d17cd9c8f9d 45 #define cb_on_call 4
klauss 69:65665afbad5d 46 ///< Representa que o Call_Box já esta em uma ligação.
klauss 0:4d17cd9c8f9d 47 #define cb_busy 5
klauss 69:65665afbad5d 48 ///< Representa que o Call_Box esta ocupado.
klauss 78:1353744f01e1 49 #define cb_denied 6
klauss 78:1353744f01e1 50 ///< Representa que o pedido de invite do Call_Box foi negado.
klauss 0:4d17cd9c8f9d 51
klauss 0:4d17cd9c8f9d 52 class Call_Box : public Object{
klauss 0:4d17cd9c8f9d 53 private :
klauss 0:4d17cd9c8f9d 54 int ext; // ramal
klauss 0:4d17cd9c8f9d 55 int port; // porta
klauss 0:4d17cd9c8f9d 56 Timer t;
klauss 0:4d17cd9c8f9d 57 uint8_t remaining_attempts;
klauss 0:4d17cd9c8f9d 58 float timeout;
klauss 0:4d17cd9c8f9d 59 uint8_t msg_id;
klauss 0:4d17cd9c8f9d 60 uint8_t timeslice;
klauss 78:1353744f01e1 61 uint8_t next_aging_type;
klauss 78:1353744f01e1 62
klauss 78:1353744f01e1 63 Timer seconds;
klauss 0:4d17cd9c8f9d 64
klauss 0:4d17cd9c8f9d 65 public :
klauss 69:65665afbad5d 66 /**
klauss 69:65665afbad5d 67 * @Synopsis Objeto Sip que será usado para tratativas com o servidor.
klauss 69:65665afbad5d 68 *
klauss 69:65665afbad5d 69 * \note Esse objeto é criado no construtor da classe Call_Box, com os mesmos parâmetros passados para o
klauss 69:65665afbad5d 70 * construtor da classe Call_Box.
klauss 69:65665afbad5d 71 */
klauss 0:4d17cd9c8f9d 72 Sip * sip;
klauss 69:65665afbad5d 73
klauss 69:65665afbad5d 74 /**
klauss 69:65665afbad5d 75 * @Synopsis Cria um objeto Call_Box
klauss 69:65665afbad5d 76 *
klauss 69:65665afbad5d 77 * @param ext Vincula o objeto ao ramal informado
klauss 69:65665afbad5d 78 * @param port Vincula o objeto a porto informada.
klauss 69:65665afbad5d 79 *
klauss 69:65665afbad5d 80 * Exemplo:
klauss 69:65665afbad5d 81 * @code
klauss 69:65665afbad5d 82 * ...
klauss 69:65665afbad5d 83 * int ext = 5121;
klauss 69:65665afbad5d 84 * int port = 5021;
klauss 69:65665afbad5d 85 * Call_Box * cb = new Call_Box( ext, port );
klauss 69:65665afbad5d 86 * ...
klauss 69:65665afbad5d 87 * @endcode
klauss 69:65665afbad5d 88 */
klauss 0:4d17cd9c8f9d 89 Call_Box( int ext, int port );
klauss 69:65665afbad5d 90
klauss 69:65665afbad5d 91 /**
klauss 69:65665afbad5d 92 * @Synopsis Destroi o objeto Call_Box
klauss 69:65665afbad5d 93 *
klauss 69:65665afbad5d 94 * Exemplo:
klauss 69:65665afbad5d 95 * @code
klauss 69:65665afbad5d 96 * ...
klauss 69:65665afbad5d 97 * delete( cb );
klauss 69:65665afbad5d 98 * ...
klauss 69:65665afbad5d 99 * @endcode
klauss 69:65665afbad5d 100 * \note Deleta o objeto Sip nesse processo.
klauss 69:65665afbad5d 101 */
klauss 0:4d17cd9c8f9d 102 ~Call_Box( void );
klauss 0:4d17cd9c8f9d 103
klauss 69:65665afbad5d 104 /**
klauss 69:65665afbad5d 105 * @Synopsis Representa o status do Call_Box.
klauss 69:65665afbad5d 106 *
klauss 69:65665afbad5d 107 * \note Este valor sempre é atualizado ( por convenção ) com o uso da macro set_status(a,b), definida em utils.h
klauss 69:65665afbad5d 108 */
klauss 0:4d17cd9c8f9d 109 uint8_t status;
klauss 0:4d17cd9c8f9d 110
klauss 69:65665afbad5d 111 /**
klauss 69:65665afbad5d 112 * @Synopsis Informa o ramal vinculado ao objeto Call_Box.
klauss 69:65665afbad5d 113 *
klauss 69:65665afbad5d 114 * @return O numero do ramal contido atualmente no objeto Call_Box
klauss 69:65665afbad5d 115 *
klauss 69:65665afbad5d 116 * Exemplo:
klauss 69:65665afbad5d 117 * @code
klauss 69:65665afbad5d 118 * ...
klauss 69:65665afbad5d 119 * int ext = cb->get_ext();
klauss 69:65665afbad5d 120 * ...
klauss 69:65665afbad5d 121 * @endcode
klauss 69:65665afbad5d 122 */
klauss 0:4d17cd9c8f9d 123 int get_ext( void );
klauss 69:65665afbad5d 124
klauss 69:65665afbad5d 125 /**
klauss 69:65665afbad5d 126 * @Synopsis Informa o numero da porta vinculada ao objeto Call_Box.
klauss 69:65665afbad5d 127 *
klauss 69:65665afbad5d 128 * @return O numero da porta contido atualmente no objeto Call_Box
klauss 69:65665afbad5d 129 *
klauss 69:65665afbad5d 130 * Exemplo:
klauss 69:65665afbad5d 131 * @code
klauss 69:65665afbad5d 132 * ...
klauss 69:65665afbad5d 133 * int port = cb->get_port();
klauss 69:65665afbad5d 134 * ...
klauss 69:65665afbad5d 135 * @endcode
klauss 69:65665afbad5d 136 */
klauss 0:4d17cd9c8f9d 137 int get_port( void );
klauss 69:65665afbad5d 138
klauss 69:65665afbad5d 139 /**
klauss 69:65665afbad5d 140 * @Synopsis Informa o tempo decorrido.
klauss 69:65665afbad5d 141 * \note O timer de cada objeto é iniciado no momento da criação do objeto Call_Box.
klauss 69:65665afbad5d 142 *
klauss 69:65665afbad5d 143 * @return O tempo decorrido desde a ultima vez que o timer do objeto foi resetado.
klauss 69:65665afbad5d 144 *
klauss 69:65665afbad5d 145 * Exemplo:
klauss 69:65665afbad5d 146 * @code
klauss 69:65665afbad5d 147 * ...
klauss 69:65665afbad5d 148 * float elapsed_time = cb->get_elapsed_time();
klauss 69:65665afbad5d 149 * ...
klauss 69:65665afbad5d 150 * @endcode
klauss 69:65665afbad5d 151 */
klauss 0:4d17cd9c8f9d 152 float get_elapsed_time( void );
klauss 69:65665afbad5d 153
klauss 69:65665afbad5d 154 /**
klauss 69:65665afbad5d 155 * @Synopsis Informa se o Call_Box esta inativo acima do tempo previsto.
klauss 69:65665afbad5d 156 *
klauss 69:65665afbad5d 157 * @retval True - Caso o timer do objeto seja maior que o definido.
klauss 69:65665afbad5d 158 * @retval False - Caso o timer do objeto seja menor que o definido..
klauss 69:65665afbad5d 159 *
klauss 69:65665afbad5d 160 * Exemplo:
klauss 69:65665afbad5d 161 * @code
klauss 69:65665afbad5d 162 * ...
klauss 69:65665afbad5d 163 * printf(" %s ", ( cb->is_timeout() ) ? "Call_Box is outdated" : "Call_Box is okay" );
klauss 69:65665afbad5d 164 * ...
klauss 69:65665afbad5d 165 * @endcode
klauss 69:65665afbad5d 166 */
klauss 0:4d17cd9c8f9d 167 bool is_timeout( void );
klauss 69:65665afbad5d 168
klauss 69:65665afbad5d 169 /**
klauss 69:65665afbad5d 170 * @Synopsis Reconfigura o timeout de forma incremental, informando se ainda existe alguma tentativas de "ping" nesse Call_Box
klauss 69:65665afbad5d 171 *
klauss 69:65665afbad5d 172 * @return O numero de tentativas restantes de registro desse Call_Box. Retorno 0 significa que as tentativar acabaram.
klauss 69:65665afbad5d 173 *
klauss 69:65665afbad5d 174 * Exemplo:
klauss 69:65665afbad5d 175 * @code
klauss 69:65665afbad5d 176 * ...
klauss 78:1353744f01e1 177 * if( cb->has_next_try() == 0x00 ){
klauss 69:65665afbad5d 178 * // faça alguma coisa ...
klauss 69:65665afbad5d 179 * }
klauss 69:65665afbad5d 180 * ...
klauss 69:65665afbad5d 181 * @endcode
klauss 69:65665afbad5d 182 */
klauss 78:1353744f01e1 183 bool has_next_try( void );
klauss 69:65665afbad5d 184
klauss 69:65665afbad5d 185 /**
klauss 69:65665afbad5d 186 * @Synopsis Reseta o timer do objeto Call_Box.
klauss 69:65665afbad5d 187 *
klauss 69:65665afbad5d 188 * Exemplo:
klauss 69:65665afbad5d 189 * @code
klauss 69:65665afbad5d 190 * ...
klauss 69:65665afbad5d 191 * cb->reset_elapsed_time();
klauss 69:65665afbad5d 192 * ...
klauss 69:65665afbad5d 193 * @endcode
klauss 69:65665afbad5d 194 */
klauss 0:4d17cd9c8f9d 195 void reset_elapsed_time( void );
klauss 69:65665afbad5d 196
klauss 69:65665afbad5d 197 /**
klauss 69:65665afbad5d 198 * @Synopsis Invoca o método de registro deste Call_Box ( via objeto Sip vinculado ).
klauss 69:65665afbad5d 199 *
klauss 69:65665afbad5d 200 * Exemplo:
klauss 69:65665afbad5d 201 * @code
klauss 69:65665afbad5d 202 * ...
klauss 69:65665afbad5d 203 * cb->registry();
klauss 69:65665afbad5d 204 * ...
klauss 69:65665afbad5d 205 * @endcode
klauss 69:65665afbad5d 206 */
klauss 0:4d17cd9c8f9d 207 void registry( void );
klauss 69:65665afbad5d 208
klauss 69:65665afbad5d 209 /**
klauss 69:65665afbad5d 210 * @Synopsis Invoca o método de pedido de ligação.
klauss 69:65665afbad5d 211 *
klauss 69:65665afbad5d 212 * @return Um ponteiro para um objeto VZ_call quando o pedido foi aceito pelo server, NULL caso em que o pedido de invite foi
klauss 69:65665afbad5d 213 * negado pelo server ou aconteceu timeout do invite.
klauss 69:65665afbad5d 214 *
klauss 69:65665afbad5d 215 * Exemplo:
klauss 69:65665afbad5d 216 * @code
klauss 69:65665afbad5d 217 * ...
klauss 69:65665afbad5d 218 * VZ_call * call = cb->invite();
klauss 69:65665afbad5d 219 * ...
klauss 69:65665afbad5d 220 * @endcode
klauss 69:65665afbad5d 221 */
klauss 0:4d17cd9c8f9d 222 VZ_call * invite( void );
klauss 69:65665afbad5d 223
klauss 69:65665afbad5d 224 /**
klauss 69:65665afbad5d 225 * @Synopsis Valor inicial para preenchimento deste campo nos pacotes trocados entre Header/Call_Box.
klauss 69:65665afbad5d 226 *
klauss 69:65665afbad5d 227 * @param msg_id Seta o valor recebido como parâmetro na variável do objeto.
klauss 69:65665afbad5d 228 *
klauss 69:65665afbad5d 229 * Exemplo:
klauss 69:65665afbad5d 230 * @code
klauss 69:65665afbad5d 231 * ...
klauss 69:65665afbad5d 232 * cb->set_msg_id( 0x12 );
klauss 69:65665afbad5d 233 * ...
klauss 69:65665afbad5d 234 * @endcode
klauss 69:65665afbad5d 235 */
klauss 0:4d17cd9c8f9d 236 void set_msg_id( uint8_t msg_id );
klauss 69:65665afbad5d 237
klauss 69:65665afbad5d 238 /**
klauss 69:65665afbad5d 239 * @Synopsis Informa o numero atual de msg_id que será enviado na próxima mensagem desse Call_Box
klauss 69:65665afbad5d 240 *
klauss 69:65665afbad5d 241 * @return O valor atual de msg_id.
klauss 69:65665afbad5d 242 *
klauss 69:65665afbad5d 243 * Exemplo:
klauss 69:65665afbad5d 244 * @code
klauss 69:65665afbad5d 245 * ...
klauss 69:65665afbad5d 246 * uint8_t msg_id = cb->get_msg_id();
klauss 69:65665afbad5d 247 * ...
klauss 69:65665afbad5d 248 * @endcode
klauss 69:65665afbad5d 249 */
klauss 0:4d17cd9c8f9d 250 uint8_t get_msg_id( void );
klauss 69:65665afbad5d 251
klauss 69:65665afbad5d 252
klauss 69:65665afbad5d 253 /**
klauss 69:65665afbad5d 254 * @Synopsis Armazena o valor de Timeslice atualmente em uso pelo Call_Box.
klauss 69:65665afbad5d 255 *
klauss 69:65665afbad5d 256 * @param timeslice O valor que corresponde ao Timeslice disponivel para comunição do Call_Box
klauss 69:65665afbad5d 257 *
klauss 69:65665afbad5d 258 * Exemplo:
klauss 69:65665afbad5d 259 * @code
klauss 69:65665afbad5d 260 * ...
klauss 69:65665afbad5d 261 * Timeslice * ts = new Timeslice();
klauss 69:65665afbad5d 262 * cb->set_timeslice( ts->get_timeslice() );
klauss 69:65665afbad5d 263 * ...
klauss 69:65665afbad5d 264 * @endcode
klauss 69:65665afbad5d 265 */
klauss 69:65665afbad5d 266 void set_timeslice( uint8_t timeslice );
klauss 69:65665afbad5d 267
klauss 69:65665afbad5d 268
klauss 69:65665afbad5d 269 /**
klauss 69:65665afbad5d 270 * @Synopsis Informa o timeslice ocupado atualmente pelo Call_Box.
klauss 69:65665afbad5d 271 *
klauss 69:65665afbad5d 272 * @return O valor do timeslice em uso pelo Call_Box.
klauss 69:65665afbad5d 273 *
klauss 69:65665afbad5d 274 * Exemplo:
klauss 69:65665afbad5d 275 * @code
klauss 69:65665afbad5d 276 * ...
klauss 69:65665afbad5d 277 * uint8_t ts = cb->get_timeslice();
klauss 69:65665afbad5d 278 * ...
klauss 69:65665afbad5d 279 * @endcode
klauss 69:65665afbad5d 280 */
klauss 0:4d17cd9c8f9d 281 uint8_t get_timeslice( void );
klauss 69:65665afbad5d 282
klauss 0:4d17cd9c8f9d 283 //void set_sip( Sip * sip );
klauss 69:65665afbad5d 284
klauss 69:65665afbad5d 285 /**
klauss 69:65665afbad5d 286 * @Synopsis Faz chamada ( via objeto Sip vinculado ) a função que irá escutar a porta SIP associada neste Call_Box.
klauss 69:65665afbad5d 287 *
klauss 69:65665afbad5d 288 * @return Um valor menor que zero se a execução falhar, igual a zero se a execução for bem sucedida e nenhum dado foi
klauss 69:65665afbad5d 289 * recebido, ou quando a execução foi bem sucedida e nenhuma mensagem que demanda tramamento foi recebida; um numero
klauss 69:65665afbad5d 290 * maior do que zero, caso tenha recebido um pacote do tipo "bye" do servidor; este numero corresponde ao ramal do Call_Box.
klauss 69:65665afbad5d 291 *
klauss 69:65665afbad5d 292 * Exemplo:
klauss 69:65665afbad5d 293 * @code
klauss 69:65665afbad5d 294 * ...
klauss 69:65665afbad5d 295 * int returned_value = cb->listen_SIP_server();
klauss 69:65665afbad5d 296 * ...
klauss 69:65665afbad5d 297 * @endcode
klauss 69:65665afbad5d 298 */
klauss 0:4d17cd9c8f9d 299 int listen_SIP_server( void );
klauss 69:65665afbad5d 300
klauss 69:65665afbad5d 301 /**
klauss 69:65665afbad5d 302 * @Synopsis Invoca ( no objeto Sip ) o método de pedido de "desregistro".
klauss 69:65665afbad5d 303 *
klauss 69:65665afbad5d 304 * Exemplo:
klauss 69:65665afbad5d 305 * @code
klauss 69:65665afbad5d 306 * ...
klauss 69:65665afbad5d 307 * cb->unregistry();
klauss 69:65665afbad5d 308 * ...
klauss 69:65665afbad5d 309 * @endcode
klauss 69:65665afbad5d 310 */
klauss 0:4d17cd9c8f9d 311 void unregistry( void );
klauss 69:65665afbad5d 312
klauss 69:65665afbad5d 313 /**
klauss 69:65665afbad5d 314 * @Synopsis Invoca ( via objeto Sip ) o método de envio do pacote de "bye" para o servidor.
klauss 69:65665afbad5d 315 *
klauss 69:65665afbad5d 316 * Exemplo:
klauss 69:65665afbad5d 317 * @code
klauss 69:65665afbad5d 318 * ...
klauss 69:65665afbad5d 319 * cb->send_bye();
klauss 69:65665afbad5d 320 * ...
klauss 69:65665afbad5d 321 * @endcode
klauss 69:65665afbad5d 322 */
klauss 0:4d17cd9c8f9d 323 void send_bye( void );
klauss 69:65665afbad5d 324
klauss 69:65665afbad5d 325 /**
klauss 69:65665afbad5d 326 * @Synopsis Destroi o objeto Sip vinculado ao Call_Box, criando e vinculando outro em seguida.
klauss 69:65665afbad5d 327 *
klauss 69:65665afbad5d 328 * Exemplo:
klauss 69:65665afbad5d 329 * @code
klauss 69:65665afbad5d 330 * ...
klauss 69:65665afbad5d 331 * cb->reset_sip();
klauss 69:65665afbad5d 332 * ...
klauss 69:65665afbad5d 333 * @endcode
klauss 69:65665afbad5d 334 */
klauss 1:a1758104fa1d 335 void reset_sip( void );
klauss 69:65665afbad5d 336
klauss 69:65665afbad5d 337 /**
klauss 69:65665afbad5d 338 * @Synopsis Altera o valor do status do objeto Sip vinculado.
klauss 69:65665afbad5d 339 *
klauss 69:65665afbad5d 340 * @param status O novo valor de status que será associado ao objeto Sip vinculado ao Call_Box.
klauss 69:65665afbad5d 341 *
klauss 69:65665afbad5d 342 * Exemplo:
klauss 69:65665afbad5d 343 * @code
klauss 69:65665afbad5d 344 * ...
klauss 69:65665afbad5d 345 * cb->set_sip_status( 0 );
klauss 69:65665afbad5d 346 * ...
klauss 69:65665afbad5d 347 * @endcode
klauss 69:65665afbad5d 348 */
klauss 14:22a35f575502 349 void set_sip_status( int status );
klauss 69:65665afbad5d 350
klauss 69:65665afbad5d 351 /**
klauss 69:65665afbad5d 352 * @Synopsis Inicia ( ou re-inicia ) o Timer do objeto Call_Box.
klauss 69:65665afbad5d 353 *
klauss 69:65665afbad5d 354 * Exemplo:
klauss 69:65665afbad5d 355 * @code
klauss 69:65665afbad5d 356 * ...
klauss 69:65665afbad5d 357 * cb->re_start_timer();
klauss 69:65665afbad5d 358 * ...
klauss 69:65665afbad5d 359 * @endcode
klauss 69:65665afbad5d 360 */
klauss 78:1353744f01e1 361 void re_start_timer( void );
klauss 78:1353744f01e1 362
klauss 78:1353744f01e1 363
klauss 78:1353744f01e1 364 int get_sip_status( void );
klauss 78:1353744f01e1 365 int set_sip_status( uint8_t sip_status );
klauss 78:1353744f01e1 366
klauss 78:1353744f01e1 367 int get_status( void );
klauss 78:1353744f01e1 368 void cb_set_status( uint8_t status );
klauss 78:1353744f01e1 369
klauss 78:1353744f01e1 370 int8_t get_next_aging_type( void );
klauss 0:4d17cd9c8f9d 371 };
klauss 0:4d17cd9c8f9d 372 #endif