doxygen: small syntax fix in cfg support and sl module
[sip-router] / modules / sl / sl.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2001-2006 FhG FOKUS
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License 
24  * along with this program; if not, write to the Free Software 
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  */
27
28 /**
29  * @file
30  * @brief SL - API definitions
31  * @ingroup sl
32  * Module: @ref sl
33  */
34 #ifndef _SL_H_
35 #define _SL_H_
36
37 #include "../../sr_module.h"
38 #include "../../parser/msg_parser.h"
39
40 /* callback for SL events */
41 #define SLCB_REPLY_READY       (1<<0)  /* stateless reply ready to be sent */
42 #define SLCB_ACK_FILTERED      (1<<1)  /* stateless ACK filtered */
43
44 /**
45  * @brief SL callback parameter structure
46  */
47 typedef struct sl_cbp {
48         unsigned int type;     /* type of callback */
49         sip_msg_t *req;        /* SIP request to reply to, or filtered ACK */
50         int  code;             /* reply status code */
51         str  *reason;          /* reply reason phrase */
52         str  *reply;           /* raw content of the reply to be sent */
53         struct dest_info *dst; /* info about destination address */
54         void *cbp;             /* parameter from callback registration */
55 } sl_cbp_t;
56
57 /**
58  * @brief SL callback function prototype
59  */
60 typedef void (*sl_cbf_f)(sl_cbp_t *slcbp);
61
62 /**
63  * @brief SL callback structure definition
64  */
65 typedef struct sl_cbelem {
66         unsigned int type;         /* type of callback - can be a mask of types */
67         sl_cbf_f cbf;              /* pointer to callback function */
68         void *cbp;                 /* param to callback function */
69         struct sl_cbelem* next;    /* next sl_cbelem value */
70 } sl_cbelem_t;
71
72 void sl_destroy_callbacks_list(void);
73
74 typedef int (*sl_register_cb_f)(sl_cbelem_t *cbe);
75 int sl_register_callback(sl_cbelem_t *cbe);
76
77 void sl_run_callbacks(unsigned int type, struct sip_msg *req,
78                 int code, char *reason, str *reply, struct dest_info *dst);
79
80 /* prototypes for SL API funtions */
81 typedef int (*get_reply_totag_f)(struct sip_msg *msg, str *tag);
82 typedef int (*send_reply_f)(struct sip_msg *msg, int code, str *reason);
83 typedef int (*sl_send_reply_f)(struct sip_msg *msg, int code, char *reason);
84 typedef int (*sl_send_sreply_f)(struct sip_msg *msg, int code, str *reason);
85 typedef int (*sl_send_dreply_f)(struct sip_msg *msg, int code, str *reason,
86                 str *tag);
87
88 /**
89  * @brief Stateless (sl) API structure
90  */
91 typedef struct sl_api {
92         sl_send_reply_f  zreply; /* send sl reply, reason is charz */
93         sl_send_sreply_f sreply; /* send sl reply, reason is str */
94         sl_send_dreply_f dreply; /* send sl reply with tag, reason is str */
95         send_reply_f     freply; /* send sl reply with tag, reason is str */
96         get_reply_totag_f get_reply_totag;
97         sl_register_cb_f  register_cb;
98 } sl_api_t;
99
100 typedef int (*bind_sl_f)(sl_api_t* api);
101
102 /**
103  * @brief Load the SL API
104  */
105 static inline int sl_load_api(sl_api_t *slb)
106 {
107         bind_sl_f bindsl;
108
109         bindsl = (bind_sl_f)find_export("bind_sl", 0, 0);
110         if ( bindsl == 0) {
111                 LM_ERR("cannot find bind_sl\n");
112                 return -1;
113         }
114         if (bindsl(slb)==-1)
115         {
116                 LM_ERR("cannot bind sl api\n");
117                 return -1;
118         }
119         return 0;
120 }
121
122 #endif /* _SL_H_ */