userapps/opensource/libosip2/include/osipparser2/headers/osip_route.h

   1 /*
   2   The oSIP library implements the Session Initiation Protocol (SIP -rfc2543-)
   3   Copyright (C) 2001  Aymeric MOIZARD jack@atosc.org
   4
   5   This library is free software; you can redistribute it and/or
   6   modify it under the terms of the GNU Lesser General Public
   7   License as published by the Free Software Foundation; either
   8   version 2.1 of the License, or (at your option) any later version.
   9
  10   This library is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   Lesser General Public License for more details.
  14
  15   You should have received a copy of the GNU Lesser General Public
  16   License along with this library; if not, write to the Free Software
  17   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18 */
  19
  20
  21 #ifndef _OSIP_RECORD_H_
  22 #define _OSIP_RECORD_H_
  23
  24 #include <osipparser2/headers/osip_from.h>
  25
  26 /**
  27  * @file osip_route.h
  28  * @brief oSIP osip_route header definition.
  29  */
  30
  31 /**
  32  * @defgroup oSIP_ROUTE oSIP route header definition.
  33  * @ingroup oSIP_HEADERS
  34  * @{
  35  */
  36
  37 /**
  38  * Structure for Route headers.
  39  * @defvar osip_route_t
  40  */
  41   typedef osip_from_t osip_route_t;
  42
  43 #ifdef __cplusplus
  44 extern "C"
  45 {
  46 #endif
  47
  48 #ifdef __VXWORKS_OS__
  49 /* osip_route_init is already defined somewhere on VXWORKS.. */
  50   int osip_route_init2 (osip_route_t ** header);
  51 #else
  52 /**
  53  * Allocate a Route element.
  54  * @param header The element to work on.
  55  */
  56   int osip_route_init (osip_route_t ** header);
  57 #endif
  58 /**
  59  * Free a Route element.
  60  * @param header The element to work on.
  61  */
  62   void osip_route_free (osip_route_t * header);
  63 /**
  64  * Parse a Route element.
  65  * @param header The element to work on.
  66  * @param hvalue The string to parse.
  67  */
  68   int osip_route_parse (osip_route_t * header, const char *hvalue);
  69 /**
  70  * Get a string representation of a Route element.
  71  * @param header The element to work on.
  72  * @param dest A pointer on the new allocated string.
  73  */
  74   int osip_route_to_str (const osip_route_t * header, char **dest);
  75 /**
  76  * Clone a Route element.
  77  * @param header The element to work on.
  78  * @param dest A pointer on the copy of the element.
  79  */
  80 #define osip_route_clone(header,dest)       osip_from_clone(header,dest)
  81 /**
  82  * Set the url in the Route element.
  83  * @param header The element to work on.
  84  * @param url The value of the element.
  85  */
  86 #define osip_route_set_url(header,url)    osip_from_set_url((osip_from_t*)header,url)
  87 /**
  88  * Get the url from a Route header.
  89  * @param header The element to work on.
  90  */
  91 #define osip_route_get_url(header)        osip_from_get_url((osip_from_t*)header)
  92 /**
  93  * Get a header parameter from a Route element.
  94  * @param header The element to work on.
  95  * @param pos The index of the element to get.
  96  * @param dest A pointer on the element found.
  97  */
  98 #define osip_route_param_get(header,pos,dest) osip_from_param_get((osip_from_t*)header,pos,dest)
  99 /**
 100  * Allocate and add a generic parameter element in a Route element.
 101  * @param header The element to work on.
 102  * @param name The token name.
 103  * @param value The token value.
 104  */
 105 #define osip_route_param_add(header,name,value)   osip_generic_param_add((header)->gen_params,name,value)
 106 /**
 107  * Find a header parameter in a Route element.
 108  * @param header The element to work on.
 109  * @param name The token name to search.
 110  * @param dest A pointer on the element found.
 111  */
 112 #define osip_route_param_get_byname(header,name,dest) osip_generic_param_get_byname((header)->gen_params,name,dest)
 113
 114 #ifdef __cplusplus
 115 }
 116 #endif
 117
 118 /** @} */
 119
 120 #endif