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