mirror of https://github.com/sipwise/kamailio.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
130 lines
3.8 KiB
130 lines
3.8 KiB
/*
|
|
* $Id$
|
|
*
|
|
* Copyright (c) 2006 SOMA Networks, Inc. <http://www.somanetworks.com/>
|
|
*
|
|
* This file is part of Kamailio, a free SIP server.
|
|
*
|
|
* Kamailio 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
|
|
*
|
|
* Kamailio 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)
|
|
*/
|
|
|
|
/*!
|
|
* \file
|
|
* \brief SST parser
|
|
* \ingroup parser
|
|
*/
|
|
|
|
#ifndef PARSE_SST_H
|
|
#define PARSE_SST_H 1
|
|
|
|
|
|
#include "../../parser/msg_parser.h"
|
|
#include "../../parser/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 {
|
|
hf_parsed_free_f hfree; /* function to free the content */
|
|
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 * );
|
|
|
|
|
|
/*!
|
|
* \brief Parses the (should be only one instance) single instance of the
|
|
* "Session-Expires" or "x" header in the msg.
|
|
* \note 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 );
|
|
|
|
|
|
/*!
|
|
* \brief Parses the (should be only one instance) single instance of the
|
|
* "Min-SE" header in the msg.
|
|
* \note The 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 */
|