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@119:ee6a53069455, 2015-04-30 (annotated)

Committer:
klauss
Date:
Thu Apr 30 15:42:41 2015 +0000
Revision:
119:ee6a53069455
Parent:
114:472502b31a12
Child:
121:ee02790d00b7
funcionalidade - clock "ogro" - implementada

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 74:81c47fff88a5 19 #include "parallelcpld.h" // need for send confort song to CBx
klauss 0:4d17cd9c8f9d 20 #include "debug.h"
klauss 85:b6f2dc1d0f4f 21 #include "shared_variables.h"
klauss 0:4d17cd9c8f9d 22
klauss 119:ee6a53069455 23 const uint8_t INVITE_MAX_WAITING_TIME = 45;
klauss 69:65665afbad5d 24 ///< 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 119:ee6a53069455 25 const uint16_t SIP_MAXFIELDSIZE = 256;
klauss 69:65665afbad5d 26 ///< Define o tamanho máximo de algumas mensagens usadas na negociação Sip.
klauss 119:ee6a53069455 27 const uint16_t SIP_MAXMSGSIZE = 2048;
klauss 69:65665afbad5d 28 ///< Define o tamanho máximo das mensagens enviadas, porém, fora de uso atualmente.
klauss 119:ee6a53069455 29 const uint8_t SIP_REGISTER_EXPIRES = 120;
klauss 69:65665afbad5d 30 ///< Define o timeout do registro no servidor asterisk ( * ), porém, hardcoded atualmente.
klauss 119:ee6a53069455 31 const uint32_t DRAMBASEADDR = 0xa0000000;
klauss 69:65665afbad5d 32 ///< Indica o inicio do bloco DRAM, porém, fora de uso atualmente.
klauss 119:ee6a53069455 33 static const char SIP_ALLOW[] = "Allow: ACK, BYE, CANCEL, INFO, INVITE, NOTIFY, OPTIONS, REFER";
klauss 69:65665afbad5d 34 ///< String de composição de pacotes enviados pela Header para o *
klauss 0:4d17cd9c8f9d 35
klauss 119:ee6a53069455 36 static char fill_random_aux[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789pP";
klauss 119:ee6a53069455 37
klauss 119:ee6a53069455 38 const uint8_t sip_idle = 0;
klauss 119:ee6a53069455 39 const uint8_t sip_waiting_trying = 1 << 1;
klauss 119:ee6a53069455 40 const uint8_t sip_trying = 1 << 2;
klauss 119:ee6a53069455 41 const uint8_t sip_ringing = 1 << 3;
klauss 119:ee6a53069455 42 const uint8_t sip_busy = 1 << 4;
klauss 119:ee6a53069455 43 const uint8_t sip_ok = 1 << 5; // don't used
klauss 119:ee6a53069455 44 const uint8_t sip_on_call = 1 << 6;
klauss 119:ee6a53069455 45 const uint8_t sip_denied = 1 << 7;
klauss 0:4d17cd9c8f9d 46
klauss 0:4d17cd9c8f9d 47 class Sip{
klauss 0:4d17cd9c8f9d 48
klauss 0:4d17cd9c8f9d 49 private :
klauss 119:ee6a53069455 50 int my_ext;
klauss 119:ee6a53069455 51 int my_port;
klauss 119:ee6a53069455 52 int peer_ext;
klauss 119:ee6a53069455 53 int server_port;
klauss 119:ee6a53069455 54 int my_rtp_port;
klauss 119:ee6a53069455 55
klauss 119:ee6a53069455 56 int listen_SIP_server_return;
klauss 119:ee6a53069455 57 int last_cseq;
klauss 119:ee6a53069455 58
klauss 119:ee6a53069455 59 char server_ip[ 20 ];
klauss 119:ee6a53069455 60 char my_ip[ 20 ];
klauss 119:ee6a53069455 61 char my_display[ 20 ];
klauss 119:ee6a53069455 62 char SVNREV[ 16 ];
klauss 119:ee6a53069455 63 char buffer[ 1024 ];
klauss 0:4d17cd9c8f9d 64 char last_invite_tag[ SIP_MAXFIELDSIZE ];
klauss 0:4d17cd9c8f9d 65 char last_invite_callid[ SIP_MAXFIELDSIZE ];
klauss 119:ee6a53069455 66 char last_branch[ SIP_MAXFIELDSIZE ];
klauss 119:ee6a53069455 67
klauss 0:4d17cd9c8f9d 68 void __init_sock__( void );
klauss 0:4d17cd9c8f9d 69 void __end_sock__( void );
klauss 48:195c97f12e8e 70 void __reconnect__( void );
klauss 119:ee6a53069455 71
klauss 119:ee6a53069455 72 bool waiting;
klauss 119:ee6a53069455 73
klauss 119:ee6a53069455 74 UDPSocket sock;
klauss 119:ee6a53069455 75
klauss 119:ee6a53069455 76 Endpoint sip_server;
klauss 119:ee6a53069455 77
klauss 91:c2a86b1f8aaa 78 VZ_call * call;
klauss 119:ee6a53069455 79
klauss 91:c2a86b1f8aaa 80 Timer invite_timer;
klauss 119:ee6a53069455 81
klauss 0:4d17cd9c8f9d 82 public :
klauss 69:65665afbad5d 83 uint8_t status; ///< Representa o status do objeto Sip em dado momento.
klauss 69:65665afbad5d 84
klauss 69:65665afbad5d 85 /**
klauss 69:65665afbad5d 86 * @Synopsis Cria um objeto Sip setando ramal e porta e o restando buscando valores default.
klauss 69:65665afbad5d 87 *
klauss 69:65665afbad5d 88 * @param id O identificador do objeto ( por definição de projeto o ramal ( ext ) ).
klauss 69:65665afbad5d 89 * @param my_port A porta do objeto Sip para comunicação com o servidor.
klauss 69:65665afbad5d 90 *
klauss 69:65665afbad5d 91 * Exemplo:
klauss 69:65665afbad5d 92 *
klauss 69:65665afbad5d 93 * @code
klauss 69:65665afbad5d 94 * ...
klauss 69:65665afbad5d 95 * Sip * sip = new Sip( 5002, 5002 );
klauss 69:65665afbad5d 96 * ...
klauss 69:65665afbad5d 97 * @endcode
klauss 69:65665afbad5d 98 */
klauss 119:ee6a53069455 99 Sip( int my_ext, uint16_t my_port );
klauss 114:472502b31a12 100
klauss 114:472502b31a12 101 /**
klauss 69:65665afbad5d 102 * @Synopsis Destroi o objeto Sip
klauss 69:65665afbad5d 103 *
klauss 69:65665afbad5d 104 * Exemplo:
klauss 69:65665afbad5d 105 *
klauss 69:65665afbad5d 106 * @code
klauss 69:65665afbad5d 107 * ...
klauss 69:65665afbad5d 108 * delete( sip );
klauss 69:65665afbad5d 109 * ...
klauss 69:65665afbad5d 110 * @endcode
klauss 69:65665afbad5d 111 */
klauss 0:4d17cd9c8f9d 112 ~Sip();
klauss 69:65665afbad5d 113
klauss 69:65665afbad5d 114 /**
klauss 69:65665afbad5d 115 * @Synopsis Responsavel por montar encaminhar o pacote de registro para o servidor.
klauss 69:65665afbad5d 116 *
klauss 69:65665afbad5d 117 * Exemplo:
klauss 69:65665afbad5d 118 * @code
klauss 69:65665afbad5d 119 * ...
klauss 69:65665afbad5d 120 * sip->registry();
klauss 69:65665afbad5d 121 * ...
klauss 69:65665afbad5d 122 * @endcode
klauss 69:65665afbad5d 123 */
klauss 78:1353744f01e1 124 int registry( void );
klauss 69:65665afbad5d 125
klauss 69:65665afbad5d 126 /**
klauss 69:65665afbad5d 127 * @Synopsis Efetivamente envia o pedido de ligação para o servidor.
klauss 69:65665afbad5d 128 *
klauss 69:65665afbad5d 129 * @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 130 * \note Como por conveniência, foi configurado no servidor * que existiria musica de conforto, o que fez com que, assim que é
klauss 69:65665afbad5d 131 * 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 132 * 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 133 * porém, no caso de timeout ou negativa do server, a chamada é destruida e NULL é retornado.
klauss 69:65665afbad5d 134 *
klauss 69:65665afbad5d 135 * Exemplo:
klauss 69:65665afbad5d 136 * @code
klauss 69:65665afbad5d 137 * ...
klauss 69:65665afbad5d 138 * VZ_call * call = sip->invite();
klauss 69:65665afbad5d 139 * ...
klauss 69:65665afbad5d 140 * @endcode
klauss 69:65665afbad5d 141 */
klauss 0:4d17cd9c8f9d 142 VZ_call * invite( void );
klauss 0:4d17cd9c8f9d 143
klauss 69:65665afbad5d 144 /**
klauss 69:65665afbad5d 145 * @Synopsis Monta o pacote para ser encaminhado para o servidor.
klauss 69:65665afbad5d 146 *
klauss 69:65665afbad5d 147 * @param header O pré-pacote contendo o cabeçalho do pacote.
klauss 69:65665afbad5d 148 * @param body O pré-pacote contendo o corpo do pacote.
klauss 69:65665afbad5d 149 * @param pkg Um ponteiro para o pacote montado no formado header + "Content-Length: " + strlen( body ) + body;
klauss 69:65665afbad5d 150 *
klauss 69:65665afbad5d 151 * @return O pacote montado, o mesmo endereço apontado por pkg.
klauss 69:65665afbad5d 152 *
klauss 69:65665afbad5d 153 * Exemplo:
klauss 69:65665afbad5d 154 * @code
klauss 69:65665afbad5d 155 * ...
klauss 69:65665afbad5d 156 * #define SIP_MAXMSGSIZE 2048;
klauss 69:65665afbad5d 157 * char pkg[ SIP_MAXMSGSIZE ];
klauss 69:65665afbad5d 158 * char header[ SIP_MAXMSGSIZE ];
klauss 69:65665afbad5d 159 * char bod y[ SIP_MAXMSGSIZE ];
klauss 69:65665afbad5d 160 * pkg = sip->make_content_length( header,body, pkg );
klauss 69:65665afbad5d 161 * ...
klauss 69:65665afbad5d 162 * @endcode
klauss 69:65665afbad5d 163 */
klauss 0:4d17cd9c8f9d 164 char * make_content_length( char * header, char * body, char * pkg );
klauss 69:65665afbad5d 165
klauss 69:65665afbad5d 166 /**
klauss 69:65665afbad5d 167 * @Synopsis Função que decodifiica o codigo recebido em um dado pocote Sip.
klauss 69:65665afbad5d 168 *
klauss 69:65665afbad5d 169 * @param s O pacote que se deseja decodificar.
klauss 69:65665afbad5d 170 *
klauss 69:65665afbad5d 171 * @return O código identificado no pacote recebido.
klauss 69:65665afbad5d 172 *
klauss 69:65665afbad5d 173 * \note Não esta em uso atualmente.
klauss 69:65665afbad5d 174 *
klauss 69:65665afbad5d 175 * Exemplo:
klauss 69:65665afbad5d 176 * @code
klauss 69:65665afbad5d 177 * ...
klauss 69:65665afbad5d 178 * char buffer[ 1024 ];
klauss 69:65665afbad5d 179 * //assumindo que em buffer será armazenado o valor do pacote que será analisado para saber o codigo de retorno.
klauss 69:65665afbad5d 180 * int code = sip->get_return_code( buffer );
klauss 69:65665afbad5d 181 * ...
klauss 69:65665afbad5d 182 * @endcode
klauss 69:65665afbad5d 183 */
klauss 0:4d17cd9c8f9d 184 int get_return_code( char * s );
klauss 69:65665afbad5d 185
klauss 69:65665afbad5d 186 /**
klauss 69:65665afbad5d 187 * @Synopsis Gera um nro de cseq para preenchimento no cabeçalho dos pacotes Sip.
klauss 69:65665afbad5d 188 *
klauss 69:65665afbad5d 189 * @return O numero gerado.
klauss 69:65665afbad5d 190 *
klauss 69:65665afbad5d 191 * Exemplo:
klauss 69:65665afbad5d 192 * @code
klauss 69:65665afbad5d 193 * ...
klauss 69:65665afbad5d 194 * int cseq = sip->get_cseq();
klauss 69:65665afbad5d 195 * ...
klauss 69:65665afbad5d 196 * @endcode
klauss 69:65665afbad5d 197 */
klauss 0:4d17cd9c8f9d 198 int get_cseq( void );
klauss 69:65665afbad5d 199
klauss 69:65665afbad5d 200 /**
klauss 69:65665afbad5d 201 * @Synopsis Obtem o id( ramal ) do objeto.
klauss 69:65665afbad5d 202 *
klauss 69:65665afbad5d 203 * @return Retorna o id( ramal ) do objeto.
klauss 69:65665afbad5d 204 *
klauss 69:65665afbad5d 205 * Exemplo:
klauss 69:65665afbad5d 206 * @code
klauss 69:65665afbad5d 207 * ...
klauss 69:65665afbad5d 208 * int ext = sip->get_id();
klauss 69:65665afbad5d 209 * ...
klauss 69:65665afbad5d 210 * @endcode
klauss 69:65665afbad5d 211 */
klauss 0:4d17cd9c8f9d 212 int get_id( void );
klauss 0:4d17cd9c8f9d 213
klauss 69:65665afbad5d 214 /**
klauss 69:65665afbad5d 215 * @Synopsis Obtem a porta rtp na qual a Header ira encaminhar e receber dados do Server.
klauss 69:65665afbad5d 216 *
klauss 69:65665afbad5d 217 * @return O numero da porta RTP usado pelo objeto Sip durante uma determinada chamada.
klauss 69:65665afbad5d 218 *
klauss 69:65665afbad5d 219 * Exemplo:
klauss 69:65665afbad5d 220 * @code
klauss 69:65665afbad5d 221 * ...
klauss 69:65665afbad5d 222 * int rtp_port = sip->get_my_rtp_port();
klauss 69:65665afbad5d 223 * ...
klauss 69:65665afbad5d 224 * @endcode
klauss 69:65665afbad5d 225 */
klauss 119:ee6a53069455 226 int get_my_rtp_port( void );
klauss 69:65665afbad5d 227
klauss 69:65665afbad5d 228 /**
klauss 69:65665afbad5d 229 * @Synopsis Efetivamente cria o pacote de registro.
klauss 69:65665afbad5d 230 *
klauss 69:65665afbad5d 231 * @param buffer Recebe um ponteiro para uma região de memória onde irá escrever o pacote de registro.
klauss 69:65665afbad5d 232 *
klauss 69:65665afbad5d 233 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 234 */
klauss 0:4d17cd9c8f9d 235 char * build_registry_package( char * buffer );
klauss 69:65665afbad5d 236
klauss 69:65665afbad5d 237 /**
klauss 69:65665afbad5d 238 * @Synopsis Efetivamente cria um pacote de invite ( pedido de chamada ) do Call_box para o server.
klauss 69:65665afbad5d 239 *
klauss 69:65665afbad5d 240 * @param s Um ponteiro para uma região de memória onde irá escrever o pacote de invite.
klauss 69:65665afbad5d 241 * @param callbox_string Uma string de identifcação do Call_box.
klauss 69:65665afbad5d 242 * @param cseq O nro de cseq que irá ser colocado no pacote.
klauss 69:65665afbad5d 243 *
klauss 69:65665afbad5d 244 * @return
klauss 69:65665afbad5d 245 */
klauss 119:ee6a53069455 246 char * build_invite_package( char * s, char * callbox_string, int * cseq, bool retry = false );
klauss 69:65665afbad5d 247
klauss 69:65665afbad5d 248 /**
klauss 69:65665afbad5d 249 * @Synopsis Efetivamente cria um pacote de "despedida" para o servidor, usado para encerrar ligações.
klauss 69:65665afbad5d 250 *
klauss 69:65665afbad5d 251 * @param buffer Um ponteiro para uma região de memória onde irá escrever o pacote de bye.
klauss 69:65665afbad5d 252 *
klauss 69:65665afbad5d 253 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 254 */
klauss 119:ee6a53069455 255 char * build_bye_package( char * buffer );
klauss 69:65665afbad5d 256
klauss 69:65665afbad5d 257 /**
klauss 69:65665afbad5d 258 * @Synopsis Efetivamente cria um pacote de ack de mensagem recebida.
klauss 69:65665afbad5d 259 *
klauss 69:65665afbad5d 260 * @param buffer Um ponteiro para a posição de memória onde será criado o pacote ack
klauss 69:65665afbad5d 261 * @param orig O pacote original recebido do servidor, serve como referência na criação do pacote de resposta,
klauss 69:65665afbad5d 262 *
klauss 69:65665afbad5d 263 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 264 */
klauss 119:ee6a53069455 265 char * build_ack_package( char * buffer, unsigned char * orig );
klauss 69:65665afbad5d 266
klauss 69:65665afbad5d 267 /**
klauss 69:65665afbad5d 268 * @Synopsis
klauss 69:65665afbad5d 269 *
klauss 69:65665afbad5d 270 * @param s Um ponteiro para a posição de memória onde será montado o pacote.
klauss 69:65665afbad5d 271 * @param orig O pacote recebido do servidor, serve como referência para criação da resposta.
klauss 69:65665afbad5d 272 * @param tag A tag que será usada no pacote de resposta.
klauss 69:65665afbad5d 273 *
klauss 69:65665afbad5d 274 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 275 */
klauss 119:ee6a53069455 276 char * build_generic_reply_package( char * s, unsigned char * orig, char * tag );
klauss 69:65665afbad5d 277
klauss 69:65665afbad5d 278 /**
klauss 69:65665afbad5d 279 * @Synopsis Cria um pacote genérico de resposta.
klauss 69:65665afbad5d 280 *
klauss 69:65665afbad5d 281 * @param buffer Um ponteiro para a posição de memória onde será montado o pacote.
klauss 69:65665afbad5d 282 * @param orig
klauss 69:65665afbad5d 283 *
klauss 69:65665afbad5d 284 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 285 */
klauss 119:ee6a53069455 286 char * build_trying_package( char * buffer, unsigned char * orig );
klauss 69:65665afbad5d 287
klauss 69:65665afbad5d 288 /**
klauss 69:65665afbad5d 289 * @Synopsis
klauss 69:65665afbad5d 290 *
klauss 69:65665afbad5d 291 * @param buffer Um ponteiro para a posição de memória onde será montado o pacote.
klauss 69:65665afbad5d 292 * @param orig O pacote de origem, serve como referência na criação do pacote.
klauss 69:65665afbad5d 293 *
klauss 69:65665afbad5d 294 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 295 */
klauss 119:ee6a53069455 296 char * build_busy_package( char * buffer, unsigned char * orig );
klauss 69:65665afbad5d 297
klauss 69:65665afbad5d 298 /**
klauss 69:65665afbad5d 299 * @Synopsis
klauss 69:65665afbad5d 300 *
klauss 69:65665afbad5d 301 * @param buffer Um ponteiro para a posição de memória onde será montado o pacote.
klauss 69:65665afbad5d 302 * @param orig O pacote de origem, serve como referência na criação do pacote.
klauss 69:65665afbad5d 303 *
klauss 69:65665afbad5d 304 * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
klauss 69:65665afbad5d 305 */
klauss 119:ee6a53069455 306 char * build_reply_package( char * buffer, unsigned char * orig );
klauss 69:65665afbad5d 307
klauss 69:65665afbad5d 308 /**
klauss 69:65665afbad5d 309 * @Synopsis Preenche de forma aleatótia 16 posições de memória.
klauss 69:65665afbad5d 310 *
klauss 69:65665afbad5d 311 * @param buffer Um ponteiro que aponta para o inicio das 16 ( bytes ) posições que serão preenchidas.
klauss 69:65665afbad5d 312 *
klauss 69:65665afbad5d 313 * @return Retorna um ponteiro para os dados preenchidos ( mesmo endereço passado como parâmetro.
klauss 69:65665afbad5d 314 */
klauss 0:4d17cd9c8f9d 315 char * fill_random16h(char * buffer );
klauss 69:65665afbad5d 316
klauss 69:65665afbad5d 317 /**
klauss 69:65665afbad5d 318 * @Synopsis Preenche de forma aleatótia dados.
klauss 69:65665afbad5d 319 *
klauss 69:65665afbad5d 320 * @param buffer Um ponteiro que aponta para o inicio das posições a serem preenchidas.
klauss 69:65665afbad5d 321 * @param size A quantidade ( em posições ) que serão preenchidas.
klauss 69:65665afbad5d 322 *
klauss 69:65665afbad5d 323 * @return Um ponteiro para o inicio das posições preenchidas ( mesmo endereço do parâmetro passado ).
klauss 69:65665afbad5d 324 */
klauss 119:ee6a53069455 325 char * fill_random( char * buffer, int size );
klauss 69:65665afbad5d 326
klauss 69:65665afbad5d 327 /**
klauss 69:65665afbad5d 328 * @Synopsis Gera aleatóriamente a porta RTP de onde os dados de audiao serão enviados da Header.
klauss 69:65665afbad5d 329 *
klauss 69:65665afbad5d 330 * @return O nro da porta que será usada na negociação Sip.
klauss 69:65665afbad5d 331 */
klauss 119:ee6a53069455 332 int fill_random_rtp_port( void );
klauss 0:4d17cd9c8f9d 333
klauss 69:65665afbad5d 334 /**
klauss 69:65665afbad5d 335 * @Synopsis Dado um pacote recebido do server, decodifica o nro cseq.
klauss 69:65665afbad5d 336 *
klauss 69:65665afbad5d 337 * @param package O pacote do qual se tem interesse em decodificar.
klauss 69:65665afbad5d 338 * @param cseq Um ponteiro que aponta para a posição de memória onde será escrito o cseq.
klauss 69:65665afbad5d 339 *
klauss 69:65665afbad5d 340 * @return Um ponteiro para o inicio da posição de memória que contem o cseq ( mesma passada como parâmetro ).
klauss 69:65665afbad5d 341 */
klauss 0:4d17cd9c8f9d 342 char * decode_cseq(unsigned char * package, char * cseq);
klauss 69:65665afbad5d 343
klauss 69:65665afbad5d 344 /**
klauss 69:65665afbad5d 345 * @Synopsis Dado um pacote recebido do server, decodifica o branch.
klauss 69:65665afbad5d 346 *
klauss 69:65665afbad5d 347 * @param package Um ponteiro para o pacote recebido do servidor o qual temos interesse em decodificar.
klauss 69:65665afbad5d 348 * @param branch Um ponteiro para o inicio da posição de memória onde escreveremos o branch
klauss 69:65665afbad5d 349 *
klauss 69:65665afbad5d 350 * @return Um ponteiro para o inicio da posição de memória onde escrevemos o branch ( mesma passada como parâmentro ).
klauss 69:65665afbad5d 351 */
klauss 119:ee6a53069455 352 char * decode_branch( unsigned char * package, char * branch );
klauss 69:65665afbad5d 353
klauss 69:65665afbad5d 354 /**
klauss 69:65665afbad5d 355 * @Synopsis Busca por uma determinado substring em um pacote recebido do servidor. Copiando o restando desse pacote para
klauss 69:65665afbad5d 356 * uma posição de interesse.
klauss 69:65665afbad5d 357 *
klauss 69:65665afbad5d 358 * @param package O pacote que se tem interesse em decodificar.
klauss 69:65665afbad5d 359 * @param tag A substring que a função ira buscar em package.
klauss 69:65665afbad5d 360 * @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 361 * encontrada.
klauss 69:65665afbad5d 362 *
klauss 69:65665afbad5d 363 * @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 364 * retorna 0 caso a substring não seja encontrada.
klauss 69:65665afbad5d 365 */
klauss 119:ee6a53069455 366 int decode_gettag( unsigned char * package, char * tag, char * out );
klauss 0:4d17cd9c8f9d 367
klauss 69:65665afbad5d 368 /**
klauss 69:65665afbad5d 369 * @Synopsis Recebe um ramal de comunicação com o servidor, realizando solicitações futuras com esse ramal.
klauss 69:65665afbad5d 370 *
klauss 69:65665afbad5d 371 * @param new_server_ext O Ramal do servidor que será associado ao objeto Sip
klauss 69:65665afbad5d 372 *
klauss 69:65665afbad5d 373 * Exemplo:
klauss 69:65665afbad5d 374 * @code
klauss 69:65665afbad5d 375 * ...
klauss 69:65665afbad5d 376 * sip->set_server_ext( 913 );
klauss 69:65665afbad5d 377 * ...
klauss 69:65665afbad5d 378 * @endcode
klauss 69:65665afbad5d 379 */
klauss 119:ee6a53069455 380 void set_server_ext( int new_server_ext );
klauss 69:65665afbad5d 381
klauss 69:65665afbad5d 382 /**
klauss 69:65665afbad5d 383 * @Synopsis Recebe uma porta de comunicação com o servidor, setando e realizando comunicaões entre Header-Server atraves
klauss 69:65665afbad5d 384 * dessa porta
klauss 69:65665afbad5d 385 *
klauss 69:65665afbad5d 386 * @param new_server_port A porta do servidor que será associada ao objeto Sip
klauss 69:65665afbad5d 387 *
klauss 69:65665afbad5d 388 * Exemplo:
klauss 69:65665afbad5d 389 * @code
klauss 69:65665afbad5d 390 * ...
klauss 69:65665afbad5d 391 * sip->set_server_port( 818 );
klauss 69:65665afbad5d 392 * ...
klauss 69:65665afbad5d 393 * @endcode
klauss 69:65665afbad5d 394 */
klauss 119:ee6a53069455 395 void set_server_port( int new_server_port );
klauss 69:65665afbad5d 396
klauss 69:65665afbad5d 397 /**
klauss 69:65665afbad5d 398 * @Synopsis Seta ramal de comunicação Sip da Header.
klauss 69:65665afbad5d 399 *
klauss 69:65665afbad5d 400 * @param ext Ramal que será associado ao objeto Sip criado.
klauss 69:65665afbad5d 401 *
klauss 69:65665afbad5d 402 * Exemplo:
klauss 69:65665afbad5d 403 * @code
klauss 69:65665afbad5d 404 * ...
klauss 69:65665afbad5d 405 * sip->set_ext( 818 );
klauss 69:65665afbad5d 406 * ...
klauss 69:65665afbad5d 407 * @endcode
klauss 69:65665afbad5d 408 *
klauss 69:65665afbad5d 409 */
klauss 119:ee6a53069455 410 void set_ext( int ext );
klauss 0:4d17cd9c8f9d 411
klauss 69:65665afbad5d 412 /**
klauss 69:65665afbad5d 413 * @Synopsis Seta a porta de comunicação Sip da Header.
klauss 69:65665afbad5d 414 *
klauss 69:65665afbad5d 415 * @param port Porta que será associada ao objeto Sip criado.
klauss 69:65665afbad5d 416 *
klauss 69:65665afbad5d 417 * Exemplo:
klauss 69:65665afbad5d 418 * @code
klauss 69:65665afbad5d 419 * ...
klauss 69:65665afbad5d 420 * sipset_port( 1028 );
klauss 69:65665afbad5d 421 * ...
klauss 69:65665afbad5d 422 * @endcode
klauss 69:65665afbad5d 423 *
klauss 69:65665afbad5d 424 *
klauss 69:65665afbad5d 425 */
klauss 119:ee6a53069455 426 void set_port( int port );
klauss 69:65665afbad5d 427
klauss 69:65665afbad5d 428 /**
klauss 69:65665afbad5d 429 * @Synopsis Seta o valor passado como parâmetro como sendo o endeço IP de contato do servidor.
klauss 69:65665afbad5d 430 *
klauss 69:65665afbad5d 431 * @param new_server_ip O endereço que será associado ao objeto Sip.
klauss 69:65665afbad5d 432 *
klauss 69:65665afbad5d 433 * Exemplo:
klauss 69:65665afbad5d 434 * @code
klauss 69:65665afbad5d 435 * ...
klauss 69:65665afbad5d 436 * sip->set_server_ip( "192.168.120.8" );
klauss 69:65665afbad5d 437 * ...
klauss 69:65665afbad5d 438 * @endcode
klauss 69:65665afbad5d 439 */
klauss 119:ee6a53069455 440 void set_server_ip( char * new_server_ip );
klauss 0:4d17cd9c8f9d 441
klauss 69:65665afbad5d 442 /**
klauss 69:65665afbad5d 443 * @Synopsis Responsavel por ouvir o servidor *, verificando se o mesmo esta mandando alguma mensagem, seja Sip ou qualquer outra
klauss 69:65665afbad5d 444 * nas portas acordadas.
klauss 69:65665afbad5d 445 *
klauss 69:65665afbad5d 446 * @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 447 * ser encerrada.
klauss 69:65665afbad5d 448 */
klauss 119:ee6a53069455 449 int listen_SIP_server( void );
klauss 69:65665afbad5d 450
klauss 69:65665afbad5d 451 /**
klauss 69:65665afbad5d 452 * @Synopsis Envia efetivamente o pacote de despedita com Call_box pro servidor
klauss 69:65665afbad5d 453 *
klauss 69:65665afbad5d 454 * Exemplo:
klauss 69:65665afbad5d 455 * @code
klauss 69:65665afbad5d 456 * ...
klauss 69:65665afbad5d 457 * sip->send_bye();
klauss 69:65665afbad5d 458 * ...
klauss 69:65665afbad5d 459 * @endcode
klauss 69:65665afbad5d 460 */
klauss 119:ee6a53069455 461 void send_bye( void );
klauss 69:65665afbad5d 462
klauss 69:65665afbad5d 463 /**
klauss 78:1353744f01e1 464 * @Synopsis Retorna o status atual do objeto
klauss 69:65665afbad5d 465 *
klauss 78:1353744f01e1 466 * @return O valor correspondente ao status do objeto
klauss 69:65665afbad5d 467 */
klauss 119:ee6a53069455 468 int get_status( void );
klauss 119:ee6a53069455 469
klauss 119:ee6a53069455 470 /*------------------------------------------------------------------------------------------------*/
klauss 119:ee6a53069455 471 int get_socket_fd( void );
klauss 119:ee6a53069455 472 int udp_incomming_pkg( void );
klauss 119:ee6a53069455 473 int get_ext( void );
klauss 119:ee6a53069455 474 int get_port( void );
klauss 119:ee6a53069455 475 int get_sip_rtp_port ( void );
klauss 119:ee6a53069455 476 int print_yourself ( void );
klauss 119:ee6a53069455 477 int retry_send_last_invite_pkg_to_ast ( void );
klauss 119:ee6a53069455 478
klauss 119:ee6a53069455 479 void set_sip_rtp_port ( int );
klauss 119:ee6a53069455 480 void sip_set_status( uint8_t status );
klauss 119:ee6a53069455 481 void reset_call( void );
klauss 0:4d17cd9c8f9d 482 };
klauss 0:4d17cd9c8f9d 483 #endif