core: added fields to message structure and branch structure to hold user-agent strin...
[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     char location_ua[MAX_UA_SIZE + 1];
74     unsigned int location_ua_len;
75
76     /* Branch flags */
77     flag_t flags;
78 };
79
80 typedef struct branch branch_t;
81
82 /*! \brief
83  * Return pointer to branch[idx] structure
84  */
85 branch_t *get_sip_branch(int idx);
86
87 /*! \brief
88  * Drop branch[idx]
89  */
90 int drop_sip_branch(int idx);
91
92 /*! \brief
93  * Add a new branch to current transaction 
94  */
95 int append_branch(struct sip_msg* msg, str* uri, str* dst_uri, str* path,
96                   qvalue_t q, unsigned int flags,
97                   struct socket_info* force_socket,
98                   str* instance, unsigned int reg_id,
99                   str* ruid, str* location_ua);
100
101 /*! \brief kamailio compatible version */
102 #define km_append_branch(msg, uri, dst_uri, path, q, flags, force_socket) \
103     append_branch(msg, uri, dst_uri, path, q, flags, force_socket, 0, 0, 0, 0)
104
105 /*! \brief ser compatible append_branch version.
106  *  append_branch version compatible with ser: no path or branch flags support
107  *  and no str parameters.
108  */
109 static inline int ser_append_branch(struct sip_msg* msg,
110                                     char* uri, int uri_len,
111                                     char* dst_uri, int dst_uri_len,
112                                     qvalue_t q,
113                                     struct socket_info* force_socket)
114 {
115     str s_uri, s_dst_uri;
116     s_uri.s=uri;
117     s_uri.len=uri_len;
118     s_dst_uri.s=dst_uri;
119     s_dst_uri.len=dst_uri_len;
120     return append_branch(msg, &s_uri, &s_dst_uri, 0, q, 0, force_socket, 0, 0, 0, 0);
121 }
122
123
124
125 /*! \brief
126  * Init the index to iterate through the list of transaction branches
127  */
128 void init_branch_iterator(void);
129
130 /*! \brief
131  * Return branch iterator position
132  */
133 int get_branch_iterator(void);
134
135 /*! \brief
136  * Set branch iterator position
137  */
138 void set_branch_iterator(int n);
139
140 /*! \brief Get the next branch in the current transaction.
141  * @return pointer to the uri of the next branch (which the length written in
142  *  *len) or 0 if there are no more branches.
143  */
144 char* next_branch(int* len, qvalue_t* q, str* dst_uri, str* path,
145                   unsigned int* flags, struct socket_info** force_socket,
146                   str *ruid, str *instance, str *location_ua);
147
148 char* get_branch( unsigned int i, int* len, qvalue_t* q, str* dst_uri,
149                   str* path, unsigned int *flags,
150                   struct socket_info** force_socket,
151                   str* ruid, str *instance, str *location_ua);
152
153 /*! \brief
154  * Empty the array of branches
155  */
156 void clear_branches(void);
157
158
159 /*! \brief
160  * Create a Contact header field from the
161  * list of current branches
162  */
163 char* print_dset(struct sip_msg* msg, int* len);
164
165
166 /*! \brief
167  * Set the q value of the Request-URI
168  */
169 void set_ruri_q(qvalue_t q);
170
171
172 /*! \brief
173  * Get the q value of the Request-URI
174  */
175 qvalue_t get_ruri_q(void);
176
177
178
179 /*
180  * Get actual Request-URI
181  */
182 inline static int get_request_uri(struct sip_msg* _m, str* _u)
183 {
184         *_u=*GET_RURI(_m);
185         return 0;
186 }
187
188
189 #define ruri_mark_new() (ruri_is_new = 1)
190
191 #define ruri_mark_consumed()  (ruri_is_new = 0)
192
193 /** returns whether or not ruri should be used when forking.
194   * (usefull for serial forking)
195   * @return 0 if already marked as consumed, 1 if not.
196  */
197 #define ruri_get_forking_state() (ruri_is_new)
198
199 int rewrite_uri(struct sip_msg* _m, str* _s);
200
201 /*! \brief
202  * Set a per-branch flag to 1.
203  *
204  * This function sets the value of one particular branch flag to 1.
205  * @param branch Number of the branch (0 for the main Request-URI branch)
206  * @param flag Number of the flag to be set (starting with 0)
207  * @return 1 on success, -1 on failure.
208  */
209 int setbflag(unsigned int branch, flag_t flag);
210
211 /*! \brief
212  * Reset a per-branch flag value to 0.
213  *
214  * This function resets the value of one particular branch flag to 0.
215  * @param branch Number of the branch (0 for the main Request-URI branch)
216  * @param flag Number of the flag to be reset (starting with 0)
217  * @return 1 on success, -1 on failure.
218  */
219 int resetbflag(unsigned int branch, flag_t flag);
220
221 /*! \brief
222  * Determine if a branch flag is set.
223  *
224  * This function tests the value of one particular per-branch flag.
225  * @param branch Number of the branch (0 for the main Request-URI branch)
226  * @param flag Number of the flag to be tested (starting with 0)
227  * @return 1 if the branch flag is set, -1 if not or on failure.
228  */
229 int isbflagset(unsigned int branch, flag_t flag);
230
231 /*! \brief
232  * Get the value of all branch flags for a branch
233  *
234  * This function returns the value of all branch flags
235  * combined in a single variable.
236  * @param branch Number of the branch (0 for the main Request-URI branch)
237  * @param res A pointer to a variable to store the result
238  * @return 1 on success, -1 on failure
239  */
240 int getbflagsval(unsigned int branch, flag_t* res);
241
242 /*! \brief
243  * Set the value of all branch flags at once for a given branch.
244  *
245  * This function sets the value of all branch flags for a given
246  * branch at once.
247  * @param branch Number of the branch (0 for the main Request-URI branch)
248  * @param val All branch flags combined into a single variable
249  * @return 1 on success, -1 on failure
250  */
251 int setbflagsval(unsigned int branch, flag_t val);
252
253 #endif /* _DSET_H */