core: fix another bunch of 'no real prototype' warnings, add doxygen docs
[sip-router] / pv_core.c
1 /* 
2  * $Id$
3  * 
4  * Copyright (C) 2009 iptelorg GmbH
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 /*
19  * pv_core.c - pvars needed in the core, e.g. $?, $retcode
20  *
21  * Note: in general please avoid adding pvars directly to the core, unless
22  * absolutely necessary (use/create a new module instead).
23  */
24
25 /*!
26  * \file
27  * \brief SIP-router core :: 
28  * \ingroup core
29  * Module: \ref core
30  */
31
32 #include "pv_core.h"
33 #include "pvar.h"
34 #include "str.h"
35
36 static int pv_get_retcode(struct sip_msg*, pv_param_t*, pv_value_t*);
37
38 static pv_export_t core_pvs[] = {
39         /* return code, various synonims */
40         { STR_STATIC_INIT("?"), PVT_OTHER, pv_get_retcode, 0, 0, 0, 0, 0 },
41         { STR_STATIC_INIT("rc"), PVT_OTHER, pv_get_retcode, 0, 0, 0, 0, 0 },
42         { STR_STATIC_INIT("retcode"), PVT_OTHER, pv_get_retcode, 0, 0, 0, 0, 0 },
43         
44         { {0, 0}, 0, 0, 0, 0, 0, 0, 0 }
45 };
46
47
48 /* ugly hack to get the return code, needed because the PVs do not know (yet)
49    about the script context */
50 extern int _last_returned_code;
51
52 static int pv_get_retcode(struct sip_msg* msg, pv_param_t* p, pv_value_t* res)
53 {
54         /* FIXME: as soon as PVs support script context, use it instead of the
55                   return in global variable hack */
56         return pv_get_sintval(msg, p, res, _last_returned_code);
57 }
58
59
60
61 /** register built-in core pvars.
62  * should be called before parsing the config script.
63  * @return 0 on success 
64  */
65 int pv_register_core_vars(void)
66 {
67         return register_pvars_mod("core", core_pvs);
68 }
69
70 /* vi: set ts=4 sw=4 tw=79:ai:cindent: */