2 The oSIP library implements the Session Initiation Protocol (SIP -rfc2543-)
3 Copyright (C) 2001 Aymeric MOIZARD jack@atosc.org
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.
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.
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
21 #ifndef _OSIP_RECORD_H_
22 #define _OSIP_RECORD_H_
24 #include <osipparser2/headers/osip_from.h>
28 * @brief oSIP osip_route header definition.
32 * @defgroup oSIP_ROUTE oSIP route header definition.
33 * @ingroup oSIP_HEADERS
38 * Structure for Route headers.
39 * @defvar osip_route_t
41 typedef osip_from_t osip_route_t;
49 /* osip_route_init is already defined somewhere on VXWORKS.. */
50 int osip_route_init2 (osip_route_t ** header);
53 * Allocate a Route element.
54 * @param header The element to work on.
56 int osip_route_init (osip_route_t ** header);
59 * Free a Route element.
60 * @param header The element to work on.
62 void osip_route_free (osip_route_t * header);
64 * Parse a Route element.
65 * @param header The element to work on.
66 * @param hvalue The string to parse.
68 int osip_route_parse (osip_route_t * header, const char *hvalue);
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.
74 int osip_route_to_str (const osip_route_t * header, char **dest);
76 * Clone a Route element.
77 * @param header The element to work on.
78 * @param dest A pointer on the copy of the element.
80 #define osip_route_clone(header,dest) osip_from_clone(header,dest)
82 * Set the url in the Route element.
83 * @param header The element to work on.
84 * @param url The value of the element.
86 #define osip_route_set_url(header,url) osip_from_set_url((osip_from_t*)header,url)
88 * Get the url from a Route header.
89 * @param header The element to work on.
91 #define osip_route_get_url(header) osip_from_get_url((osip_from_t*)header)
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.
98 #define osip_route_param_get(header,pos,dest) osip_from_param_get((osip_from_t*)header,pos,dest)
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.
105 #define osip_route_param_add(header,name,value) osip_generic_param_add((header)->gen_params,name,value)
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.
112 #define osip_route_param_get_byname(header,name,dest) osip_generic_param_get_byname((header)->gen_params,name,dest)