domainpolicy.h

Go to the documentation of this file.
00001 /*
00002  * domainpolicy.h v 0.1 2002/12/27
00003  *
00004  * Copyright (C) 2002-2003 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 Header file for domainpolicy table relates functions
00027  */
00028 
00029 
00030 #ifndef DOMAINPOLICY_H
00031 #define DOMAINPOLICY_H
00032       
00033 
00034 #include "../../parser/msg_parser.h"
00035 
00036 /*! maximal length of a domain string */
00037 #define MAX_DOMAIN_SIZE 512
00038 
00039 /*! how many indirect DDDS naptr are we going to follow? */
00040 #define MAX_DDDS_RECURSIONS 5
00041 
00042 
00043 /*!
00044  * return codes of dp_can_connect
00045  * negative values means false, 0 stops execution
00046  * and discards the SIP request
00047  */
00048 #define DP_DDDS_RET_DNSERROR -2
00049 #define DP_DDDS_RET_NEGATIVE -1  
00050 #define DP_DDDS_RET_POSITIVE 1
00051 #define DP_DDDS_RET_NOTFOUND 2
00052 
00053 
00054 /*!
00055  * \brief Check if host in Request URI has DP-DDDS NAPTRs and if we can connect to them
00056  * \param _msg SIP message
00057  * \param _s1 unused
00058  * \param _s2 unused
00059  * \return negative on failure, positive on success
00060  */
00061 int dp_can_connect(struct sip_msg* _msg, char* _s1, char* _s2);
00062 
00063 
00064 /*!
00065  * \brief Apply DP-DDDS policy to current SIP message
00066  *
00067  * Apply DP-DDDS policy to current SIP message. This means
00068  * build a new destination URI from the policy AVP and export it
00069  * as AVP. Then in kamailio.cfg this new target AVP can be pushed
00070  * into the destination URI $duri
00071  * \param _msg SIP message
00072  * \param _s1 unused
00073  * \param _s2 unused
00074  * \return negative on failure, positive on succes
00075  */
00076 int dp_apply_policy(struct sip_msg* _msg, char* _s1, char* _s2);
00077 
00078 
00079 /*!
00080  * \brief Bind the database interface
00081  * \param db_url database url
00082  * \return -1 on failure, 0 on success
00083  */
00084 int domainpolicy_db_bind(const str* db_url);
00085 
00086 
00087 /*!
00088  * \brief Initialize the database connection
00089  * \param db_url database url
00090  * \return -1 on failure, 0 on success
00091  */
00092 int domainpolicy_db_init(const str* db_url);
00093 
00094 /*!
00095  * \brief Close the database connection
00096  */
00097 void domainpolicy_db_close(void);
00098 
00099 
00100 /*!
00101  * \brief Check the database table version
00102  * \param db_url database URL
00103  * \param name table name
00104  * \return -1 on failure, positive database version on success
00105  */
00106 int domainpolicy_db_ver(const str* db_url, const str* name);
00107 
00108 
00109 #endif