Kamailio - The Open Source SIP Server: mod

00001 /*
00002  *$Id: mod_fix.h 5132 2008-10-24 11:49:14Z 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 
00023 /*!
00024  * \file
00025  * \brief Generic fixup functions for module function parameter.
00026  */
00027 
00028 #ifndef _mod_fix_h_
00029 #define _mod_fix_h_
00030 
00031 #include "pvar.h"
00032 
00033 #define GPARAM_TYPE_INT    0
00034 #define GPARAM_TYPE_STR    1
00035 #define GPARAM_TYPE_PVS    2
00036 #define GPARAM_TYPE_PVE    3
00037 
00038 /*!
00039  * generic parameter that holds a string, an int or a pseudo-variable
00040  */
00041 typedef struct _gparam
00042 {
00043    int type;
00044    union {
00045       int ival;
00046       str sval;
00047       pv_spec_t *pvs;
00048       pv_elem_t *pve;
00049    } v;
00050 } gparam_t, *gparam_p;
00051 
00052 int fixup_str_null(void** param, int param_no);
00053 int fixup_str_str(void** param, int param_no);
00054 
00055 int fixup_free_str_null(void** param, int param_no);
00056 int fixup_free_str_str(void** param, int param_no);
00057 
00058 int fixup_uint_null(void** param, int param_no);
00059 int fixup_uint_uint(void** param, int param_no);
00060 
00061 #if 0
00062 int fixup_sint_null(void** param, int param_no);
00063 int fixup_sint_sint(void** param, int param_no);
00064 int fixup_sint_uint(void** param, int param_no);
00065 int fixup_uint_sint(void** param, int param_no);
00066 #endif
00067 
00068 int fixup_regexp_null(void** param, int param_no);
00069 int fixup_regexpNL_null(void** param, int param_no);
00070 int fixup_free_regexp_null(void** param, int param_no);
00071 int fixup_regexp_none(void** param, int param_no);
00072 int fixup_regexpNL_none(void** param, int param_no);
00073 int fixup_free_regexp_none(void** param, int param_no);
00074 
00075 int fixup_pvar_null(void **param, int param_no);
00076 int fixup_free_pvar_null(void** param, int param_no);
00077 
00078 int fixup_pvar_pvar(void **param, int param_no);
00079 int fixup_free_pvar_pvar(void** param, int param_no);
00080 
00081 int fixup_pvar_str(void** param, int param_no);
00082 int fixup_free_pvar_str(void** param, int param_no);
00083 
00084 int fixup_pvar_str_str(void** param, int param_no);
00085 int fixup_free_pvar_str_str(void** param, int param_no);
00086 
00087 int fixup_igp_igp(void** param, int param_no);
00088 int fixup_igp_null(void** param, int param_no);
00089 int fixup_get_ivalue(struct sip_msg* msg, gparam_p gp, int *val);
00090 
00091 int fixup_igp_pvar_pvar(void** param, int param_no);
00092 int fixup_free_igp_pvar_pvar(void** param, int param_no);
00093 
00094 int fixup_spve_spve(void** param, int param_no);
00095 int fixup_spve_null(void** param, int param_no);
00096 int fixup_spve_uint(void** param, int param_no);
00097 int fixup_spve_str(void** param, int param_no);
00098 int fixup_get_svalue(struct sip_msg* msg, gparam_p gp, str *val);
00099 
00100 
00101 int fixup_pvar(void **param);
00102 
00103 #endif