osip_header.h
3.3 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
/*
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_HEADER_H_
#define _OSIP_HEADER_H_
#include <osipparser2/osip_uri.h>
/**
* @file osip_header.h
* @brief oSIP osip_header definition.
*
*/
/**
* @defgroup oSIP_HEADER oSIP header definition.
* @ingroup oSIP_HEADERS
* @{
*/
/**
* Structure for 'unknown' headers.
* NOTE: 'unknown' header' are used in oSIP for all header that are not
* defined by oSIP in the osip_message_t structure. This means that all
* 'unknown' header has to be handled with the API related to this
* structure.
* @var osip_header_t
*/
typedef struct osip_header osip_header_t;
/**
* Definition of a generic sip header.
* @struct osip_header
*/
struct osip_header {
char *hname; /**< Name of header */
char *hvalue; /**< Value for header */
};
/**
* Structure for generic parameter headers.
* Generic parameter are used in a lot of headers. (To, From, Route,
* Record-Route...) All those headers use a common API but this is
* hidden by MACROs that you can be found in smsg.h.
* @var osip_generic_param_t
*/
typedef osip_uri_param_t osip_generic_param_t;
#ifdef __cplusplus
extern "C" {
#endif
/**
* Allocate a header element.
* @param header The element to work on.
*/
int osip_header_init(osip_header_t **header);
/**
* Free a header element.
* @param header The element to work on.
*/
void osip_header_free(osip_header_t *header);
/**
* Get a string representation of a header element.
* @param header The element to work on.
* @param dest A pointer on the new allocated buffer.
*/
int osip_header_to_str(const osip_header_t *header, char **dest);
/**
* Get the token name a header element.
* @param header The element to work on.
*/
char *osip_header_get_name(const osip_header_t *header);
/**
* Set the token name a header element.
* @param header The element to work on.
* @param pname The token name to set.
*/
void osip_header_set_name(osip_header_t *header, char *pname);
/**
* Get the token value a header element.
* @param header The element to work on.
*/
char *osip_header_get_value(const osip_header_t *header);
/**
* Set the token value a header element.
* @param header The element to work on.
* @param pvalue The token value to set.
*/
void osip_header_set_value(osip_header_t *header, char *pvalue);
/**
* Clone a header element.
* @param header The element to work on.
* @param dest A pointer on the copy of the element.
*/
int osip_header_clone(const osip_header_t *header, osip_header_t **dest);
#ifdef __cplusplus
}
#endif
/** @} */
#endif