rpid.h

Go to the documentation of this file.
00001 /*
00002  * $Id: rpid.h 5211 2008-11-17 20:05:27Z henningw $
00003  *
00004  * Copyright (C) 2001-2003 FhG Fokus
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  * History:
00023  * --------
00024  * 2003-04-28 rpid contributed by Juha Heinanen added (janakj)
00025  * 2005-05-31 general avp specification added for rpid (bogdan)
00026  */
00027 
00028 /*!
00029  * \file
00030  * \brief Remote-Party-ID related functions
00031  * \ingroup auth
00032  * - Module: \ref auth
00033  */
00034 
00035 #ifndef RPID_H
00036 #define RPID_H
00037 
00038 #include "../../parser/msg_parser.h"
00039 #include "../../str.h"
00040 #include "../../usr_avp.h"
00041 
00042 
00043 /*!
00044  * \brief Parse and set the RPID AVP specs
00045  * \param rpid_avp_param RPID AVP parameter
00046  * \return 0 on success, -1 on failure
00047  */
00048 int init_rpid_avp(char *rpid_avp_param);
00049 
00050 
00051 /*!
00052  * \brief Gets the RPID avp specs
00053  * \param rpid_avp_p AVP name
00054  * \param rpid_avp_type_p AVP type
00055  */
00056 void get_rpid_avp( int_str *rpid_avp_p, int *rpid_avp_type_p );
00057 
00058 
00059 /*!
00060  * \brief Append RPID header field to the message
00061  * \param _m SIP message
00062  * \param _s1 unused
00063  * \param _s2 unused
00064  * \return 1 on success, -1 on failure
00065  */
00066 int append_rpid_hf(struct sip_msg* _m, char* _s1, char* _s2);
00067 
00068 
00069 /*!
00070  * \brief Append RPID header field to the message with parameters
00071  * \param _m SIP message
00072  * \param _prefix prefix
00073  * \param _suffix suffix
00074  * \return 1 on success, -1 on failure
00075  */
00076 int append_rpid_hf_p(struct sip_msg* _m, char* _prefix, char* _suffix);
00077 
00078 
00079 /*!
00080  * \brief Check if URI in RPID AVP contains an E164 user part
00081  * \param _m SIP message
00082  * \param _s1 unused
00083  * \param _s2 unused
00084  * \return 1 if the URI contains an E164 user part, -1 if not
00085  */
00086 int is_rpid_user_e164(struct sip_msg* _m, char* _s1, char* _s2);
00087 
00088 
00089 #endif