userapps/opensource/libosip2/include/osipparser2/headers/osip_record_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_ROUTE_H_
  22 #define _OSIP_RECORD_ROUTE_H_
  23
  24 #include <osipparser2/headers/osip_from.h>
  25
  26 /**
  27  * @file osip_record_route.h
  28  * @brief oSIP osip_record_route header definition.
  29  */
  30
  31 /**
  32  * @defgroup oSIP_RECORD_ROUTE oSIP record-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_record_route_t;
  42
  43 #ifdef __cplusplus
  44 extern "C"
  45 {
  46 #endif
  47
  48 /**
  49  * Allocate a Record-Route element.
  50  * @param header The element to work on.
  51  */
  52   int osip_record_route_init (osip_record_route_t ** header);
  53 /**
  54  * Free a Record-Route element.
  55  * @param header The element to work on.
  56  */
  57   void osip_record_route_free (osip_record_route_t * header);
  58 /**
  59  * Parse a Record-Route element.
  60  * @param header The element to work on.
  61  * @param hvalue The string to parse.
  62  */
  63   int osip_record_route_parse (osip_record_route_t * header, const char *hvalue);
  64 /**
  65  * Get a string representation of a Record-Route element.
  66  * @param header The element to work on.
  67  * @param dest A pointer on the new allocated string.
  68  */
  69   int osip_record_route_to_str (const osip_record_route_t * header, char **dest);
  70 /**
  71  * Clone a Record-Route element.
  72  * @param header The element to work on.
  73  * @param dest A pointer on the copy of the element.
  74  */
  75 #define osip_record_route_clone(header,dest)      osip_from_clone(header,dest)
  76 /**
  77  * Set the url in the Record-Route element.
  78  * @param header The element to work on.
  79  * @param url The value of the element.
  80  */
  81 #define osip_record_route_set_url(header,url)      osip_from_set_url((osip_from_t*)header,url)
  82 /**
  83  * Get the url from a Record-Route header.
  84  * @param header The element to work on.
  85  */
  86 #define osip_record_route_get_url(header)          osip_from_get_url((osip_from_t*)header)
  87 /**
  88  * Get a header parameter from a Record-Route element.
  89  * @param header The element to work on.
  90  * @param pos The index of the element to get.
  91  * @param dest A pointer on the element found.
  92  */
  93 #define osip_record_route_param_get(header,pos,dest)  osip_from_param_get((osip_from_t*)header,pos,dest)
  94 /**
  95  * Allocate and add a generic parameter element in a list.
  96  * @param header The element to work on.
  97  * @param name The token name.
  98  * @param value The token value.
  99  */
 100 #define osip_record_route_param_add(header,name,value) osip_generic_param_add((header)->gen_params,name,value)
 101 /**
 102  * Find a header parameter in a Record-Route element.
 103  * @param header The element to work on.
 104  * @param name The token name to search.
 105  * @param dest A pointer on the element found.
 106  */
 107 #define osip_record_route_param_get_byname(header,name,dest) osip_generic_param_get_byname((header)->gen_params,name,dest)
 108
 109 #ifdef __cplusplus
 110 }
 111 #endif
 112
 113 /** @} */
 114
 115 #endif