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