parse_ppi.h

Go to the documentation of this file.
00001 /*
00002  * $Id: parse_ppi.h 4720 2008-08-23 10:56:15Z henningw $
00003  *
00004  * Copyright (C) 2006 Juha Heinanen
00005  *
00006  * This file is part of Kamailio, a free SIP server.
00007  *
00008  * Kamailio is free software; you can redistribute it and/or modify
00009  * it under the terms of the GNU General Public License as published by
00010  * the Free Software Foundation; either version 2 of the License, or
00011  * (at your option) any later version
00012  *
00013  * Kamailio is distributed in the hope that it will be useful,
00014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016  * GNU General Public License for more details.
00017  *
00018  * You should have received a copy of the GNU General Public License 
00019  * along with this program; if not, write to the Free Software 
00020  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00021  *
00022  */
00023 
00024 /*!
00025  * \file
00026  * \brief P-Preferred-Identity header parser
00027  * \ingroup parser
00028  */
00029 
00030 #ifndef PARSE_PPI_H
00031 #define PARSE_PPI_H
00032 
00033 #include "msg_parser.h"
00034 
00035 
00036 /*! casting macro for accessing P-Preferred-Identity body */
00037 #define get_ppi(p_msg)  ((struct to_body*)(p_msg)->ppi->parsed)
00038 
00039 
00040 /*!
00041  * \brief This method is used to parse P-Preferred-Identity header (RFC 3325).
00042  *
00043  * Currently only one name-addr / addr-spec is supported in the header
00044  * and it must contain a sip or sips URI.
00045  * \param msg sip msg
00046  * \return 0 on success, -1 on failure.
00047  */
00048 int parse_ppi_header( struct sip_msg *msg);
00049 
00050 struct sip_uri *parse_ppi_uri(struct sip_msg *msg);
00051  
00052 #endif /* PARSE_PPI_H */