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

sip.h@69:65665afbad5d, 2014-11-12 (annotated)

Committer:
klauss
Date:
Wed Nov 12 13:25:54 2014 +0000
Revision:
69:65665afbad5d
Parent:
48:195c97f12e8e
Child:
72:895ca792c647
versao em re-valida??o a priori, os dados de audio est?o se perdendo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
klauss 69:65665afbad5d 1 /**
klauss 69:65665afbad5d 2 * @file sip.h
klauss 69:65665afbad5d 3 * @Synopsis Implementa as funções utilizadas no tratamento SIP entre a Header e o server
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 Sip
klauss 69:65665afbad5d 8 */
klauss 0:4d17cd9c8f9d 9 #ifndef __SIP_H__
klauss 0:4d17cd9c8f9d 10 #define __SIP_H__
klauss 0:4d17cd9c8f9d 11
klauss 0:4d17cd9c8f9d 12 #include <stdlib.h>
klauss 0:4d17cd9c8f9d 13 #include <stdint.h>
klauss 0:4d17cd9c8f9d 14 #include <string.h>
klauss 0:4d17cd9c8f9d 15 #include "mbed.h"
klauss 0:4d17cd9c8f9d 16 #include "EthernetInterface.h"
klauss 0:4d17cd9c8f9d 17 #include "call.h"
klauss 0:4d17cd9c8f9d 18 #include "vz_protocol.h"
klauss 0:4d17cd9c8f9d 19 #include "debug.h"
klauss 48:195c97f12e8e 20 #include "configs.h"
klauss 0:4d17cd9c8f9d 21
klauss 3:cd9148672e25 22 #define __INVITE_MAX_WAITING_TIME__ 30
klauss 69:65665afbad5d 23 ///< Indica o timeout de espera de resposta de pedido de ligação para o servidor, após esse tempo responde ligação encerrado para o Call_box
klauss 0:4d17cd9c8f9d 24 #define SIP_MAXFIELDSIZE 256
klauss 69:65665afbad5d 25 ///< Define o tamanho máximo de algumas mensagens usadas na negociação Sip.
klauss 0:4d17cd9c8f9d 26 #define SIP_MAXMSGSIZE 2048
klauss 69:65665afbad5d 27 ///< Define o tamanho máximo das mensagens enviadas, porém, fora de uso atualmente.
klauss 0:4d17cd9c8f9d 28 #define SIP_REGISTER_EXPIRES 120
klauss 69:65665afbad5d 29 ///< Define o timeout do registro no servidor asterisk ( * ), porém, hardcoded atualmente.
klauss 0:4d17cd9c8f9d 30 #define DRAMBASEADDR 0xa0000000
klauss 69:65665afbad5d 31 ///< Indica o inicio do bloco DRAM, porém, fora de uso atualmente.
klauss 0:4d17cd9c8f9d 32 #define SIP_ALLOW "Allow: ACK, BYE, CANCEL, INFO, INVITE, NOTIFY, OPTIONS, REFER"
klauss 0:4d17cd9c8f9d 33 /* #define SIP_ALLOW "Allow: ACK, BYE, CANCEL, INVITE, OPTIONS" */
klauss 69:65665afbad5d 34 ///< String de composição de pacotes enviados pela Header para o *
klauss 0:4d17cd9c8f9d 35
klauss 0:4d17cd9c8f9d 36 #define sip_idle 0
klauss 0:4d17cd9c8f9d 37 #define sip_waiting_trying 1 << 1
klauss 0:4d17cd9c8f9d 38 #define sip_trying 1 << 2
klauss 0:4d17cd9c8f9d 39 #define sip_ringing 1 << 3
klauss 0:4d17cd9c8f9d 40 #define sip_busy 1 << 4
klauss 0:4d17cd9c8f9d 41 #define sip_ok 1 << 5
klauss 0:4d17cd9c8f9d 42 #define sip_on_call 1 << 6
klauss 0:4d17cd9c8f9d 43 #define sip_denied 1 << 7
klauss 0:4d17cd9c8f9d 44
klauss 0:4d17cd9c8f9d 45 class Sip{
klauss 0:4d17cd9c8f9d 46
klauss 0:4d17cd9c8f9d 47 private :
klauss 0:4d17cd9c8f9d 48 int id;
klauss 0:4d17cd9c8f9d 49 char server_ip[20];
klauss 0:4d17cd9c8f9d 50 int server_port;
klauss 0:4d17cd9c8f9d 51 char my_ip[20];
klauss 0:4d17cd9c8f9d 52 int my_port;
klauss 0:4d17cd9c8f9d 53 int my_ext;
klauss 0:4d17cd9c8f9d 54 int my_rtp_port;
klauss 0:4d17cd9c8f9d 55 char my_display[20];
klauss 0:4d17cd9c8f9d 56 int peer_ext;
klauss 0:4d17cd9c8f9d 57 char fill_random_aux[ 65 ];
klauss 0:4d17cd9c8f9d 58 char last_invite_tag[ SIP_MAXFIELDSIZE ];
klauss 0:4d17cd9c8f9d 59 char last_invite_callid[ SIP_MAXFIELDSIZE ];
klauss 0:4d17cd9c8f9d 60 char SVNREV[ 16 ];
klauss 13:ae278302dffe 61 char buffer[ 1024 ];
klauss 0:4d17cd9c8f9d 62 UDPSocket sock;
klauss 0:4d17cd9c8f9d 63 Endpoint sip_server;
klauss 0:4d17cd9c8f9d 64 void __init_sock__( void );
klauss 0:4d17cd9c8f9d 65 void __end_sock__( void );
klauss 48:195c97f12e8e 66 void __reconnect__( void );
klauss 0:4d17cd9c8f9d 67 public :
klauss 69:65665afbad5d 68 uint8_t status; ///< Representa o status do objeto Sip em dado momento.
klauss 69:65665afbad5d 69
klauss 69:65665afbad5d 70 /**
klauss 69:65665afbad5d 71 * @Synopsis Cria um objeto Sip setando ramal e porta e o restando buscando valores default.
klauss 69:65665afbad5d 72 *
klauss 69:65665afbad5d 73 * @param id O identificador do objeto ( por definição de projeto o ramal ( ext ) ).
klauss 69:65665afbad5d 74 * @param my_port A porta do objeto Sip para comunicação com o servidor.
klauss 69:65665afbad5d 75 *
klauss 69:65665afbad5d 76 * Exemplo:
klauss 69:65665afbad5d 77 *
klauss 69:65665afbad5d 78 * @code
klauss 69:65665afbad5d 79 * ...
klauss 69:65665afbad5d 80 * Sip * sip = new Sip( 5002, 5002 );
klauss 69:65665afbad5d 81 * ...
klauss 69:65665afbad5d 82 * @endcode
klauss 69:65665afbad5d 83 */
klauss 0:4d17cd9c8f9d 84 Sip( int id, uint16_t my_port );
klauss 69:65665afbad5d 85
klauss 69:65665afbad5d 86 /**
klauss 69:65665afbad5d 87 * @Synopsis Cria um objeto Sip setando todos os parametros passados.
klauss 69:65665afbad5d 88 *
klauss 69:65665afbad5d 89 * @param server_ip O endereço IP do servidor para o qual será encaminhado pedidos de ligação, registro, etc.
klauss 69:65665afbad5d 90 * @param server_port A porta deste servidor para o qual os pacotes eth serão encaminhados.
klauss 69:65665afbad5d 91 * @param my_ip O endereço IP do objeto Sip para tratativa com o server.
klauss 69:65665afbad5d 92 * @param my_port A porta do objeto Sip para recebimento de pacotes.
klauss 69:65665afbad5d 93 * @param my_ext O identificador do objeto ( por definição de projeto o ramal ( ext ) ).
klauss 69:65665afbad5d 94 * @param peer_ext O ramal do servidor, para onde os pedidos de chamada serão solicitados.
klauss 69:65665afbad5d 95 * @param id O identificador único do objeto Sip, que por convenção, deve ser o mesmo que o ramal.
klauss 69:65665afbad5d 96 *
klauss 69:65665afbad5d 97 * Exemplo:
klauss 69:65665afbad5d 98 *
klauss 69:65665afbad5d 99 * @code
klauss 69:65665afbad5d 100 * Sip * sip = new Sip( "192.168.120.200", 5075, "192.168.120.171", 812, 851, 913, 851 );
klauss 69:65665afbad5d 101 * @endcode
klauss 69:65665afbad5d 102 */
klauss 0:4d17cd9c8f9d 103 Sip( char * server_ip, int server_port, char * my_ip, int my_port, int my_ext, int peer_ext, int id );
klauss 69:65665afbad5d 104
klauss 69:65665afbad5d 105 /**
klauss 69:65665afbad5d 106 * @Synopsis Destroi o objeto Sip
klauss 69:65665afbad5d 107 *
klauss 69:65665afbad5d 108 * Exemplo:
klauss 69:65665afbad5d 109 *
klauss 69:65665afbad5d 110 * @code
klauss 69:65665afbad5d 111 * ...
klauss 69:65665afbad5d 112 * delete( sip );
klauss 69:65665afbad5d 113 * ...
klauss 69:65665afbad5d 114 * @endcode
klauss 69:65665afbad5d 115 */
klauss 0:4d17cd9c8f9d 116 ~Sip();
klauss 69:65665afbad5d 117
klauss 69:65665afbad5d 118 /**
klauss 69:65665afbad5d 119 * @Synopsis Responsavel por montar encaminhar o pacote de registro para o servidor.
klauss 69:65665afbad5d 120 *
klauss 69:65665afbad5d 121 * Exemplo:
klauss 69:65665afbad5d 122 * @code
klauss 69:65665afbad5d 123 * ...
klauss 69:65665afbad5d 124 * sip->registry();
klauss 69:65665afbad5d 125 * ...
klauss 69:65665afbad5d 126 * @endcode
klauss 69:65665afbad5d 127 */
klauss 0:4d17cd9c8f9d 128 void registry( void );
klauss 69:65665afbad5d 129
klauss 69:65665afbad5d 130 /**
klauss 69:65665afbad5d 131 * @Synopsis Efetivamente envia o pedido de ligação para o servidor.
klauss 69:65665afbad5d 132 *
klauss 69:65665afbad5d 133 * @return Uma referência para uma ligação, caso a negociação resulte na aceitação por parte do servidor, NULL, caso contrário.
klauss 69:65665afbad5d 134 * \note Como por conveniência, foi configurado no servidor * que existiria musica de conforto, o que fez com que, assim que é
klauss 69:65665afbad5d 135 * feito o envio do pacote de invite, uma chamada é criada para se trocar os dados desse audio de conforto, ficando a Header na
klauss 69:65665afbad5d 136 * espera do servidor aceitar ou não o pedido de forma definitiva, no caso em que o server dizer "ok", a mesma chamada é retornada,
klauss 69:65665afbad5d 137 * porém, no caso de timeout ou negativa do server, a chamada é destruida e NULL é retornado.
klauss 69:65665afbad5d 138 *
klauss 69:65665afbad5d 139 * Exemplo:
klauss 69:65665afbad5d 140 * @code
klauss 69:65665afbad5d 141 * ...
klauss 69:65665afbad5d 142 * VZ_call * call = sip->invite();
klauss 69:65665afbad5d 143 * ...
klauss 69:65665afbad5d 144 * @endcode
klauss 69:65665afbad5d 145 */
klauss 0:4d17cd9c8f9d 146 VZ_call * invite( void );
klauss 0:4d17cd9c8f9d 147
klauss 69:65665afbad5d 148 /**
klauss 69:65665afbad5d 149 * @Synopsis Monta o pacote para ser encaminhado para o servidor.
klauss 69:65665afbad5d 150 *
klauss 69:65665afbad5d 151 * @param header O pré-pacote contendo o cabeçalho do pacote.
klauss 69:65665afbad5d 152 * @param body O pré-pacote contendo o corpo do pacote.
klauss 69:65665afbad5d 153 * @param pkg Um ponteiro para o pacote montado no formado header + "Content-Length: " + strlen( body ) + body;
klauss 69:65665afbad5d 154 *
klauss 69:65665afbad5d 155 * @return O pacote montado, o mesmo endereço apontado por pkg.
klauss 69:65665afbad5d 156 *
klauss 69:65665afbad5d 157 * Exemplo:
klauss 69:65665afbad5d 158 * @code
klauss 69:65665afbad5d 159 * ...
klauss 69:65665afbad5d 160 * #define SIP_MAXMSGSIZE 2048;
klauss 69:65665afbad5d 161 * char pkg[ SIP_MAXMSGSIZE ];
klauss 69:65665afbad5d 162 * char header[ SIP_MAXMSGSIZE ];
klauss 69:65665afbad5d 163 * char bod y[ SIP_MAXMSGSIZE ];
klauss 69:65665afbad5d 164 * pkg = sip->make_content_length( header,body, pkg );
klauss 69:65665afbad5d 165 * ...
klauss 69:65665afbad5d 166 * @endcode
klauss 69:65665afbad5d 167 */
klauss 0:4d17cd9c8f9d 168 char * make_content_length( char * header, char * body, char * pkg );
klauss 69:65665afbad5d 169
klauss 69:65665afbad5d 170 /**
klauss 69:65665afbad5d 171 * @Synopsis Função que decodifiica o codigo recebido em um dado pocote Sip.
klauss 69:65665afbad5d 172 *
klauss 69:65665afbad5d 173 * @param s O pacote que se deseja decodificar.
klauss 69:65665afbad5d 174 *
klauss 69:65665afbad5d 175 * @return O código identificado no pacote recebido.
klauss 69:65665afbad5d 176 *
klauss 69:65665afbad5d 177 * \note Não esta em uso atualmente.
klauss 69:65665afbad5d 178 *
klauss 69:65665afbad5d 179 * Exemplo:
klauss 69:65665afbad5d 180 * @code
klauss 69:65665afbad5d 181 * ...
klauss 69:65665afbad5d 182 * char buffer[ 1024 ];
klauss 69:65665afbad5d 183 * //assumindo que em buffer será armazenado o valor do pacote que será analisado para saber o codigo de retorno.
klauss 69:65665afbad5d 184 * int code = sip->get_return_code( buffer );
klauss 69:65665afbad5d 185 * ...
klauss 69:65665afbad5d 186 * @endcode
klauss 69:65665afbad5d 187 */
klauss 0:4d17cd9c8f9d 188 int get_return_code( char * s );
klauss 69:65665afbad5d 189
klauss 69:65665afbad5d 190 /**
klauss 69:65665afbad5d 191 * @Synopsis Gera um nro de cseq para preenchimento no cabeçalho dos pacotes Sip.
klauss 69:65665afbad5d 192 *
klauss 69:65665afbad5d 193 * @return O numero gerado.
klauss 69:65665afbad5d 194 *
klauss 69:65665afbad5d 195 * Exemplo:
klauss 69:65665afbad5d 196 * @code
klauss 69:65665afbad5d 197 * ...
klauss 69:65665afbad5d 198 * int cseq = sip->get_cseq();
klauss 69:65665afbad5d 199 * ...
klauss 69:65665afbad5d 200 * @endcode
klauss 69:65665afbad5d 201 */
klauss 0:4d17cd9c8f9d 202 int get_cseq( void );
klauss 69:65665afbad5d 203
klauss 69:65665afbad5d 204 /**
klauss 69:65665afbad5d 205 * @Synopsis Obtem o id( ramal ) do objeto.
klauss 69:65665afbad5d 206 *
klauss 69:65665afbad5d 207 * @return Retorna o id( ramal ) do objeto.
klauss 69:65665afbad5d 208 *
klauss 69:65665afbad5d 209 * Exemplo:
klauss 69:65665afbad5d 210 * @code
klauss 69:65665afbad5d 211 * ...
klauss 69:65665afbad5d 212 * int ext = sip->get_id();
klauss 69:65665afbad5d 213 * ...
klauss 69:65665afbad5d 214 * @endcode
klauss 69:65665afbad5d 215 */
klauss 0:4d17cd9c8f9d 216 int get_id( void );
klauss 0:4d17cd9c8f9d 217
klauss 69:65665afbad5d 218 /**
klauss 69:65665afbad5d 219 * @Synopsis Obtem a porta rtp na qual a Header ira encaminhar e receber dados do Server.
klauss 69:65665afbad5d 220 *
klauss 69:65665afbad5d 221 * @return O numero da porta RTP usado pelo objeto Sip durante uma determinada chamada.
klauss 69:65665afbad5d 222 *
klauss 69:65665afbad5d 223 * Exemplo:
klauss 69:65665afbad5d 224 * @code
klauss 69:65665afbad5d 225 * ...
klauss 69:65665afbad5d 226 * int rtp_port = sip->get_my_rtp_port();
klauss 69:65665afbad5d 227 * ...
klauss 69:65665afbad5d 228 * @endcode
klauss 69:65665afbad5d 229 */
klauss 69:65665afbad5d 230 int get_my_rtp_port( void );
klauss 69:65665afbad5d 231
klauss 69:65665afbad5d 232 /**
klauss 69:65665afbad5d 233 * @Synopsis Efetivamente cria o pacote de registro.
klauss 69:65665afbad5d 234 *
klauss 69:65665afbad5d 235 * @param buffer Recebe um ponteiro para uma região de memória onde irá escrever o pacote de registro.
klauss 69:65665afbad5d 236 *
klauss 69:65665afbad5d 237 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 238 */
klauss 0:4d17cd9c8f9d 239 char * build_registry_package( char * buffer );
klauss 69:65665afbad5d 240
klauss 69:65665afbad5d 241 /**
klauss 69:65665afbad5d 242 * @Synopsis Efetivamente cria um pacote para desregistrar o objeto no server.
klauss 69:65665afbad5d 243 *
klauss 69:65665afbad5d 244 * @param buffer Recebe um ponteiro para uma região de memória onde irá escrever o pacote de desregistro.
klauss 69:65665afbad5d 245 *
klauss 69:65665afbad5d 246 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 247 */
klauss 69:65665afbad5d 248 char * build_unregistry_package( char * buffer );
klauss 69:65665afbad5d 249
klauss 69:65665afbad5d 250 /**
klauss 69:65665afbad5d 251 * @Synopsis Efetivamente cria um pacote de invite ( pedido de chamada ) do Call_box para o server.
klauss 69:65665afbad5d 252 *
klauss 69:65665afbad5d 253 * @param s Um ponteiro para uma região de memória onde irá escrever o pacote de invite.
klauss 69:65665afbad5d 254 * @param callbox_string Uma string de identifcação do Call_box.
klauss 69:65665afbad5d 255 * @param cseq O nro de cseq que irá ser colocado no pacote.
klauss 69:65665afbad5d 256 *
klauss 69:65665afbad5d 257 * @return
klauss 69:65665afbad5d 258 */
klauss 69:65665afbad5d 259 char * build_invite_package( char * s, char * callbox_string, int * cseq );
klauss 69:65665afbad5d 260
klauss 69:65665afbad5d 261 /**
klauss 69:65665afbad5d 262 * @Synopsis Efetivamente cria um pacote de "despedida" para o servidor, usado para encerrar ligações.
klauss 69:65665afbad5d 263 *
klauss 69:65665afbad5d 264 * @param buffer Um ponteiro para uma região de memória onde irá escrever o pacote de bye.
klauss 69:65665afbad5d 265 *
klauss 69:65665afbad5d 266 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 267 */
klauss 69:65665afbad5d 268 char * build_bye_package( char * buffer );
klauss 69:65665afbad5d 269
klauss 69:65665afbad5d 270 /**
klauss 69:65665afbad5d 271 * @Synopsis Efetivamente cria um pacote de ack de mensagem recebida.
klauss 69:65665afbad5d 272 *
klauss 69:65665afbad5d 273 * @param buffer Um ponteiro para a posição de memória onde será criado o pacote ack
klauss 69:65665afbad5d 274 * @param orig O pacote original recebido do servidor, serve como referência na criação do pacote de resposta,
klauss 69:65665afbad5d 275 *
klauss 69:65665afbad5d 276 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 277 */
klauss 69:65665afbad5d 278 char * build_ack_package( char * buffer, unsigned char * orig );
klauss 69:65665afbad5d 279
klauss 69:65665afbad5d 280 /**
klauss 69:65665afbad5d 281 * @Synopsis
klauss 69:65665afbad5d 282 *
klauss 69:65665afbad5d 283 * @param s Um ponteiro para a posição de memória onde será montado o pacote.
klauss 69:65665afbad5d 284 * @param orig O pacote recebido do servidor, serve como referência para criação da resposta.
klauss 69:65665afbad5d 285 * @param tag A tag que será usada no pacote de resposta.
klauss 69:65665afbad5d 286 *
klauss 69:65665afbad5d 287 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 288 */
klauss 69:65665afbad5d 289 char * build_generic_reply_package( char * s, unsigned char * orig, char * tag );
klauss 69:65665afbad5d 290
klauss 69:65665afbad5d 291 /**
klauss 69:65665afbad5d 292 * @Synopsis Cria um pacote genérico de resposta.
klauss 69:65665afbad5d 293 *
klauss 69:65665afbad5d 294 * @param buffer Um ponteiro para a posição de memória onde será montado o pacote.
klauss 69:65665afbad5d 295 * @param orig
klauss 69:65665afbad5d 296 *
klauss 69:65665afbad5d 297 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 298 */
klauss 69:65665afbad5d 299 char * build_trying_package( char * buffer, unsigned char * orig );
klauss 69:65665afbad5d 300
klauss 69:65665afbad5d 301 /**
klauss 69:65665afbad5d 302 * @Synopsis
klauss 69:65665afbad5d 303 *
klauss 69:65665afbad5d 304 * @param buffer Um ponteiro para a posição de memória onde será montado o pacote.
klauss 69:65665afbad5d 305 * @param orig O pacote de origem, serve como referência na criação do pacote.
klauss 69:65665afbad5d 306 *
klauss 69:65665afbad5d 307 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 308 */
klauss 69:65665afbad5d 309 char * build_busy_package( char * buffer, unsigned char * orig );
klauss 69:65665afbad5d 310
klauss 69:65665afbad5d 311 /**
klauss 69:65665afbad5d 312 * @Synopsis
klauss 69:65665afbad5d 313 *
klauss 69:65665afbad5d 314 * @param buffer Um ponteiro para a posição de memória onde será montado o pacote.
klauss 69:65665afbad5d 315 * @param orig O pacote de origem, serve como referência na criação do pacote.
klauss 69:65665afbad5d 316 *
klauss 69:65665afbad5d 317 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 318 */
klauss 69:65665afbad5d 319 char * build_reply_package( char * buffer, unsigned char * orig );
klauss 69:65665afbad5d 320
klauss 69:65665afbad5d 321 /**
klauss 69:65665afbad5d 322 * @Synopsis Preenche de forma aleatótia 16 posições de memória.
klauss 69:65665afbad5d 323 *
klauss 69:65665afbad5d 324 * @param buffer Um ponteiro que aponta para o inicio das 16 ( bytes ) posições que serão preenchidas.
klauss 69:65665afbad5d 325 *
klauss 69:65665afbad5d 326 * @return Retorna um ponteiro para os dados preenchidos ( mesmo endereço passado como parâmetro.
klauss 69:65665afbad5d 327 */
klauss 0:4d17cd9c8f9d 328 char * fill_random16h(char * buffer );
klauss 69:65665afbad5d 329
klauss 69:65665afbad5d 330 /**
klauss 69:65665afbad5d 331 * @Synopsis Preenche de forma aleatótia dados.
klauss 69:65665afbad5d 332 *
klauss 69:65665afbad5d 333 * @param buffer Um ponteiro que aponta para o inicio das posições a serem preenchidas.
klauss 69:65665afbad5d 334 * @param size A quantidade ( em posições ) que serão preenchidas.
klauss 69:65665afbad5d 335 *
klauss 69:65665afbad5d 336 * @return Um ponteiro para o inicio das posições preenchidas ( mesmo endereço do parâmetro passado ).
klauss 69:65665afbad5d 337 */
klauss 69:65665afbad5d 338 char * fill_random( char * buffer, int size );
klauss 69:65665afbad5d 339
klauss 69:65665afbad5d 340 /**
klauss 69:65665afbad5d 341 * @Synopsis Gera aleatóriamente a porta RTP de onde os dados de audiao serão enviados da Header.
klauss 69:65665afbad5d 342 *
klauss 69:65665afbad5d 343 * @return O nro da porta que será usada na negociação Sip.
klauss 69:65665afbad5d 344 */
klauss 69:65665afbad5d 345 int fill_random_rtp_port( void );
klauss 0:4d17cd9c8f9d 346
klauss 69:65665afbad5d 347 /**
klauss 69:65665afbad5d 348 * @Synopsis Dado um pacote recebido do server, decodifica o nro cseq.
klauss 69:65665afbad5d 349 *
klauss 69:65665afbad5d 350 * @param package O pacote do qual se tem interesse em decodificar.
klauss 69:65665afbad5d 351 * @param cseq Um ponteiro que aponta para a posição de memória onde será escrito o cseq.
klauss 69:65665afbad5d 352 *
klauss 69:65665afbad5d 353 * @return Um ponteiro para o inicio da posição de memória que contem o cseq ( mesma passada como parâmetro ).
klauss 69:65665afbad5d 354 */
klauss 0:4d17cd9c8f9d 355 char * decode_cseq(unsigned char * package, char * cseq);
klauss 69:65665afbad5d 356
klauss 69:65665afbad5d 357 /**
klauss 69:65665afbad5d 358 * @Synopsis Dado um pacote recebido do server, decodifica o branch.
klauss 69:65665afbad5d 359 *
klauss 69:65665afbad5d 360 * @param package Um ponteiro para o pacote recebido do servidor o qual temos interesse em decodificar.
klauss 69:65665afbad5d 361 * @param branch Um ponteiro para o inicio da posição de memória onde escreveremos o branch
klauss 69:65665afbad5d 362 *
klauss 69:65665afbad5d 363 * @return Um ponteiro para o inicio da posição de memória onde escrevemos o branch ( mesma passada como parâmentro ).
klauss 69:65665afbad5d 364 */
klauss 69:65665afbad5d 365 char * decode_branch( unsigned char * package, char * branch );
klauss 69:65665afbad5d 366
klauss 69:65665afbad5d 367 /**
klauss 69:65665afbad5d 368 * @Synopsis Busca por uma determinado substring em um pacote recebido do servidor. Copiando o restando desse pacote para
klauss 69:65665afbad5d 369 * uma posição de interesse.
klauss 69:65665afbad5d 370 *
klauss 69:65665afbad5d 371 * @param package O pacote que se tem interesse em decodificar.
klauss 69:65665afbad5d 372 * @param tag A substring que a função ira buscar em package.
klauss 69:65665afbad5d 373 * @param out A região de memória para onde o restante dos dados contidos em package será copiado, caso a substring seja
klauss 69:65665afbad5d 374 * encontrada.
klauss 69:65665afbad5d 375 *
klauss 69:65665afbad5d 376 * @return 1, caso tenha encontrado a string tag contida no package, copia o restando do conteudo de package para out e retorna 1,
klauss 69:65665afbad5d 377 * retorna 0 caso a substring não seja encontrada.
klauss 69:65665afbad5d 378 */
klauss 69:65665afbad5d 379 int decode_gettag( unsigned char * package, char * tag, char * out );
klauss 69:65665afbad5d 380
klauss 69:65665afbad5d 381 /**
klauss 69:65665afbad5d 382 * @Synopsis Esta função deveria mudar a conexão com o servidor, caso o mesmo caia. Porém, não em uso.
klauss 69:65665afbad5d 383 */
klauss 69:65665afbad5d 384 void change_sip_server();
klauss 0:4d17cd9c8f9d 385
klauss 69:65665afbad5d 386 /**
klauss 69:65665afbad5d 387 * @Synopsis Obtém o nro de IP do servidor que irá sediar os pedidos de ligações e demais tratamentos, em caso do primeiro
klauss 69:65665afbad5d 388 * server vir a cair, porém, função não em uso.
klauss 69:65665afbad5d 389 *
klauss 69:65665afbad5d 390 * @param server_ip Um ponteiro que aponta para a posição de memória onde será escrito o valor do IP do servidor.
klauss 69:65665afbad5d 391 *
klauss 69:65665afbad5d 392 * @return Um ponteiro para o inicio do endereço IP do server ( mesmo passado como parametro )
klauss 69:65665afbad5d 393 *
klauss 69:65665afbad5d 394 * Exemplo:
klauss 69:65665afbad5d 395 * @code
klauss 69:65665afbad5d 396 * ...
klauss 69:65665afbad5d 397 * char new_ip[ 16 ];
klauss 69:65665afbad5d 398 * strcpy( new_ip, sip->get_next_server_ip() );
klauss 69:65665afbad5d 399 * ...
klauss 69:65665afbad5d 400 * @endcode
klauss 69:65665afbad5d 401 */
klauss 69:65665afbad5d 402 char * get_next_server_ip( char *server_ip );
klauss 69:65665afbad5d 403
klauss 69:65665afbad5d 404 /**
klauss 69:65665afbad5d 405 * @Synopsis Obtém o nro de IP do servidor que irá sediar os pedidos de ligações e demais tratamentos, em caso do primeiro
klauss 69:65665afbad5d 406 * server vir a cair. Porém, função não em uso.
klauss 69:65665afbad5d 407 *
klauss 69:65665afbad5d 408 * @return O nro da porta de comunicação com o próximo server.
klauss 69:65665afbad5d 409 *
klauss 69:65665afbad5d 410 * Exemplo:
klauss 69:65665afbad5d 411 * @code
klauss 69:65665afbad5d 412 * ...
klauss 69:65665afbad5d 413 * int port = sip->get_next_server_port();
klauss 69:65665afbad5d 414 * ...
klauss 69:65665afbad5d 415 * @endcode
klauss 69:65665afbad5d 416 */
klauss 69:65665afbad5d 417 int get_next_server_port();
klauss 69:65665afbad5d 418
klauss 69:65665afbad5d 419
klauss 69:65665afbad5d 420 /**
klauss 69:65665afbad5d 421 * @Synopsis Obtém o nro do ramal de comunicação com o proximo servidor Sip, nos casos em que o primeiro servidor passar por
klauss 69:65665afbad5d 422 * instabilidade, atualmente, não em uso.
klauss 69:65665afbad5d 423 *
klauss 69:65665afbad5d 424 * @return O valor do ramal de comunicação com o promixo servidor.
klauss 69:65665afbad5d 425 *
klauss 69:65665afbad5d 426 * Exemplo:
klauss 69:65665afbad5d 427 * @code
klauss 69:65665afbad5d 428 * ...
klauss 69:65665afbad5d 429 * int next_server_ext = sip->get_next_server_ext();
klauss 69:65665afbad5d 430 * ...
klauss 69:65665afbad5d 431 * @endcode
klauss 69:65665afbad5d 432 */
klauss 69:65665afbad5d 433 int get_next_server_ext();
klauss 0:4d17cd9c8f9d 434
klauss 69:65665afbad5d 435 /**
klauss 69:65665afbad5d 436 * @Synopsis Recebe um ramal de comunicação com o servidor, realizando solicitações futuras com esse ramal.
klauss 69:65665afbad5d 437 *
klauss 69:65665afbad5d 438 * @param new_server_ext O Ramal do servidor que será associado ao objeto Sip
klauss 69:65665afbad5d 439 *
klauss 69:65665afbad5d 440 * Exemplo:
klauss 69:65665afbad5d 441 * @code
klauss 69:65665afbad5d 442 * ...
klauss 69:65665afbad5d 443 * sip->set_server_ext( 913 );
klauss 69:65665afbad5d 444 * ...
klauss 69:65665afbad5d 445 * @endcode
klauss 69:65665afbad5d 446 */
klauss 69:65665afbad5d 447 void set_server_ext( int new_server_ext );
klauss 69:65665afbad5d 448
klauss 69:65665afbad5d 449 /**
klauss 69:65665afbad5d 450 * @Synopsis Recebe uma porta de comunicação com o servidor, setando e realizando comunicaões entre Header-Server atraves
klauss 69:65665afbad5d 451 * dessa porta
klauss 69:65665afbad5d 452 *
klauss 69:65665afbad5d 453 * @param new_server_port A porta do servidor que será associada ao objeto Sip
klauss 69:65665afbad5d 454 *
klauss 69:65665afbad5d 455 * Exemplo:
klauss 69:65665afbad5d 456 * @code
klauss 69:65665afbad5d 457 * ...
klauss 69:65665afbad5d 458 * sip->set_server_port( 818 );
klauss 69:65665afbad5d 459 * ...
klauss 69:65665afbad5d 460 * @endcode
klauss 69:65665afbad5d 461 */
klauss 69:65665afbad5d 462 void set_server_port( int new_server_port );
klauss 69:65665afbad5d 463
klauss 69:65665afbad5d 464 /**
klauss 69:65665afbad5d 465 * @Synopsis Seta ramal de comunicação Sip da Header.
klauss 69:65665afbad5d 466 *
klauss 69:65665afbad5d 467 * @param ext Ramal que será associado ao objeto Sip criado.
klauss 69:65665afbad5d 468 *
klauss 69:65665afbad5d 469 * Exemplo:
klauss 69:65665afbad5d 470 * @code
klauss 69:65665afbad5d 471 * ...
klauss 69:65665afbad5d 472 * sip->set_ext( 818 );
klauss 69:65665afbad5d 473 * ...
klauss 69:65665afbad5d 474 * @endcode
klauss 69:65665afbad5d 475 *
klauss 69:65665afbad5d 476 */
klauss 69:65665afbad5d 477 void set_ext( int ext );
klauss 0:4d17cd9c8f9d 478
klauss 69:65665afbad5d 479 /**
klauss 69:65665afbad5d 480 * @Synopsis Seta a porta de comunicação Sip da Header.
klauss 69:65665afbad5d 481 *
klauss 69:65665afbad5d 482 * @param port Porta que será associada ao objeto Sip criado.
klauss 69:65665afbad5d 483 *
klauss 69:65665afbad5d 484 * Exemplo:
klauss 69:65665afbad5d 485 * @code
klauss 69:65665afbad5d 486 * ...
klauss 69:65665afbad5d 487 * sipset_port( 1028 );
klauss 69:65665afbad5d 488 * ...
klauss 69:65665afbad5d 489 * @endcode
klauss 69:65665afbad5d 490 *
klauss 69:65665afbad5d 491 *
klauss 69:65665afbad5d 492 */
klauss 69:65665afbad5d 493 void set_port( int port );
klauss 69:65665afbad5d 494
klauss 69:65665afbad5d 495 /**
klauss 69:65665afbad5d 496 * @Synopsis Seta o valor passado como parâmetro como sendo o endeço IP de contato do servidor.
klauss 69:65665afbad5d 497 *
klauss 69:65665afbad5d 498 * @param new_server_ip O endereço que será associado ao objeto Sip.
klauss 69:65665afbad5d 499 *
klauss 69:65665afbad5d 500 * Exemplo:
klauss 69:65665afbad5d 501 * @code
klauss 69:65665afbad5d 502 * ...
klauss 69:65665afbad5d 503 * sip->set_server_ip( "192.168.120.8" );
klauss 69:65665afbad5d 504 * ...
klauss 69:65665afbad5d 505 * @endcode
klauss 69:65665afbad5d 506 */
klauss 69:65665afbad5d 507 void set_server_ip( char * new_server_ip );
klauss 0:4d17cd9c8f9d 508
klauss 69:65665afbad5d 509 /**
klauss 69:65665afbad5d 510 * @Synopsis Responsavel por ouvir o servidor *, verificando se o mesmo esta mandando alguma mensagem, seja Sip ou qualquer outra
klauss 69:65665afbad5d 511 * nas portas acordadas.
klauss 69:65665afbad5d 512 *
klauss 69:65665afbad5d 513 * @return 0, sucesso na execução, sem pendencia, ou retorna um nro maior que zero, representando o nro do ramal cuja ligação deve
klauss 69:65665afbad5d 514 * ser encerrada.
klauss 69:65665afbad5d 515 */
klauss 69:65665afbad5d 516 int listen_SIP_server( void );
klauss 69:65665afbad5d 517
klauss 69:65665afbad5d 518 /**
klauss 69:65665afbad5d 519 * @Synopsis Envia efetivamente o pacote de despedita com Call_box pro servidor
klauss 69:65665afbad5d 520 *
klauss 69:65665afbad5d 521 * Exemplo:
klauss 69:65665afbad5d 522 * @code
klauss 69:65665afbad5d 523 * ...
klauss 69:65665afbad5d 524 * sip->send_bye();
klauss 69:65665afbad5d 525 * ...
klauss 69:65665afbad5d 526 * @endcode
klauss 69:65665afbad5d 527 */
klauss 69:65665afbad5d 528 void send_bye( void );
klauss 69:65665afbad5d 529
klauss 69:65665afbad5d 530 /**
klauss 69:65665afbad5d 531 * @Synopsis Esta função Envia efetivamente o pacote de "desregistro" para o servidor.
klauss 69:65665afbad5d 532 *
klauss 69:65665afbad5d 533 * Exemplo:
klauss 69:65665afbad5d 534 * @code
klauss 69:65665afbad5d 535 * ...
klauss 69:65665afbad5d 536 * sip->send_unregistry_pkg();
klauss 69:65665afbad5d 537 * ...
klauss 69:65665afbad5d 538 * @endcode
klauss 69:65665afbad5d 539 *
klauss 69:65665afbad5d 540 */
klauss 69:65665afbad5d 541 void send_unregistry_pkg( void );
klauss 69:65665afbad5d 542
klauss 69:65665afbad5d 543 /**
klauss 69:65665afbad5d 544 * @Synopsis
klauss 69:65665afbad5d 545 *
klauss 69:65665afbad5d 546 * @return
klauss 69:65665afbad5d 547 */
klauss 69:65665afbad5d 548 uint8_t get_status( void );
klauss 0:4d17cd9c8f9d 549 };
klauss 0:4d17cd9c8f9d 550 #endif