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.h@76:9f5f99dd895a, 2014-11-25 (annotated)

Committer:
klauss
Date:
Tue Nov 25 17:37:56 2014 +0000
Revision:
76:9f5f99dd895a
Parent:
74:81c47fff88a5
Child:
77:e8c0253b57bc
desenvolvendo invite assincrono | validando

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