4e3aca6cce1a5ba046769c267693ccfa983f9d91
[sip-router] / route.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2001-2003 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  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License 
24  * along with this program; if not, write to the Free Software 
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26  */
27
28
29 #ifndef route_h
30 #define route_h
31
32 #include <sys/types.h>
33 #include <regex.h>
34 #include <netdb.h>
35
36 #include "config.h"
37 #include "error.h"
38 #include "route_struct.h"
39 #include "action.h"
40 #include "parser/msg_parser.h"
41 #include "str_hash.h"
42
43 /*#include "cfg_parser.h" */
44
45 /* Various types of route sections, make sure that the values defined in the
46  * macros below occupy disjunct bits so that they can also be used as flags
47  */
48 #define REQUEST_ROUTE (1 << 0)
49 #define FAILURE_ROUTE (1 << 1)
50 #define TM_ONREPLY_ROUTE (1 << 2)
51 #define BRANCH_ROUTE  (1 << 3)
52 #define ONSEND_ROUTE  (1 << 4)
53 #define ERROR_ROUTE   (1 << 5)
54 #define LOCAL_ROUTE   (1 << 6)
55 #define CORE_ONREPLY_ROUTE (1 << 7)
56 #define BRANCH_FAILURE_ROUTE (1 << 8)
57 #define ONREPLY_ROUTE (TM_ONREPLY_ROUTE|CORE_ONREPLY_ROUTE)
58 #define EVENT_ROUTE   REQUEST_ROUTE
59 #define ANY_ROUTE     (0xFFFFFFFF)
60
61 /* The value of this variable is one of the route types defined above and it
62  * determines the type of the route being executed, module functions can use
63  * this value to determine the type of the route they are being executed in
64  */
65 extern int route_type;
66
67 #define set_route_type(type) \
68         do {                                     \
69                 route_type = (type); \
70         } while(0)
71
72 #define get_route_type()        route_type
73
74 #define is_route_type(type) (route_type & (type))
75
76 struct route_list{
77         struct action** rlist;
78         int idx; /* first empty entry */ 
79         int entries; /* total number of entries */
80         struct str_hash_table names; /* name to route index mappings */
81 };
82
83
84 /* main "script table" */
85 extern struct route_list main_rt;
86 /* main reply route table */
87 extern struct route_list onreply_rt;
88 extern struct route_list failure_rt;
89 extern struct route_list branch_rt;
90 extern struct route_list onsend_rt;
91 extern struct route_list event_rt;
92
93 /* script optimization level */
94 extern int scr_opt_lev;
95
96 int init_routes(void);
97 void destroy_routes(void);
98 int route_get(struct route_list* rt, char* name);
99 int route_lookup(struct route_list* rt, char* name);
100
101 void push(struct action* a, struct action** head);
102 int add_actions(struct action* a, struct action** head);
103 void print_rls(void);
104 int fix_rls(void);
105
106 int eval_expr(struct run_act_ctx* h, struct expr* e, struct sip_msg* msg);
107
108
109 /* fixup functions*/
110 int fix_actions(struct action* a);
111 int fix_expr(struct expr* exp);
112
113
114
115 #endif