osip_uri.h

Go to the documentation of this file.

/*
  The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
  Copyright (C) 2001,2002,2003,2004,2005,2006,2007 Aymeric MOIZARD jack@atosc.org
  
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
  
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
  
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef _URLS_H_
#define _URLS_H_

#include <osipparser2/osip_const.h>
#include <osipparser2/osip_list.h>

#ifdef __cplusplus
extern "C"
{
#endif

  typedef struct osip_uri_param osip_uri_param_t;

  struct osip_uri_param
  {
    char *gname;    
    char *gvalue;   
  };

  typedef osip_uri_param_t osip_uri_header_t;

  int osip_uri_param_init (osip_uri_param_t ** url_param);
  void osip_uri_param_free (osip_uri_param_t * url_param);
  int osip_uri_param_set (osip_uri_param_t * url_param, char *name, char *value);
  int osip_uri_param_clone (const osip_uri_param_t * url_param,
                            osip_uri_param_t ** dest);
#ifndef DOXYGEN
/*
 * Free a list of a url parameter element.
 * @param url_params The list of url parameter element to free.
 */
  void osip_uri_param_freelist (osip_list_t * url_params);
#endif

  int osip_uri_param_add (osip_list_t * url_params, char *name, char *value);
  int osip_uri_param_get_byname (osip_list_t * url_params, char *name,
                                 osip_uri_param_t ** dest);

#define osip_uri_header_init(url_header) osip_uri_param_init(url_header)

#define osip_uri_header_free(url_header) osip_uri_param_free(url_header)

#define osip_uri_header_set(url_header, name, value)  osip_uri_param_set(url_header, name, value)

#define osip_uri_header_clone(url_header,dest)    osip_uri_param_clone(url_header,dest)
#ifndef DOXYGEN
/*
 * Free a list of a generic parameter element.
 * @param LIST The list of generic parameter element to free.
 */
#define osip_uri_header_freelist(LIST)       osip_uri_param_freelist(LIST)
#endif

#define osip_uri_header_add(url_headers,name,value)        osip_uri_param_add(url_headers,name,value)

#define osip_uri_header_get_byname(url_headers,name,dest) osip_uri_param_get_byname(url_headers,name,dest)

  typedef struct osip_uri osip_uri_t;

  struct osip_uri
  {
    char *scheme;              
    char *username;            
    char *password;            
    char *host;                
    char *port;                
    osip_list_t url_params;    
    osip_list_t url_headers;   
    char *string;  
  };

  int osip_uri_init (osip_uri_t ** url);
  void osip_uri_free (osip_uri_t * url);
  int osip_uri_parse (osip_uri_t * url, const char *buf);
#ifndef DOXYGEN

  int osip_uri_parse_headers (osip_uri_t * url, const char *buf);
  int osip_uri_parse_params (osip_uri_t * url, const char *buf);
#endif

  int osip_uri_to_str (const osip_uri_t * url, char **dest);
  int osip_uri_clone (const osip_uri_t * url, osip_uri_t ** dest);
  int osip_uri_to_str_canonical (const osip_uri_t * url, char **dest);

  void osip_uri_set_scheme (osip_uri_t * url, char *value);
  char *osip_uri_get_scheme (osip_uri_t * url);
  void osip_uri_set_host (osip_uri_t * url, char *value);
  char *osip_uri_get_host (osip_uri_t * url);
  void osip_uri_set_username (osip_uri_t * url, char *value);
  char *osip_uri_get_username (osip_uri_t * url);
  void osip_uri_set_password (osip_uri_t * url, char *value);
  char *osip_uri_get_password (osip_uri_t * url);
  void osip_uri_set_port (osip_uri_t * url, char *value);
  char *osip_uri_get_port (osip_uri_t * url);



#define osip_uri_set_transport_udp(url)   osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), osip_strdup("udp"))

#define osip_uri_set_transport_tcp(url)   osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), osip_strdup("tcp"))

#define osip_uri_set_transport_sctp(url)  osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), osip_strdup("sctp"))

#define osip_uri_set_transport_tls(url)   osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), osip_strdup("tls"))

#define osip_uri_set_transport(url,value) osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), value)

#define osip_uri_set_user_phone(url)   osip_uri_param_add((&(url)->url_params), osip_strdup("user"), osip_strdup("phone"))

#define osip_uri_set_user_ip(url)      osip_uri_param_add((&(url)->url_params), osip_strdup("user"), osip_strdup("ip"))

#define osip_uri_set_method_invite(url)  osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("INVITE"))

#define osip_uri_set_method_ack(url)     osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("ACK"))

#define osip_uri_set_method_options(url) osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("OPTIONS"))

#define osip_uri_set_method_bye(url)     osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("BYE"))

#define osip_uri_set_method_cancel(url)  osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("CANCEL"))

#define osip_uri_set_method_register(url) osip_uri_param_add((&(url)->url_params),osip_strdup("method"), osip_strdup("REGISTER"))

#define osip_uri_set_method(url, value) osip_uri_param_add((&(url)->url_params), osip_strdup("method"), value)

#define osip_uri_set_ttl(url, value)    osip_uri_param_add((&(url)->url_params), osip_strdup("ttl"), value)

#define osip_uri_set_maddr(url, value)  osip_uri_param_add((&(url)->url_params), osip_strdup("maddr"), value)

#define osip_uri_uparam_add(url,name,value) osip_uri_param_add((&(url)->url_params),name,value)

#define osip_uri_uparam_get_byname(url,name,dest)  osip_uri_param_get_byname((&(url)->url_params),name,dest)

#define osip_uri_uheader_add(url,name,value)    osip_uri_header_add((&(url)->url_headers),name,value)

#define osip_uri_uheader_get_byname(url,name,dest) osip_uri_header_get_byname((&(url)->url_headers),name,dest)

#ifndef DOXYGEN
/* internal method */
  char *next_separator (const char *ch, int separator_osip_to_find,
                        int before_separator);

  char *__osip_uri_escape_nonascii_and_nondef (const char *string,
                                               const char *def);
  char *__osip_uri_escape_userinfo (const char *string);
  char *__osip_uri_escape_password (const char *string);
  char *__osip_uri_escape_uri_param (char *string);
  char *__osip_uri_escape_header_param (char *string);
  void __osip_uri_unescape (char *string);

#endif

#ifdef __cplusplus
}
#endif

#endif                          /*  _URLS_H_ */

---