all: updated FSF address in GPL text
[sip-router] / modules / ims_usrloc_scscf / ul_callback.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2012 Smile Communications, jason.penton@smilecoms.com
5  * Copyright (C) 2012 Smile Communications, richard.good@smilecoms.com
6  * 
7  * The initial version of this code was written by Dragos Vingarzan
8  * (dragos(dot)vingarzan(at)fokus(dot)fraunhofer(dot)de and the
9  * Fruanhofer Institute. It was and still is maintained in a separate
10  * branch of the original SER. We are therefore migrating it to
11  * Kamailio/SR and look forward to maintaining it from here on out.
12  * 2011/2012 Smile Communications, Pty. Ltd.
13  * ported/maintained/improved by 
14  * Jason Penton (jason(dot)penton(at)smilecoms.com and
15  * Richard Good (richard(dot)good(at)smilecoms.com) as part of an 
16  * effort to add full IMS support to Kamailio/SR using a new and
17  * improved architecture
18  * 
19  * NB: Alot of this code was originally part of OpenIMSCore,
20  * FhG Fokus. 
21  * Copyright (C) 2004-2006 FhG Fokus
22  * Thanks for great work! This is an effort to 
23  * break apart the various CSCF functions into logically separate
24  * components. We hope this will drive wider use. We also feel
25  * that in this way the architecture is more complete and thereby easier
26  * to manage in the Kamailio/SR environment
27  *
28  * This file is part of Kamailio, a free SIP server.
29  *
30  * Kamailio is free software; you can redistribute it and/or modify
31  * it under the terms of the GNU General Public License as published by
32  * the Free Software Foundation; either version 2 of the License, or
33  * (at your option) any later version
34  *
35  * Kamailio is distributed in the hope that it will be useful,
36  * but WITHOUT ANY WARRANTY; without even the implied warranty of
37  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
38  * GNU General Public License for more details.
39  *
40  * You should have received a copy of the GNU General Public License 
41  * along with this program; if not, write to the Free Software 
42  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
43  * 
44  */
45
46 #ifndef _UL_CALLBACKS_H
47 #define _UL_CALLBACKS_H
48
49 #include "../../dprint.h"
50
51 /* forward declaration for ucontact_t */
52 struct ucontact;
53 struct impurecord;
54
55 #define UL_CONTACT_INSERT       (1<<0)
56 #define UL_CONTACT_UPDATE       (1<<1)
57 #define UL_CONTACT_DELETE       (1<<2)
58 #define UL_CONTACT_EXPIRE       (1<<3)
59 #define UL_IMPU_REG_NC_DELETE   (1<<4)          /* reg, no contacts - deleted */
60 #define UL_IMPU_NR_DELETE               (1<<5)          /* Not registered - deleted */
61 #define UL_IMPU_UNREG_EXPIRED   (1<<6)          /* Unregistered time expired */
62 #define UL_IMPU_DELETE                  (1<<7)          /* explicit impu delete - for example thru API */
63 #define UL_IMPU_INSERT                  (1<<8)          /* new IMPU record has been added */
64 #define UL_IMPU_UPDATE                  (1<<9)          /* IMPU record has been updated */
65 #define UL_IMPU_NEW_CONTACT             (1<<10)         /* a new contact has been inserted for this IMPU */
66 #define UL_IMPU_UPDATE_CONTACT          (1<<11)         /* a new contact has been inserted for this IMPU */
67 #define UL_IMPU_DELETE_CONTACT          (1<<12)         /* a new contact has been inserted for this IMPU */
68 #define UL_IMPU_EXPIRE_CONTACT          (1<<13)         /* a new contact has been inserted for this IMPU */
69 #define ULCB_MAX                ((1<<14)-1)
70
71 /*! \brief callback function prototype */
72 typedef void (ul_cb) (struct impurecord* r, struct ucontact *c, int type, void *param);
73 /*! \brief register callback function prototype */
74 typedef int (*register_ulcb_t)( struct impurecord* r, struct ucontact *c, int cb_types, ul_cb f, void *param);
75
76
77 struct ul_callback {
78         int id;                      /*!< id of this callback - useless */
79         int types;                   /*!< types of events that trigger the callback*/
80         ul_cb* callback;             /*!< callback function */
81         void *param;                 /*!< param to be passed to callback function */
82         struct ul_callback* next;
83 };
84
85 struct ulcb_head_list {
86         struct ul_callback *first;
87         int reg_types;
88 };
89
90
91 extern struct ulcb_head_list*  ulcb_list;
92
93
94 static inline int exists_ulcb_type(struct ulcb_head_list* list, int types) {
95         if (list==NULL)
96                 return (ulcb_list->reg_types|types);
97         else
98                 return (list->reg_types|types);
99 }
100
101 int init_ulcb_list(void);
102
103 void destroy_ulcb_list(void);
104
105
106 /*! \brief register a callback for several types of events */
107 int register_ulcb( struct impurecord* r, struct ucontact* c, int types, ul_cb f, void *param );
108
109 /*! \brief run all transaction callbacks for an event type */
110 static inline void run_ul_callbacks( struct ulcb_head_list* cb_list, int type , struct impurecord *r, struct ucontact *c)
111 {
112         struct ul_callback *cbp;
113
114         if (cb_list == NULL) { //must be for global list
115                 cb_list = ulcb_list;
116         }
117
118         for (cbp=cb_list->first; cbp; cbp=cbp->next)  {
119                 if(cbp->types&type) {
120                         LM_DBG("impurecord=%p, contact=%p, callback type %d/%d, id %d entered\n",
121                                 r, c, type, cbp->types, cbp->id );
122                         cbp->callback( r, c, type, cbp->param );
123                 }
124         }
125 }
126
127 #endif