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
122
|
/*
* $Id: parse_sst.h,v 1.1 2006/02/28 18:56:09 bogdan_iancu Exp $
*
* Copyright (c) 2006 SOMA Networks, Inc. <http://www.somanetworks.com/>
*
* This file is part of openser, a free SIP server.
*
* openser is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version
*
* openser 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* History:
* --------
* 2006-02-17 Initial revision (dhsueh@somanetworks.com)
*/
#ifndef PARSE_SST_H
#define PARSE_SST_H 1
#include "msg_parser.h"
#include "hf.h"
/**
* Indicate the "refresher=" value of the Session-Expires header.
*/
enum sst_refresher {
sst_refresher_unspecified,
sst_refresher_uac,
sst_refresher_uas,
};
/**
* We will treat the 'void* parsed' field of struct hdr_field as
* a pointer to a struct session_expires.
*/
struct session_expires {
unsigned interval; /* in seconds */
enum sst_refresher refresher;
};
enum parse_sst_result {
parse_sst_success,
parse_sst_header_not_found, /* no header */
parse_sst_no_value, /* no interval specified */
#if NOT_IMPLEMENTED_YET
parse_sst_duplicate, /* multiple s-e / x / min-se headers found */
#endif
parse_sst_out_of_mem,
parse_sst_parse_error, /* something puked */
};
/**
* Allocate a zeroed-out struct session_expires.
*/
struct session_expires *
malloc_session_expires( void );
/**
* Deallocates memory previously allocated via malloc_session_expires().
*/
void
free_session_expires( struct session_expires * );
/**
* Parses the (should be only one instance) single instance of the
* "Session-Expires" or "x" header in the msg. Note that the header
* is not automatically parsed in parse_headers()[1] so you'll have to
* call this function to get the information.
*
* Because of time constraints, this function is coded assuming there is
* NO WHITESPACE in any of the body -- note that the augBNF for the
* Session-Expires body allows sep whitespace between tokens:
* delta-seconds SWS ";" SWS "refresher" SWS "=" SWS ( "uac" / "uas" )
*
* Note[1]: it looks like only the frequently-used headers are
* automatically parsed in parse_headers() (indicated by a parse_<name>
* function of the form "char* parse_<name>(char *buf, char *end, foo*)
* and a struct foo with a member called "error").
*
* @param msg the sip message to examine
* @param se the place to store session-expires information into, if
* provided; note that result is also available in
* *((struct session_expires *)msg->session_expires->parsed)
* @return parse_sst_result
*/
enum parse_sst_result
parse_session_expires( struct sip_msg *msg, struct session_expires *se );
/**
* Parses the (should be only one instance) single instance of the
* "Min-SE" header in the msg. Note that this header is not automatically
* parsed in parse_headers() so you'll have to call this function to get
* the information.
*
* @param msg the sip message to examine
* @param min_se the place to store the Min-SE value, if provided; note that
* result is also available in (unsigned)msg->min_se->parsed
* @return parse_sst_result
*/
enum parse_sst_result
parse_min_se( struct sip_msg *msg, unsigned *min_se );
#endif /* ! PARSE_SST_H */
|
