all: updated FSF address in GPL text
[sip-router] / modules / rr / rr_cb.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2005 Voice Sistem SRL
5  *
6  * This file is part of Kamailio, a free SIP server.
7  *
8  * Kamailio is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * Kamailio is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21  */
22
23 /*!
24  * \file
25  * \brief Route & Record-Route module
26  * \ingroup rr
27  */
28
29 #ifndef RR_CB_H_
30 #define RR_CB_H_
31
32 #include "../../str.h"
33 #include "../../parser/msg_parser.h"
34
35
36 /*! \brief callback function prototype */
37 typedef void (rr_cb_t) (struct sip_msg* req, str *rr_param, void *param);
38 /*! \brief register callback function prototype */
39 typedef int (*register_rrcb_t)( rr_cb_t f, void *param);
40
41
42 /*! rr callback */
43 struct rr_callback {
44         int id;                         /*!< id of this callback - useless */
45         rr_cb_t* callback;              /*!< callback function */
46         void *param;                    /*!< param to be passed to callback function */
47         struct rr_callback* next; /*!< next callback element*/
48 };
49
50
51 /*!
52  * \brief destroy global callback list, frees memory
53  */
54 void destroy_rrcb_lists(void);
55
56
57 /*!
58  * \brief register a RR callback, allocates new private memory for it
59  * \param f callback register function
60  * \param param callback parameter
61  * \return 0 on success, -1 on failure (out of memory)
62  */
63 int register_rrcb(rr_cb_t f, void *param );
64
65
66 /*!
67  * \brief run RR transaction callbacks
68  * \param req SIP request
69  * \param rr_param callback list
70  */
71 void run_rr_callbacks( struct sip_msg *req, str *rr_param);
72
73
74 #endif