osip_route.h
3.54 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*
The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
Copyright (C) 2001-2020 Aymeric MOIZARD amoizard@antisip.com
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 _OSIP_RECORD_H_
#define _OSIP_RECORD_H_
#include <osipparser2/headers/osip_from.h>
/**
* @file osip_route.h
* @brief oSIP osip_route header definition.
*/
/**
* @defgroup oSIP_ROUTE oSIP route header definition.
* @ingroup oSIP_HEADERS
* @{
*/
/**
* Structure for Route headers.
* @var osip_route_t
*/
typedef osip_from_t osip_route_t;
#ifdef __cplusplus
extern "C" {
#endif
#ifndef MINISIZE
/**
* Allocate a Route element.
* @param header The element to work on.
*/
int osip_route_init(osip_route_t **header);
/**
* Free a Route element.
* @param header The element to work on.
*/
void osip_route_free(osip_route_t *header);
/**
* Parse a Route element.
* @param header The element to work on.
* @param hvalue The string to parse.
*/
int osip_route_parse(osip_route_t *header, const char *hvalue);
/**
* Get a string representation of a Route element.
* @param header The element to work on.
* @param dest A pointer on the new allocated string.
*/
int osip_route_to_str(const osip_route_t *header, char **dest);
/**
* Clone a Route element.
* @param header The element to work on.
* @param dest A pointer on the copy of the element.
*/
#define osip_route_clone osip_from_clone
#else
#define osip_route_init osip_from_init
#define osip_route_free osip_from_free
#define osip_route_parse osip_from_parse
#define osip_route_to_str osip_from_to_str
#define osip_route_clone osip_from_clone
#endif
/**
* Set the url in the Route element.
* @param header The element to work on.
* @param url The value of the element.
*/
#define osip_route_set_url(header, url) osip_from_set_url((osip_from_t *) header, url)
/**
* Get the url from a Route header.
* @param header The element to work on.
*/
#define osip_route_get_url(header) osip_from_get_url((osip_from_t *) header)
/**
* Get a header parameter from a Route element.
* @param header The element to work on.
* @param pos The index of the element to get.
* @param dest A pointer on the element found.
*/
#define osip_route_param_get(header, pos, dest) osip_from_param_get((osip_from_t *) header, pos, dest)
/**
* Allocate and add a generic parameter element in a Route element.
* @param header The element to work on.
* @param name The token name.
* @param value The token value.
*/
#define osip_route_param_add(header, name, value) osip_generic_param_add((&(header)->gen_params), name, value)
/**
* Find a header parameter in a Route element.
* @param header The element to work on.
* @param name The token name to search.
* @param dest A pointer on the element found.
*/
#define osip_route_param_get_byname(header, name, dest) osip_generic_param_get_byname((&(header)->gen_params), name, dest)
#ifdef __cplusplus
}
#endif
/** @} */
#endif