core: dset - function to push a new branch and return its pointer
[sip-router] / src / core / dset.h
1 /*
2  * Copyright (C) 2001-2004 FhG FOKUS
3  *
4  * This file is part of Kamailio, a free SIP server.
5  *
6  * Kamailio is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version
10  *
11  * Kamailio is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License 
17  * along with this program; if not, write to the Free Software 
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19  */
20
21 /*!
22  * \file
23  * \brief Kamailio core :: Destination set handling
24  * \ingroup core
25  * Module: \ref core
26  */
27
28 #ifndef _DSET_H
29 #define _DSET_H
30
31 #include "ip_addr.h"
32 #include "qvalue.h"
33 #include "flags.h"
34 #include "parser/msg_parser.h"
35
36
37 extern unsigned int nr_branches;
38 extern int ruri_is_new;
39
40 #define DS_FLAGS    1
41 #define DS_PATH     2
42
43 /*! \brief
44  * Structure for storing branch attributes
45  */
46 struct branch
47 {
48     char uri[MAX_URI_SIZE];
49     unsigned int len;
50
51     /* Real destination of the request */
52     char dst_uri[MAX_URI_SIZE];
53     unsigned int dst_uri_len;
54
55     /* Path set */
56     char path[MAX_PATH_SIZE];
57     unsigned int path_len;
58
59     int q; /* Preference of the contact among
60         * contact within the array */
61     struct socket_info* force_send_socket;
62
63     /* +sip.instance contact header param value */
64     char instance[MAX_INSTANCE_SIZE];
65     unsigned int instance_len;
66
67     /* reg-id contact header param value */
68     unsigned int reg_id;
69
70     /* ruid value from usrloc */
71     char ruid[MAX_RUID_SIZE];
72     unsigned int ruid_len;
73
74     char location_ua[MAX_UA_SIZE + 1];
75     unsigned int location_ua_len;
76
77         /* tcp connection id */
78         int otcpid;
79
80     /* Branch flags */
81     flag_t flags;
82 };
83
84 typedef struct branch branch_t;
85
86 /*! \brief
87  * Return pointer to branch[idx] structure
88  */
89 branch_t *get_sip_branch(int idx);
90
91 /*! \brief
92  * Drop branch[idx]
93  */
94 int drop_sip_branch(int idx);
95
96 /*! \brief
97  * Push a new branch to current destination set
98  */
99 branch_t *ksr_push_branch(sip_msg_t* msg, str* uri, str* dst_uri, str* path,
100                   qvalue_t q, unsigned int flags,
101                   struct socket_info* force_socket,
102                   str* instance, unsigned int reg_id,
103                   str* ruid, str* location_ua);
104
105 /*! \brief
106  * Add a new branch to current destination set
107  */
108 int append_branch(struct sip_msg* msg, str* uri, str* dst_uri, str* path,
109                   qvalue_t q, unsigned int flags,
110                   struct socket_info* force_socket,
111                   str* instance, unsigned int reg_id,
112                   str* ruid, str* location_ua);
113
114 /*! \brief kamailio compatible version */
115 #define km_append_branch(msg, uri, dst_uri, path, q, flags, force_socket) \
116     append_branch(msg, uri, dst_uri, path, q, flags, force_socket, 0, 0, 0, 0)
117
118 /*! \brief ser compatible append_branch version.
119  *  append_branch version compatible with ser: no path or branch flags support
120  *  and no str parameters.
121  */
122 static inline int ser_append_branch(struct sip_msg* msg,
123                                     char* uri, int uri_len,
124                                     char* dst_uri, int dst_uri_len,
125                                     qvalue_t q,
126                                     struct socket_info* force_socket)
127 {
128     str s_uri, s_dst_uri;
129     s_uri.s=uri;
130     s_uri.len=uri_len;
131     s_dst_uri.s=dst_uri;
132     s_dst_uri.len=dst_uri_len;
133     return append_branch(msg, &s_uri, &s_dst_uri, 0, q, 0, force_socket, 0, 0, 0, 0);
134 }
135
136
137
138 /*! \brief
139  * Init the index to iterate through the list of transaction branches
140  */
141 void init_branch_iterator(void);
142
143 /*! \brief
144  * Return branch iterator position
145  */
146 int get_branch_iterator(void);
147
148 /*! \brief
149  * Set branch iterator position
150  */
151 void set_branch_iterator(int n);
152
153 /*! \brief Get the next branch in the current transaction.
154  * @return pointer to the uri of the next branch (which the length written in
155  *  *len) or 0 if there are no more branches.
156  */
157 char* next_branch(int* len, qvalue_t* q, str* dst_uri, str* path,
158                   unsigned int* flags, struct socket_info** force_socket,
159                   str *ruid, str *instance, str *location_ua);
160
161 char* get_branch( unsigned int i, int* len, qvalue_t* q, str* dst_uri,
162                   str* path, unsigned int *flags,
163                   struct socket_info** force_socket,
164                   str* ruid, str *instance, str *location_ua);
165
166 /*! \brief
167  * Empty the array of branches
168  */
169 void clear_branches(void);
170
171
172 /*! \brief
173  * Create a Contact header field from the
174  * list of current branches
175  */
176 char* print_dset(struct sip_msg* msg, int* len, int options);
177
178
179 /*! \brief
180  * Set the q value of the Request-URI
181  */
182 void set_ruri_q(qvalue_t q);
183
184
185 /*! \brief
186  * Get src ip, port and proto as SIP uri or proxy address
187  */
188 int msg_get_src_addr(sip_msg_t *msg, str *uri, int mode);
189
190 /*! \brief
191  * Get the q value of the Request-URI
192  */
193 qvalue_t get_ruri_q(void);
194
195
196
197 /*
198  * Get actual Request-URI
199  */
200 inline static int get_request_uri(struct sip_msg* _m, str* _u)
201 {
202         *_u=*GET_RURI(_m);
203         return 0;
204 }
205
206
207 #define ruri_mark_new() (ruri_is_new = 1)
208
209 #define ruri_mark_consumed()  (ruri_is_new = 0)
210
211 /** returns whether or not ruri should be used when forking.
212   * (usefull for serial forking)
213   * @return 0 if already marked as consumed, 1 if not.
214  */
215 #define ruri_get_forking_state() (ruri_is_new)
216
217 int rewrite_uri(struct sip_msg* _m, str* _s);
218
219 /*! \brief
220  * Set a per-branch flag to 1.
221  *
222  * This function sets the value of one particular branch flag to 1.
223  * @param branch Number of the branch (0 for the main Request-URI branch)
224  * @param flag Number of the flag to be set (starting with 0)
225  * @return 1 on success, -1 on failure.
226  */
227 int setbflag(unsigned int branch, flag_t flag);
228
229 /*! \brief
230  * Reset a per-branch flag value to 0.
231  *
232  * This function resets the value of one particular branch flag to 0.
233  * @param branch Number of the branch (0 for the main Request-URI branch)
234  * @param flag Number of the flag to be reset (starting with 0)
235  * @return 1 on success, -1 on failure.
236  */
237 int resetbflag(unsigned int branch, flag_t flag);
238
239 /*! \brief
240  * Determine if a branch flag is set.
241  *
242  * This function tests the value of one particular per-branch flag.
243  * @param branch Number of the branch (0 for the main Request-URI branch)
244  * @param flag Number of the flag to be tested (starting with 0)
245  * @return 1 if the branch flag is set, -1 if not or on failure.
246  */
247 int isbflagset(unsigned int branch, flag_t flag);
248
249 /*! \brief
250  * Get the value of all branch flags for a branch
251  *
252  * This function returns the value of all branch flags
253  * combined in a single variable.
254  * @param branch Number of the branch (0 for the main Request-URI branch)
255  * @param res A pointer to a variable to store the result
256  * @return 1 on success, -1 on failure
257  */
258 int getbflagsval(unsigned int branch, flag_t* res);
259
260 /*! \brief
261  * Set the value of all branch flags at once for a given branch.
262  *
263  * This function sets the value of all branch flags for a given
264  * branch at once.
265  * @param branch Number of the branch (0 for the main Request-URI branch)
266  * @param val All branch flags combined into a single variable
267  * @return 1 on success, -1 on failure
268  */
269 int setbflagsval(unsigned int branch, flag_t val);
270
271 int uri_add_rcv_alias(sip_msg_t *msg, str *uri, str *nuri);
272 int uri_restore_rcv_alias(str *uri, str *nuri, str *suri);
273
274 int init_dst_set(void);
275
276 int set_aor_case_sensitive(int mode);
277
278 int get_aor_case_sensitive(void);
279
280 #endif /* _DSET_H */