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