3741fcbf5f00991eca394e04f117878a677c8c36
[sip-router] / dset.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2001-2004 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  * ser 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 /*!
24  * \file
25  * \brief SIP-router core :: Destination set handling
26  * \ingroup core
27  * Module: \ref core
28  */
29
30 #ifndef _DSET_H
31 #define _DSET_H
32
33 #include "ip_addr.h"
34 #include "qvalue.h"
35 #include "flags.h"
36 #include "parser/msg_parser.h"
37
38
39 extern unsigned int nr_branches;
40 extern int ruri_is_new;
41
42 /*! \brief
43  * Structure for storing branch attributes
44  */
45 struct branch
46 {
47     char uri[MAX_URI_SIZE];
48     unsigned int len;
49
50          /* Real destination of the request */
51     char dst_uri[MAX_URI_SIZE];
52     unsigned int dst_uri_len;
53
54     /* Path set */
55     char path[MAX_PATH_SIZE];
56     unsigned int path_len;
57
58     int q; /* Preference of the contact among
59         * contact within the array */
60     struct socket_info* force_send_socket;
61
62     /* +sip.instance contact header param value */
63     char instance[MAX_INSTANCE_SIZE];
64     unsigned int instance_len;
65
66     /* reg-id contact header param value */
67     unsigned int reg_id;
68
69     /* ruid value from usrloc */
70     char ruid[MAX_RUID_SIZE];
71     unsigned int ruid_len;
72
73     /* Branch flags */
74     flag_t flags;
75 };
76
77 typedef struct branch branch_t;
78
79 /*! \brief
80  * Return pointer to branch[idx] structure
81  */
82 branch_t *get_sip_branch(int idx);
83
84 /*! \brief
85  * Drop branch[idx]
86  */
87 int drop_sip_branch(int idx);
88
89 /*! \brief
90  * Add a new branch to current transaction 
91  */
92 int append_branch(struct sip_msg* msg, str* uri, str* dst_uri, str* path,
93                   qvalue_t q, unsigned int flags,
94                   struct socket_info* force_socket,
95                   str* instance, unsigned int reg_id,
96                   str* ruid);
97
98 /*! \brief kamailio compatible version */
99 #define km_append_branch(msg, uri, dst_uri, path, q, flags, force_socket) \
100     append_branch(msg, uri, dst_uri, path, q, flags, force_socket, 0, 0, 0)
101
102 /*! \brief ser compatible append_branch version.
103  *  append_branch version compatible with ser: no path or branch flags support
104  *  and no str parameters.
105  */
106 static inline int ser_append_branch(struct sip_msg* msg,
107                                     char* uri, int uri_len,
108                                     char* dst_uri, int dst_uri_len,
109                                     qvalue_t q,
110                                     struct socket_info* force_socket)
111 {
112     str s_uri, s_dst_uri;
113     s_uri.s=uri;
114     s_uri.len=uri_len;
115     s_dst_uri.s=dst_uri;
116     s_dst_uri.len=dst_uri_len;
117     return append_branch(msg, &s_uri, &s_dst_uri, 0, q, 0, force_socket, 0, 0, 0);
118 }
119
120
121
122 /*! \brief
123  * Init the index to iterate through the list of transaction branches
124  */
125 void init_branch_iterator(void);
126
127 /*! \brief
128  * Return branch iterator position
129  */
130 int get_branch_iterator(void);
131
132 /*! \brief
133  * Set branch iterator position
134  */
135 void set_branch_iterator(int n);
136
137 /*! \brief Get the next branch in the current transaction.
138  * @return pointer to the uri of the next branch (which the length written in
139  *  *len) or 0 if there are no more branches.
140  */
141 char* next_branch(int* len, qvalue_t* q, str* dst_uri, str* path,
142                   unsigned int* flags, struct socket_info** force_socket,
143                   str *ruid, str *instance);
144
145 char* get_branch( unsigned int i, int* len, qvalue_t* q, str* dst_uri,
146                   str* path, unsigned int *flags,
147                   struct socket_info** force_socket,
148                   str* ruid, str *instance);
149
150 /*! \brief
151  * Empty the array of branches
152  */
153 void clear_branches(void);
154
155
156 /*! \brief
157  * Create a Contact header field from the
158  * list of current branches
159  */
160 char* print_dset(struct sip_msg* msg, int* len);
161
162
163 /*! \brief
164  * Set the q value of the Request-URI
165  */
166 void set_ruri_q(qvalue_t q);
167
168
169 /*! \brief
170  * Get the q value of the Request-URI
171  */
172 qvalue_t get_ruri_q(void);
173
174
175
176 /*
177  * Get actual Request-URI
178  */
179 inline static int get_request_uri(struct sip_msg* _m, str* _u)
180 {
181         *_u=*GET_RURI(_m);
182         return 0;
183 }
184
185
186 #define ruri_mark_new() (ruri_is_new = 1)
187
188 #define ruri_mark_consumed()  (ruri_is_new = 0)
189
190 /** returns whether or not ruri should be used when forking.
191   * (usefull for serial forking)
192   * @return 0 if already marked as consumed, 1 if not.
193  */
194 #define ruri_get_forking_state() (ruri_is_new)
195
196 int rewrite_uri(struct sip_msg* _m, str* _s);
197
198 /*! \brief
199  * Set a per-branch flag to 1.
200  *
201  * This function sets the value of one particular branch flag to 1.
202  * @param branch Number of the branch (0 for the main Request-URI branch)
203  * @param flag Number of the flag to be set (starting with 0)
204  * @return 1 on success, -1 on failure.
205  */
206 int setbflag(unsigned int branch, flag_t flag);
207
208 /*! \brief
209  * Reset a per-branch flag value to 0.
210  *
211  * This function resets the value of one particular branch flag to 0.
212  * @param branch Number of the branch (0 for the main Request-URI branch)
213  * @param flag Number of the flag to be reset (starting with 0)
214  * @return 1 on success, -1 on failure.
215  */
216 int resetbflag(unsigned int branch, flag_t flag);
217
218 /*! \brief
219  * Determine if a branch flag is set.
220  *
221  * This function tests the value of one particular per-branch flag.
222  * @param branch Number of the branch (0 for the main Request-URI branch)
223  * @param flag Number of the flag to be tested (starting with 0)
224  * @return 1 if the branch flag is set, -1 if not or on failure.
225  */
226 int isbflagset(unsigned int branch, flag_t flag);
227
228 /*! \brief
229  * Get the value of all branch flags for a branch
230  *
231  * This function returns the value of all branch flags
232  * combined in a single variable.
233  * @param branch Number of the branch (0 for the main Request-URI branch)
234  * @param res A pointer to a variable to store the result
235  * @return 1 on success, -1 on failure
236  */
237 int getbflagsval(unsigned int branch, flag_t* res);
238
239 /*! \brief
240  * Set the value of all branch flags at once for a given branch.
241  *
242  * This function sets the value of all branch flags for a given
243  * branch at once.
244  * @param branch Number of the branch (0 for the main Request-URI branch)
245  * @param val All branch flags combined into a single variable
246  * @return 1 on success, -1 on failure
247  */
248 int setbflagsval(unsigned int branch, flag_t val);
249
250 #endif /* _DSET_H */