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.h@116:39a41ebb675c, 2015-04-23 (annotated)

Committer:
klauss
Date:
Thu Apr 23 20:24:09 2015 +0000
Revision:
116:39a41ebb675c
Parent:
115:a1e1e2e60a2c
Child:
117:e9facba9db27
inicio do merge da vers?o da ultima vistoria com a da sprint 0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
klauss 69:65665afbad5d 1 /**
klauss 69:65665afbad5d 2 * @file call.h
klauss 69:65665afbad5d 3 * @Synopsis Implementa as funcionalidades de uma ligação, incluindo troca de dados de audio em ambos os lados.
klauss 69:65665afbad5d 4 * @author Jhonatan Casale
klauss 69:65665afbad5d 5 * @version 1
klauss 69:65665afbad5d 6 * @date 2014-11-05
klauss 69:65665afbad5d 7 * \class VZ_call
klauss 69:65665afbad5d 8 */
klauss 0:4d17cd9c8f9d 9 #ifndef __CALL_H__
klauss 0:4d17cd9c8f9d 10 #define __CALL_H__
klauss 0:4d17cd9c8f9d 11
klauss 74:81c47fff88a5 12 #include <stdlib.h>
klauss 74:81c47fff88a5 13 #include <stdint.h>
klauss 0:4d17cd9c8f9d 14 #include "mbed.h"
klauss 0:4d17cd9c8f9d 15 #include "EthernetInterface.h"
klauss 0:4d17cd9c8f9d 16 #include "object.h"
klauss 0:4d17cd9c8f9d 17 #include "vz_protocol.h"
klauss 74:81c47fff88a5 18 #include "rtp.h"
klauss 74:81c47fff88a5 19 #include "rtpbuf.h"
klauss 74:81c47fff88a5 20 #include "debug.h"
klauss 85:b6f2dc1d0f4f 21 #include "shared_variables.h"
klauss 0:4d17cd9c8f9d 22
klauss 115:a1e1e2e60a2c 23 const uint8_t __CALL_MAX_IDLE_TIME__ = 5;
klauss 69:65665afbad5d 24 ///< Define o tempo máximo sem receber dados em alguma chamada.
klauss 69:65665afbad5d 25
klauss 115:a1e1e2e60a2c 26 const uint8_t __MAX_CALL_TIME__ = 180;
klauss 69:65665afbad5d 27 ///< Define o tempo máximo ( em segundos ) de uma ligação.
klauss 0:4d17cd9c8f9d 28
klauss 115:a1e1e2e60a2c 29 const uint8_t CBX_PKG_IDLE_MAX_TIME = 10;
klauss 92:92df17f538a8 30
klauss 0:4d17cd9c8f9d 31 class VZ_call : public Object{
klauss 0:4d17cd9c8f9d 32 private :
klauss 0:4d17cd9c8f9d 33 Timer t;
klauss 0:4d17cd9c8f9d 34 Timer finish;
klauss 92:92df17f538a8 35 Timer cbx_pkg_idle_timer;
klauss 0:4d17cd9c8f9d 36 int cb_ext;
klauss 0:4d17cd9c8f9d 37 int cb_port;
klauss 0:4d17cd9c8f9d 38 uint8_t cb2server[ 320 ];
klauss 0:4d17cd9c8f9d 39 char server2cb[ 320 ];
klauss 0:4d17cd9c8f9d 40 uint8_t buffer[ 320 ];
klauss 0:4d17cd9c8f9d 41 UDPSocket rtp_sock;
klauss 0:4d17cd9c8f9d 42 int rtp_server_ext;
klauss 0:4d17cd9c8f9d 43 int rtp_server_port;
klauss 0:4d17cd9c8f9d 44 Endpoint rtp_server;
klauss 0:4d17cd9c8f9d 45 RTP * rtp;
klauss 0:4d17cd9c8f9d 46 rtpbuf_t rtpbuf;
klauss 0:4d17cd9c8f9d 47 public :
klauss 116:39a41ebb675c 48 /**
klauss 116:39a41ebb675c 49 * @Synopsis Cria um objeto da Classe VZ_call.
klauss 116:39a41ebb675c 50 *
klauss 116:39a41ebb675c 51 * @param cb_ext O ramal do CBx que solicitou a ligação.
klauss 116:39a41ebb675c 52 * @param cb_port A porta RTP do CBx que solicitou a ligação.
klauss 116:39a41ebb675c 53 * @param rtp_server_ext O ramal do servidor.
klauss 116:39a41ebb675c 54 * @param rtp_server_port A porta RTP do servidor.
klauss 116:39a41ebb675c 55 *
klauss 116:39a41ebb675c 56 * Exemplo:
klauss 116:39a41ebb675c 57 * @code
klauss 116:39a41ebb675c 58 * ...
klauss 116:39a41ebb675c 59 * VZ_call * call = new VZ_call( 5010, 11841, 913, 12902 );
klauss 116:39a41ebb675c 60 * ...
klauss 116:39a41ebb675c 61 * @endcode
klauss 116:39a41ebb675c 62 */
klauss 0:4d17cd9c8f9d 63 VZ_call( int cb_ext, int cb_port, int rtp_server_ext, int rtp_server_port );
klauss 69:65665afbad5d 64
klauss 116:39a41ebb675c 65 /**
klauss 116:39a41ebb675c 66 * @Synopsis Destroi o objeto da classe.
klauss 116:39a41ebb675c 67 *
klauss 116:39a41ebb675c 68 * Exemplo:
klauss 116:39a41ebb675c 69 * @code
klauss 116:39a41ebb675c 70 * ...
klauss 116:39a41ebb675c 71 * delete( call );
klauss 116:39a41ebb675c 72 * ...
klauss 116:39a41ebb675c 73 * @endcode
klauss 116:39a41ebb675c 74 */
klauss 0:4d17cd9c8f9d 75 ~VZ_call();
klauss 69:65665afbad5d 76
klauss 116:39a41ebb675c 77 /**
klauss 116:39a41ebb675c 78 * @Synopsis Obtém o ramal do CBx.
klauss 116:39a41ebb675c 79 *
klauss 116:39a41ebb675c 80 * @return Um inteiro que representa o ramal do CBx que solicitou a ligação.
klauss 116:39a41ebb675c 81 *
klauss 116:39a41ebb675c 82 * Exemplo:
klauss 116:39a41ebb675c 83 * @code
klauss 116:39a41ebb675c 84 * ...
klauss 116:39a41ebb675c 85 * int cb_ext = call->get_cb_ext();
klauss 116:39a41ebb675c 86 * ...
klauss 116:39a41ebb675c 87 * @endcode
klauss 116:39a41ebb675c 88 */
klauss 0:4d17cd9c8f9d 89 int get_cb_ext();
klauss 69:65665afbad5d 90
klauss 116:39a41ebb675c 91 /**
klauss 116:39a41ebb675c 92 * @Synopsis Obtém a porta RTP do CBx que solicitou a ligação.
klauss 116:39a41ebb675c 93 *
klauss 116:39a41ebb675c 94 * @return Um inteiro que representa a porta do CBx.
klauss 116:39a41ebb675c 95 *
klauss 116:39a41ebb675c 96 * Exemplo:
klauss 116:39a41ebb675c 97 * @code
klauss 116:39a41ebb675c 98 * ...
klauss 116:39a41ebb675c 99 * int cb_port = call->get_cb_ext();
klauss 116:39a41ebb675c 100 * ...
klauss 116:39a41ebb675c 101 * @endcode
klauss 116:39a41ebb675c 102 */
klauss 0:4d17cd9c8f9d 103 int get_cb_port();
klauss 69:65665afbad5d 104
klauss 116:39a41ebb675c 105 /**
klauss 116:39a41ebb675c 106 * @Synopsis Informa o ramal do servidor RTP.
klauss 116:39a41ebb675c 107 *
klauss 116:39a41ebb675c 108 * @return O numero do ramal do servidor RTP.
klauss 116:39a41ebb675c 109 *
klauss 116:39a41ebb675c 110 * Exemplo:
klauss 116:39a41ebb675c 111 * @code
klauss 116:39a41ebb675c 112 * ...
klauss 116:39a41ebb675c 113 * int rtp_server_ext = call->get_rtp_server_ext();
klauss 116:39a41ebb675c 114 * ...
klauss 116:39a41ebb675c 115 * @endcode
klauss 116:39a41ebb675c 116 */
klauss 0:4d17cd9c8f9d 117 int get_rtp_server_ext();
klauss 69:65665afbad5d 118
klauss 116:39a41ebb675c 119 /**
klauss 116:39a41ebb675c 120 * @Synopsis Informa o numero da porta do servidor RTP.
klauss 116:39a41ebb675c 121 *
klauss 116:39a41ebb675c 122 * @return O numero da porta usada na comunicação com o servidor RTP.
klauss 116:39a41ebb675c 123 *
klauss 116:39a41ebb675c 124 * Exemplo:
klauss 116:39a41ebb675c 125 * @code
klauss 116:39a41ebb675c 126 * ...
klauss 116:39a41ebb675c 127 * int rtp_server_port = call->get_rtp_server_port();
klauss 116:39a41ebb675c 128 * ...
klauss 116:39a41ebb675c 129 * @endcode
klauss 116:39a41ebb675c 130 */
klauss 0:4d17cd9c8f9d 131 int get_rtp_server_port();
klauss 69:65665afbad5d 132
klauss 116:39a41ebb675c 133 /**
klauss 116:39a41ebb675c 134 * @Synopsis Coleta dados de audio vindos do servidor
klauss 116:39a41ebb675c 135 *
klauss 116:39a41ebb675c 136 * @param length Um ponteiro para posição de memória que recebera quantos bytes foram lidos no pacote recebido.
klauss 116:39a41ebb675c 137 *
klauss 116:39a41ebb675c 138 * @return Um ponteiro para o pacote disponivel para processamento.
klauss 116:39a41ebb675c 139 *
klauss 116:39a41ebb675c 140 * Exemplo:
klauss 116:39a41ebb675c 141 * @code
klauss 116:39a41ebb675c 142 * ...
klauss 116:39a41ebb675c 143 * int length = 0;
klauss 116:39a41ebb675c 144 * char * eth_msg = call->get_eth_message( &length );
klauss 116:39a41ebb675c 145 * ...
klauss 116:39a41ebb675c 146 * @endcode
klauss 116:39a41ebb675c 147 */
klauss 0:4d17cd9c8f9d 148 char * get_eth_message( int * length );
klauss 69:65665afbad5d 149
klauss 116:39a41ebb675c 150 /**
klauss 116:39a41ebb675c 151 * @Synopsis Retorna uma referência para o buffer da classe, responsavel por armazenar os dados do server para o CBx.
klauss 116:39a41ebb675c 152 *
klauss 116:39a41ebb675c 153 * @return Um ponteiro para o inicio deste buffer.
klauss 116:39a41ebb675c 154 *
klauss 116:39a41ebb675c 155 * Exemplo:
klauss 116:39a41ebb675c 156 * @code
klauss 116:39a41ebb675c 157 * ...
klauss 116:39a41ebb675c 158 * char * buffer = call->get_server2cb_buffer();
klauss 116:39a41ebb675c 159 * ...
klauss 116:39a41ebb675c 160 * @endcode
klauss 116:39a41ebb675c 161 */
klauss 0:4d17cd9c8f9d 162 char * get_server2cb_buffer();
klauss 69:65665afbad5d 163
klauss 116:39a41ebb675c 164 /**
klauss 116:39a41ebb675c 165 * @Synopsis Retorna uma referência para o buffer da classe, responsavel por armazenar os dados do CBx para o server.
klauss 116:39a41ebb675c 166 *
klauss 116:39a41ebb675c 167 * @return Um ponteiro para o inicio deste buffer.
klauss 116:39a41ebb675c 168 *
klauss 116:39a41ebb675c 169 * Exemplo:
klauss 116:39a41ebb675c 170 * @code
klauss 116:39a41ebb675c 171 * ...
klauss 116:39a41ebb675c 172 * uint8_t * buffer = call->get_cb2server_buffer();
klauss 116:39a41ebb675c 173 * ...
klauss 116:39a41ebb675c 174 * @endcode
klauss 116:39a41ebb675c 175 */
klauss 0:4d17cd9c8f9d 176 uint8_t * get_cb2server_buffer();
klauss 69:65665afbad5d 177
klauss 116:39a41ebb675c 178 /**
klauss 116:39a41ebb675c 179 * @Synopsis Retorna o buffer desta classe.
klauss 116:39a41ebb675c 180 *
klauss 116:39a41ebb675c 181 * @return Um ponteiro para o primeiro elemento do buffer desta classe.
klauss 116:39a41ebb675c 182 *
klauss 116:39a41ebb675c 183 * Exemplo:
klauss 116:39a41ebb675c 184 * @code
klauss 116:39a41ebb675c 185 * ...
klauss 116:39a41ebb675c 186 * uint8_t * buffer = call->get_buffer();
klauss 116:39a41ebb675c 187 * ...
klauss 116:39a41ebb675c 188 * @endcode
klauss 116:39a41ebb675c 189 */
klauss 0:4d17cd9c8f9d 190 uint8_t * get_buffer();
klauss 0:4d17cd9c8f9d 191
klauss 116:39a41ebb675c 192 /**
klauss 116:39a41ebb675c 193 * @Synopsis Responsavel por efetivamente montar o pacote que será enviado via rede.
klauss 116:39a41ebb675c 194 *
klauss 116:39a41ebb675c 195 * @param buffer Um ponteiro para o inicio dos dados recebidos do CBx que será encapsulado.
klauss 116:39a41ebb675c 196 *
klauss 116:39a41ebb675c 197 * @return Um ponteiro para o inicio do pacote pronto para o envio.
klauss 116:39a41ebb675c 198 *
klauss 116:39a41ebb675c 199 * Exemplo:
klauss 116:39a41ebb675c 200 * @code
klauss 116:39a41ebb675c 201 * ...
klauss 116:39a41ebb675c 202 * char str_to_server[ 1024 ];
klauss 116:39a41ebb675c 203 * // assumindo que em data_from_cb consta armazenados os dados vindos dos Call_Box
klauss 116:39a41ebb675c 204 * strcpy( str_to_server, build_eth_package( data_from_cb ) );
klauss 116:39a41ebb675c 205 * ...
klauss 116:39a41ebb675c 206 * @endcode
klauss 116:39a41ebb675c 207 */
klauss 0:4d17cd9c8f9d 208 char * build_eth_package( uint8_t * );
klauss 69:65665afbad5d 209
klauss 116:39a41ebb675c 210 /**
klauss 116:39a41ebb675c 211 * @Synopsis Responsavel por enviar efetivamente os dados via eth
klauss 116:39a41ebb675c 212 *
klauss 116:39a41ebb675c 213 * @param buffer Um ponteiro para o inicio dos dados que serão enviados.
klauss 116:39a41ebb675c 214 *
klauss 116:39a41ebb675c 215 * @return O numero de bytes efetivamente enviados.
klauss 116:39a41ebb675c 216 *
klauss 116:39a41ebb675c 217 * Exemplo:
klauss 116:39a41ebb675c 218 * @code
klauss 116:39a41ebb675c 219 * ...
klauss 116:39a41ebb675c 220 * char * pkg = call->build_eth_package( data_from_cb );
klauss 116:39a41ebb675c 221 * //assumindo que os dados vindos do Call_Box estão armazenados em data_from_cb
klauss 116:39a41ebb675c 222 * int sent = call->send_message( pkg );
klauss 116:39a41ebb675c 223 * ...
klauss 116:39a41ebb675c 224 * @endcode
klauss 116:39a41ebb675c 225 */
klauss 0:4d17cd9c8f9d 226 int send_message( char * );
klauss 69:65665afbad5d 227
klauss 116:39a41ebb675c 228 /**
klauss 116:39a41ebb675c 229 * @Synopsis Verifica se esta ligação não esta ultrapassando o tempo permitido.
klauss 116:39a41ebb675c 230 *
klauss 116:39a41ebb675c 231 * @retval True - se o tempo sem trocar dados nesta ligação for maior que __CALL_MAX_IDLE_TIME__.
klauss 116:39a41ebb675c 232 * @retval False - Caso duração de ligação ainda dentro do tempo esperado.
klauss 116:39a41ebb675c 233 *
klauss 116:39a41ebb675c 234 * Exemplo:
klauss 116:39a41ebb675c 235 * @code
klauss 116:39a41ebb675c 236 * ...
klauss 116:39a41ebb675c 237 * printf( "Call não esta recendo dados a mais tempo do que deveria ? %s \n\r", ( call->is_timeout() ) ? "Sim" : "Não" );
klauss 116:39a41ebb675c 238 * ...
klauss 116:39a41ebb675c 239 * @endcode
klauss 116:39a41ebb675c 240 */
klauss 0:4d17cd9c8f9d 241 bool is_timeout( void );
klauss 69:65665afbad5d 242
klauss 116:39a41ebb675c 243 /**
klauss 116:39a41ebb675c 244 * @Synopsis Verifica se o tempo de ligação é menor que o tempo máximo permitido.
klauss 116:39a41ebb675c 245 *
klauss 116:39a41ebb675c 246 * @retval True - Caso o tempo da ligação tenha passado do limite definido em __MAX_CALL_TIME__.
klauss 116:39a41ebb675c 247 * @retval False - caso em que o tempo da ligação atual for menor que o máximo permitido..
klauss 116:39a41ebb675c 248 *
klauss 116:39a41ebb675c 249 * Exemplo:
klauss 116:39a41ebb675c 250 * @code
klauss 116:39a41ebb675c 251 * ...
klauss 116:39a41ebb675c 252 * printf( "Call já deveria ter acabado ? %s \n\r", ( call->is_timeout() ) ? "Sim" : "Não" );
klauss 116:39a41ebb675c 253 * ...
klauss 116:39a41ebb675c 254 * @endcode
klauss 116:39a41ebb675c 255 */
klauss 116:39a41ebb675c 256 bool is_timetofinish ( void );
klauss 92:92df17f538a8 257
klauss 116:39a41ebb675c 258
klauss 116:39a41ebb675c 259 bool cbx_pkg_is_idle ( void );
klauss 116:39a41ebb675c 260
klauss 116:39a41ebb675c 261 uint16_t get_elapsed_time ( void );
klauss 116:39a41ebb675c 262
klauss 116:39a41ebb675c 263 void cbx_pkg_idle_timer_reset ( void );
klauss 116:39a41ebb675c 264 void reconnect ( void );
klauss 116:39a41ebb675c 265 void * check_rtp ( void );
klauss 116:39a41ebb675c 266 void init_cbx_pkg_idle_timer ( void );
klauss 116:39a41ebb675c 267
klauss 116:39a41ebb675c 268 int rtp_print_yourself ( void );
klauss 109:a5b8264ffbbc 269 int print_yourself ( void );
klauss 0:4d17cd9c8f9d 270 };
klauss 0:4d17cd9c8f9d 271 #endif