ul_mi.h

Go to the documentation of this file.
00001 /*
00002  * $Id: ul_mi.h 5194 2008-11-13 10:38:11Z henningw $
00003  *
00004  * Copyright (C) 2006 Voice Sistem SRL
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 /*! \file
00024  *  \brief USRLOC - Usrloc MI functions
00025  *  \ingroup usrloc
00026  */
00027 
00028 
00029 #ifndef _USRLOC_MI_H_
00030 #define _USRLOC_MI_H_
00031 
00032 #include "../../mi/mi.h"
00033 
00034 #define MI_USRLOC_RM           "ul_rm"
00035 #define MI_USRLOC_RM_CONTACT   "ul_rm_contact"
00036 #define MI_USRLOC_DUMP         "ul_dump"
00037 #define MI_USRLOC_FLUSH        "ul_flush"
00038 #define MI_USRLOC_ADD          "ul_add"
00039 #define MI_USRLOC_SHOW_CONTACT "ul_show_contact"
00040 
00041 
00042 /*!
00043  * \brief Delete a address of record including its contacts
00044  * \param cmd mi_root containing the parameter
00045  * \param param not used
00046  * \note expects 2 nodes: the table name and the AOR
00047  * \return mi_root with the result
00048  */
00049 struct mi_root* mi_usrloc_rm_aor(struct mi_root *cmd, void *param);
00050 
00051 
00052 /*!
00053  * \brief Delete a contact from an AOR record
00054  * \param cmd mi_root containing the parameter
00055  * \param param not used
00056  * \note expects 3 nodes: the table name, the AOR and contact
00057  * \return mi_root with the result or 0 on failure
00058  */
00059 struct mi_root* mi_usrloc_rm_contact(struct mi_root *cmd, void *param);
00060 
00061 
00062 /*!
00063  * \brief Dump the content of the usrloc
00064  * \param cmd mi_root containing the parameter
00065  * \param param not used
00066  * \return mi_root with the result or 0 on failure
00067  */
00068 struct mi_root* mi_usrloc_dump(struct mi_root *cmd, void *param);
00069 
00070 
00071 /*!
00072  * \brief Flush the usrloc memory cache to DB
00073  * \param cmd mi_root containing the parameter
00074  * \param param not used
00075  * \return mi_root with the result or 0 on failure
00076  */
00077 struct mi_root* mi_usrloc_flush(struct mi_root *cmd, void *param);
00078 
00079 
00080 /*!
00081  * \brief Add a new contact for an address of record
00082  * \param cmd mi_root containing the parameter
00083  * \param param not used
00084  * \note Expects 7 nodes: table name, AOR, contact, expires, Q,
00085  * useless - backward compatible, flags, cflags, methods
00086  * \return mi_root with the result
00087  */
00088 struct mi_root* mi_usrloc_add(struct mi_root *cmd, void *param);
00089 
00090 
00091 /*!
00092  * \brief Dumps the contacts of an AOR
00093  * \param cmd mi_root containing the parameter
00094  * \param param not used
00095  * \note expects 2 nodes: the table name and the AOR
00096  * \return mi_root with the result or 0 on failure
00097  */
00098 struct mi_root* mi_usrloc_show_contact(struct mi_root *cmd, void *param);
00099 
00100 
00101 #endif