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@121:ee02790d00b7, 2015-05-08 (annotated)

Committer:
klauss
Date:
Fri May 08 04:15:23 2015 +0000
Revision:
121:ee02790d00b7
Parent:
119:ee6a53069455
Child:
132:05cd37f7e007
compiling

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