sip.h

00001 /**
00002  * @file sip.h
00003  * @Synopsis Implementa as funções utilizadas no tratamento SIP entre a Header e o server
00004  * @author Jhonatan Casale
00005  * @version 1
00006  * @date 2014-11-05
00007  * \class Sip
00008  */
00009 #ifndef __SIP_H__
00010 #define __SIP_H__
00011 
00012 #include "EthernetInterface.h"
00013 #include "mbed.h"
00014 #include <stdint.h>
00015 #include "call.h"
00016 %: include "config_manager.h"
00017 %: include "shared_variables.h"
00018 
00019 const uint8_t INVITE_MAX_WAITING_TIME = 45;
00020 ///< 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
00021 
00022 const uint16_t SIP_MAXFIELDSIZE = 256;
00023 ///< Define o tamanho máximo de algumas mensagens usadas na negociação Sip.
00024 
00025 const uint16_t SIP_MAXMSGSIZE = 1024;
00026 ///< Define o tamanho máximo das mensagens enviadas.
00027 
00028 static const char SIP_ALLOW[] = "Allow: ACK, BYE, CANCEL, INFO, INVITE, NOTIFY, OPTIONS, REFER";
00029 ///< String de composição de pacotes enviados pela Header para o *
00030 
00031 static const char fill_random_aux[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789pP";
00032 
00033 const uint8_t CALLBOX_STRING_SIZE = 32;
00034 
00035 const uint8_t CONTENT_LENGTH_MSG_SIZE = 65;
00036 
00037 const uint8_t sip_idle = 0;
00038 const uint8_t sip_waiting_trying = 1 << 1;
00039 const uint8_t sip_trying = 1 << 2;
00040 const uint8_t sip_ringing = 1 << 3;
00041 const uint8_t sip_busy = 1 << 4;
00042 const uint8_t sip_ok = 1 << 5; // don't used
00043 const uint8_t sip_on_call = 1 << 6;
00044 const uint8_t sip_denied = 1 << 7;
00045 
00046 class Sip{
00047 
00048 private :
00049     uint8_t status; ///< Representa o status do objeto Sip em dado momento.
00050 
00051     int my_ext;
00052     int my_port;
00053     int peer_ext;
00054     int server_port;
00055     int my_rtp_port;
00056     
00057     int listen_SIP_server_return;
00058     int last_cseq;
00059     
00060     char server_ip[ 20 ];
00061     char my_ip[ 20 ];
00062     char my_display[ 20 ];
00063     char SVNREV[ 16 ];
00064     char buffer[ SIP_MAXMSGSIZE ];
00065     char last_invite_tag [ SIP_MAXFIELDSIZE ];
00066     char last_invite_callid [ SIP_MAXFIELDSIZE ];
00067     char last_branch [ SIP_MAXFIELDSIZE ];
00068     
00069     void __init_sock__ ( void );
00070     void __end_sock__ ( void );
00071     void __reconnect__ ( void );
00072     
00073     bool waiting;
00074     
00075     UDPSocket sock;
00076     
00077     Endpoint sip_server;
00078     
00079     VZ_call * call;
00080     
00081     Timer invite_timer;
00082     
00083 public :
00084         /**
00085          * @Synopsis Cria um objeto Sip setando ramal e porta e o restando buscando valores default.
00086          *
00087          * @param id O identificador do objeto ( por definição de projeto o ramal ( ext ) ).
00088          * @param my_port A porta do objeto Sip para comunicação com o servidor.
00089          *
00090          * Exemplo:
00091          *
00092          * @code
00093          * ...
00094          *  Sip * sip = new Sip( 5002, 5002 );
00095          * ...
00096          * @endcode
00097          */
00098     Sip ( const int my_ext, const uint16_t my_port );
00099 
00100         /**
00101          * @Synopsis Destroi o objeto Sip
00102          *
00103          * Exemplo:
00104          *
00105          * @code
00106          * ...
00107          *  delete( sip );
00108          * ...
00109          * @endcode
00110          */
00111     ~Sip ( void );
00112 
00113         /**
00114          * @Synopsis Responsavel por montar encaminhar o pacote de registro para o servidor.
00115          *
00116          * Exemplo:
00117          * @code
00118          * ...
00119          *  sip->registry();
00120          * ...
00121          * @endcode
00122          */
00123     int registry ( void );
00124 
00125         /**
00126          * @Synopsis Efetivamente envia o pedido de ligação para o servidor.
00127          *
00128          * @return Uma referência para uma ligação, caso a negociação resulte na aceitação por parte do servidor, NULL, caso contrário.
00129          * \note Como por conveniência, foi configurado no servidor * que existiria musica de conforto, o que fez com que, assim que é 
00130          * feito o envio do pacote de invite, uma chamada é criada para se trocar os dados desse audio de conforto, ficando a Header na
00131          * espera do servidor aceitar ou não o pedido de forma definitiva, no caso em que o server dizer "ok", a mesma chamada é retornada,
00132          * porém, no caso de timeout ou negativa do server, a chamada é destruida e NULL é retornado.
00133          *
00134          * Exemplo:
00135          * @code
00136          * ...
00137          *  VZ_call * call = sip->invite();
00138          * ...
00139          * @endcode
00140          */
00141     VZ_call * invite ( void );
00142 
00143         /**
00144          * @Synopsis Gera um nro de cseq para preenchimento no cabeçalho dos pacotes Sip.
00145          *
00146          * @return O numero gerado.
00147          *
00148          * Exemplo:
00149          * @code
00150          * ...
00151          *  int cseq = sip->get_cseq();
00152          * ...
00153          * @endcode
00154          */
00155     int get_cseq ( void );
00156     
00157         /**
00158          * @Synopsis Efetivamente cria o pacote de registro.
00159          *
00160          * @param buffer Recebe um ponteiro para uma região de memória onde irá escrever o pacote de registro.
00161          *
00162          * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
00163          */
00164     char * build_registry_package ( void );
00165     
00166         /**
00167          * @Synopsis Efetivamente cria um pacote de invite ( pedido de chamada ) do Call_box para o server.
00168          *
00169          * @param s Um ponteiro para uma região de memória onde irá escrever o pacote de invite.
00170          * @param callbox_string Uma string de identifcação do Call_box.
00171          * @param cseq O nro de cseq que irá ser colocado no pacote.
00172          *
00173          * @return 
00174          */
00175     char * build_invite_package ( int * cseq, const bool retry = false );
00176     
00177         /**
00178          * @Synopsis Efetivamente cria um pacote de "despedida" para o servidor, usado para encerrar ligações.
00179          *
00180          * @param buffer Um ponteiro para uma região de memória onde irá escrever o pacote de bye.
00181          *
00182          * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
00183          */
00184     char * build_bye_package ( void );
00185     
00186         /**
00187          * @Synopsis Efetivamente cria um pacote de ack de mensagem recebida.
00188          *
00189          * @param buffer Um ponteiro para a posição de memória onde será criado o pacote ack
00190          * @param orig O pacote original recebido do servidor, serve como referência na criação do pacote de resposta,
00191          *
00192          * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
00193          */
00194     char * build_ack_package ( void );
00195     
00196         /**
00197          * @Synopsis 
00198          * 
00199          * @param buffer Um ponteiro para a posição de memória onde será montado o pacote.
00200          * @param orig O pacote de origem, serve como referência na criação do pacote.
00201          *
00202          * @return Um ponteiro para o inicio do pacote montado ( mesmo endereço passado como parâmetro ).
00203          */
00204     char * build_reply_package ( void );
00205     
00206         /**
00207          * @Synopsis Preenche de forma aleatótia 16 posições de memória.
00208          *
00209          * @param buffer Um ponteiro que aponta para o inicio das 16 ( bytes ) posições que serão preenchidas.
00210          *
00211          * @return Retorna um ponteiro para os dados preenchidos ( mesmo endereço passado como parâmetro.
00212          */
00213     char * fill_random16h ( char * buffer );
00214     
00215         /**
00216          * @Synopsis Preenche de forma aleatótia dados.
00217          *
00218          * @param buffer Um ponteiro que aponta para o inicio das posições a serem preenchidas.
00219          * @param size A quantidade ( em posições ) que serão preenchidas.
00220          *
00221          * @return Um ponteiro para o inicio das posições preenchidas ( mesmo endereço do parâmetro passado ).
00222          */
00223     char * fill_random ( char * buffer, const int size );
00224     
00225         /**
00226          * @Synopsis Gera aleatóriamente a porta RTP de onde os dados de audiao serão enviados da Header.
00227          *
00228          * @return O nro da porta que será usada na negociação Sip.
00229          */
00230     int fill_random_rtp_port ( void );
00231     
00232         /**
00233          * @Synopsis Dado um pacote recebido do server, decodifica o nro cseq.
00234          *
00235          * @param package O pacote do qual se tem interesse em decodificar.
00236          * @param cseq Um ponteiro que aponta para a posição de memória onde será escrito o cseq.
00237          *
00238          * @return Um ponteiro para o inicio da posição de memória que contem o cseq ( mesma passada como parâmetro ).
00239          */
00240     char * decode_cseq ( const unsigned char * package, char * cseq );
00241     
00242         /**
00243          * @Synopsis Dado um pacote recebido do server, decodifica o branch.
00244          *
00245          * @param package Um ponteiro para o pacote recebido do servidor o qual temos interesse em decodificar.
00246          * @param branch Um ponteiro para o inicio da posição de memória onde escreveremos o branch
00247          *
00248          * @return Um ponteiro para o inicio da posição de memória onde escrevemos o branch ( mesma passada como parâmentro ).
00249          */
00250     char * decode_branch ( const unsigned char * package, char * branch );
00251     
00252         /**
00253          * @Synopsis Busca por uma determinado substring em um pacote recebido do servidor. Copiando o restando desse pacote para
00254          * uma posição de interesse.
00255          *
00256          * @param package O pacote que se tem interesse em decodificar.
00257          * @param tag A substring que a função ira buscar em package.
00258          * @param out A região de memória para onde o restante dos dados contidos em package será copiado, caso a substring seja 
00259          * encontrada.
00260          *
00261          * @return 1, caso tenha encontrado a string tag contida no package, copia o restando do conteudo de package para out e retorna 1,
00262          * retorna 0 caso a substring não seja encontrada.
00263          */
00264     int decode_gettag ( const unsigned char * package, const char * tag, char * out );
00265     
00266         /**
00267          * @Synopsis Recebe um ramal de comunicação com o servidor, realizando solicitações futuras com esse ramal.
00268          *
00269          * @param new_server_ext O Ramal do servidor que será associado ao objeto Sip
00270          *
00271          * Exemplo:
00272          * @code
00273          * ...
00274          *  sip->set_server_ext( 913 );
00275          * ...
00276          * @endcode
00277          */
00278     void set_server_ext ( const int new_server_ext );
00279     
00280         /**
00281          * @Synopsis Recebe uma porta de comunicação com o servidor, setando e realizando comunicaões entre Header-Server atraves 
00282          * dessa porta
00283          *
00284          * @param new_server_port A porta do servidor que será associada ao objeto Sip
00285          *
00286          * Exemplo:
00287          * @code
00288          * ...
00289          *  sip->set_server_port( 818 );
00290          * ...
00291          * @endcode
00292          */
00293     void set_server_port ( const int new_server_port );
00294     
00295         /**
00296          * @Synopsis Seta a porta de comunicação Sip da Header.
00297          *
00298          * @param port Porta que será associada ao objeto Sip criado.
00299          *
00300          * Exemplo:
00301          * @code
00302          * ...
00303          *  sipset_port( 1028 );
00304          * ...
00305          * @endcode
00306          *
00307          *
00308          */
00309     void set_port ( const int port );
00310     
00311         /**
00312          * @Synopsis Seta o valor passado como parâmetro como sendo o endeço IP de contato do servidor.
00313          *
00314          * @param new_server_ip O endereço que será associado ao objeto Sip.
00315          *
00316          * Exemplo:
00317          * @code
00318          * ...
00319          *  sip->set_server_ip( "192.168.120.8" );
00320          * ...
00321          * @endcode
00322          */
00323     void set_server_ip ( const char * new_server_ip );
00324     
00325         /**
00326          * @Synopsis Responsavel por ouvir o servidor *, verificando se o mesmo esta mandando alguma mensagem, seja Sip ou qualquer outra
00327          * nas portas acordadas.
00328          *
00329          * @return 0, sucesso na execução, sem pendencia, ou retorna um nro maior que zero, representando o nro do ramal cuja ligação deve
00330          * ser encerrada.
00331          */
00332     int listen_SIP_server ( void );
00333     
00334         /**
00335          * @Synopsis Envia efetivamente o pacote de despedita com Call_box pro servidor
00336          *
00337          * Exemplo:
00338          * @code
00339          * ...
00340          *  sip->send_bye();
00341          * ...
00342          * @endcode
00343          */
00344     void send_bye ( void );
00345     
00346         /**
00347          * @Synopsis Retorna o status atual do objeto
00348          *
00349          * @return O valor correspondente ao status do objeto
00350          */
00351     int get_status ( void );
00352     
00353     /*------------------------------------------------------------------------------------------------*/
00354     int get_socket_fd ( void );
00355     
00356     int udp_incomming_pkg ( void );
00357     
00358     int get_ext ( void );
00359     
00360     int get_port ( void );
00361     
00362     int get_sip_rtp_port ( void );
00363     
00364     int print_yourself ( void );
00365     
00366     int retry_send_last_invite_pkg_to_ast ( void );
00367     
00368     
00369     void set_sip_rtp_port ( const int new_my_rtp_port );
00370     
00371     void sip_set_status ( const uint8_t status );
00372     
00373     void reset_call ( void );
00374     
00375     void update ( void );
00376 };
00377 #endif