- per new dialog callback, called each time a new UAS (DLG_CB_UAS) or UAC
[sip-router] / modules / tm / dlg.h
1 /*
2  * $Id$
3  * Copyright (C) 2001-2003 FhG Fokus
4  *
5  * This file is part of ser, a free SIP server.
6  *
7  * ser is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version
11  *
12  * For a license to use the ser software under conditions
13  * other than those described here, or to purchase support for this
14  * software, please contact iptel.org by e-mail at the following addresses:
15  *   info@iptel.org
16  *
17  * ser is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25  *
26  * History:
27  * -------
28  * 2003-03-29 Created by janakj
29  * 2007-04-13 added dialog callbacks (andrei)
30  */
31
32 #ifndef DLG_H
33 #define DLG_H
34
35
36 #include <stdio.h>
37 #include "../../str.h"
38 #include "../../parser/parse_rr.h"
39 #include "../../parser/msg_parser.h"
40
41 /*
42 #define DIALOG_CALLBACKS
43 */
44
45 #ifdef DIALOG_CALLBACKS
46 #include "t_hooks.h"
47 #include "h_table.h"
48
49 #define DLG_CB_UAC 30
50 #define DLG_CB_UAS 31
51
52 #endif /* DIALOG_CALLBACKS */
53
54
55 /*
56  * Dialog sequence
57  */
58 typedef struct dlg_seq {
59         unsigned int value;    /* Sequence value */
60         unsigned char is_set;  /* is_set flag */
61 } dlg_seq_t;
62
63
64 /*
65  * Dialog state
66  */
67 typedef enum dlg_state {
68         DLG_NEW = 0,   /* New dialog, no reply received yet */
69         DLG_EARLY,     /* Early dialog, provisional response received */
70         DLG_CONFIRMED, /* Confirmed dialog, 2xx received */
71         DLG_DESTROYED  /* Destroyed dialog */
72 } dlg_state_t;
73
74
75 /*
76  * Structure describing a dialog identifier
77  */
78 typedef struct dlg_id {
79         str call_id;    /* Call-ID */
80         str rem_tag;    /* Remote tag of the dialog */
81         str loc_tag;    /* Local tag of the dialog */
82 } dlg_id_t;
83
84
85 /*
86  * It is necessary to analyze the dialog data to find out
87  * what URI put into the Record-Route, where the message
88  * should be really sent and how to construct the route
89  * set of the message. This structure stores this information
90  * so we don't have to calculate each time we want to send a
91  * message within dialog
92  */
93 typedef struct dlg_hooks {
94         str ru;
95         str nh;
96         str* request_uri;   /* This should be put into Request-URI */
97         str* next_hop;      /* Where the message should be really sent */
98         rr_t* first_route;  /* First route to be printed into the message */
99         str* last_route;    /* If not zero add this as the last route */
100 } dlg_hooks_t;
101
102
103 /*
104  * Structure representing dialog state
105  */
106 typedef struct dlg {
107         dlg_id_t id;            /* Dialog identifier */
108         dlg_seq_t loc_seq;      /* Local sequence number */
109         dlg_seq_t rem_seq;      /* Remote sequence number */
110         str loc_uri;            /* Local URI */
111         str rem_uri;            /* Remote URI */
112         str rem_target;         /* Remote target URI */
113         str dst_uri;            /* Destination URI */
114         unsigned char secure;   /* Secure flag -- currently not used */
115         dlg_state_t state;      /* State of the dialog */
116         rr_t* route_set;        /* Route set */
117         dlg_hooks_t hooks;      /* Various hooks used to store information that
118                                  * can be reused when building a message (to
119                                  * prevent repeated analyzing of the dialog data
120                                  */
121 #ifdef DIALOG_CALLBACKS
122         struct tmcb_head_list dlg_callbacks;
123 #endif
124 } dlg_t;
125
126 typedef enum {
127         IS_TARGET_REFRESH,
128         IS_NOT_TARGET_REFRESH,
129         TARGET_REFRESH_UNKNOWN
130 } target_refresh_t;
131
132 /*
133  * Create a new dialog
134  */
135 int new_dlg_uac(str* _cid, str* _ltag, unsigned int _lseq, str* _luri, str* _ruri, dlg_t** _d);
136 typedef int (*new_dlg_uac_f)(str* _cid, str* _ltag, unsigned int _lseq, str* _luri, str* _ruri, dlg_t** _d);
137
138
139 /*
140  * A response arrived, update dialog
141  */
142 int dlg_response_uac(dlg_t* _d, struct sip_msg* _m, target_refresh_t is_target_refresh);
143 typedef int (*dlg_response_uac_f)(dlg_t* _d, struct sip_msg* _m, target_refresh_t is_target_refresh);
144
145 /*
146  * Establishing a new dialog, UAS side
147  */
148 int new_dlg_uas(struct sip_msg* _req, int _code, /*str* _tag,*/ dlg_t** _d);
149 typedef int (*new_dlg_uas_f)(struct sip_msg* _req, int _code, dlg_t** _d);
150
151 /*
152  * UAS side - update dialog state and to tag
153  */
154 int update_dlg_uas(dlg_t *_d, int _code, str* _tag);
155 typedef int (*update_dlg_uas_f)(dlg_t *_d, int _code, str* _tag);
156
157 /*
158  * UAS side - update a dialog from a request
159  */
160 int dlg_request_uas(dlg_t* _d, struct sip_msg* _m, target_refresh_t is_target_request);
161 typedef int (*dlg_request_uas_f)(dlg_t* _d, struct sip_msg* _m, target_refresh_t is_target_request);
162
163
164 /*
165  * Destroy a dialog state
166  */
167 void free_dlg(dlg_t* _d);
168 typedef void (*free_dlg_f)(dlg_t* _d);
169
170
171 /*
172  * Print a dialog structure, just for debugging
173  */
174 void print_dlg(FILE* out, dlg_t* _d);
175 typedef void (*print_dlg_f)(FILE* out, dlg_t* _d);
176
177
178 /*
179  * Calculate length of the route set
180  */
181 int calculate_routeset_length(dlg_t* _d);
182
183
184 /*
185  *
186  * Print the route set
187  */
188 char* print_routeset(char* buf, dlg_t* _d);
189
190 /*
191  * wrapper to calculate_hooks
192  * added by dcm
193  */
194 int w_calculate_hooks(dlg_t* _d);
195 typedef int (*calculate_hooks_f)(dlg_t* _d);
196
197 /*
198  * set dialog's request uri and destination uri (optional)
199  */
200 int set_dlg_target(dlg_t* _d, str* _ruri, str* _duri);
201 typedef int (*set_dlg_target_f)(dlg_t* _d, str* _ruri, str* _duri);
202
203 #ifdef DIALOG_CALLBACKS
204
205 /* dialog callback
206  * params:  type - DLG_UAC or DLG_UAS
207  *          dlg  - dialog structure
208  *          msg  - message used for creating the new dialog for the new_dlg_uas
209  *                 case, 0 otherwise (new_dlg_uac)
210  */
211 typedef void (dialog_cb) (int type, dlg_t* dlg, struct sip_msg* msg);
212
213 /* callbacks for new dialogs (called each time a new dialog (uas or uac) is
214  * created). Can be used for installing in-dialog callbacks
215  * returns < 0 on error*/
216 int register_new_dlg_cb(int types, dialog_cb f, void* param);
217 /* callbacks for messages sent dialogs */
218 int register_dlg_tmcb(int type, dlg_t* dlg, transaction_cb f, void* param);
219 void run_trans_dlg_callbacks(dlg_t* dlg, struct cell* trans,
220                                                                 struct retr_buf* rbuf);
221 /* cleanup on exit */
222 void destroy_new_dlg_cbs();
223 #endif /* DIALOG_CALLBACKS */
224
225
226 #endif /* DLG_H */