Core Update of doxygen, removal of history, changing "ser" to "kamailio"
[sip-router] / lump_struct.h
1 /*
2  *
3  * adding/removing headers or any other data chunk from a message
4  *
5  * Copyright (C) 2001-2003 FhG Fokus
6  *
7  * This file is part of Kamailio, a free SIP server.
8  *
9  * Kamailio is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version
13  *
14  * Kamailio is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License 
20  * along with this program; if not, write to the Free Software 
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22  */
23 /*!
24 * \file
25 * \brief Kamailio core :: Adding/removing headers or any other data chunk from a message
26 * \ingroup core
27 * \author jiri, andrei, janakj
28 * Module: \ref core
29 */
30
31 #ifndef lump_struct_h
32 #define lump_struct_h
33
34 #include "./parser/hf.h"
35
36
37 enum lump_op { LUMP_NOP=0, LUMP_DEL, LUMP_ADD, LUMP_ADD_SUBST, LUMP_ADD_OPT };
38 enum lump_subst{ SUBST_NOP=0,                     /* do nothing */
39                                  SUBST_RCV_IP,    SUBST_SND_IP,   /* add ip address */
40                                  SUBST_RCV_PORT,  SUBST_SND_PORT, /* add port no */
41                                  SUBST_RCV_PROTO, SUBST_SND_PROTO,/* add protocol(udp,tcp,tls)*/
42                                  SUBST_RCV_ALL,   SUBST_SND_ALL   /*  ip:port;transport=proto */
43                                 };
44                                 /* Where:
45                                    SND = sending, e.g the src ip of the outgoing message
46                                    RCV = received e.g the dst ip of the original incoming msg,
47                                     or the ip of the ser socket on which the msg was received
48                                    For SUBST_{RCV,SND}_ALL, :port is added only if port!=5060
49                                     and transport=proto only if proto!=udp
50                                         */
51
52 enum lump_conditions {  COND_FALSE,         /* always false */
53                                                 COND_TRUE,          /* always true */
54                                                 COND_IF_DIFF_REALMS,/* true if RCV realm != SND realm */
55                                                 COND_IF_DIFF_AF,    /* true if RCV af != SND af */
56                                                 COND_IF_DIFF_PROTO, /* true if RCV proto != SND proto */
57                                                 COND_IF_DIFF_PORT,  /* true if RCV port != SND port */
58                                                 COND_IF_DIFF_IP,    /* true if RCV ip != SND ip */
59                                                 COND_IF_RAND        /* 50-50 random prob.of being true*/
60                                                 };
61                                                 /* Where: 
62                                                    REALM= ip_addr:port:proto
63                                                    af   = address family (ipv4 or ipv6)
64                                                    proto = protocol (tcp, udp, tls)
65                                                 */
66
67 enum lump_flag { LUMPFLAG_NONE=0, LUMPFLAG_DUPED=1, LUMPFLAG_SHMEM=2,
68         LUMPFLAG_BRANCH=4, LUMPFLAG_COND_TRUE=8 };
69
70 #define LUMP_SET_COND_TRUE(_lump)        (_lump)->flags |= LUMPFLAG_COND_TRUE
71 #define LUMP_IS_COND_TRUE(_lump)         ((_lump)->flags & LUMPFLAG_COND_TRUE)
72
73 struct lump{
74         enum _hdr_types_t type; /* HDR_VIA_T, HDR_OTHER_T (0), ... */
75         enum lump_op op;   /* DEL, ADD, NOP, UNSPEC(=0) */
76         
77         union{
78                 int offset; /* used for DEL, MODIFY */
79                 enum lump_subst subst; /*what to subst: ip addr, port, proto*/
80                 enum lump_conditions cond; /* condition for LUMP_ADD_OPT */
81                 char * value; /* used for ADD */
82         }u;
83         int len; /* length of this header field */
84         
85         
86         struct lump* before; /* list of headers to be inserted in front of the
87                                                                 current one */
88         struct lump* after; /* list of headers to be inserted immediately after
89                                                           the current one */
90         
91         struct lump* next;
92
93         enum lump_flag flags; /* additional hints for use from TM's shmem */
94 };
95
96
97 /*
98  * hdrs must be kept sorted after their offset (DEL, NOP, UNSPEC)
99  * and/or their position (ADD). E.g.:
100  *  - to delete header Z insert it in to the list according to its offset 
101  *   and with op=DELETE
102  * - if you want to add a new header X after a  header Y, insert Y in the list
103  *   with op NOP and after it X (op ADD).
104  * - if you want X before Y, insert X in Y's before list.
105  * - if you want X to be the first header just put it first in hdr_lst.
106  *  -if you want to replace Y with X, insert Y with op=DELETE and then X with
107  *  op=ADD.
108  * before and after must contain only ADD ops!
109  * 
110  * Difference between "after" & "next" when Adding:
111  * "after" forces the new header immediately after the current one while
112  * "next" means another header can be inserted between them.
113  * 
114  */
115
116 /* frees the content of a lump struct */
117 void free_lump(struct lump* l);
118 /* frees an entire lump list, recursively */
119 void free_lump_list(struct lump* lump_list);
120 /* count applied lumps in a list having a specific type */
121 unsigned int count_applied_lumps(struct lump *ll, int type);
122 #endif