modules/lcr: Fixed to/from_gw tests when proto parameter is 0 (ANY)
[sip-router] / data_lump.h
1 /*
2  * $Id$
3  *
4  * adding/removing headers or any other data chunk from a message
5  *
6  * Copyright (C) 2001-2003 FhG Fokus
7  *
8  * This file is part of ser, a free SIP server.
9  *
10  * ser is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version
14  *
15  * ser is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License 
21  * along with this program; if not, write to the Free Software 
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23  */
24
25 /* History:
26  * --------
27  *  2003-01-29  s/int/enum ... more convenient for gdb (jiri)
28  *  2003-03-31  added subst lumps -- they expand in ip addr, port a.s.o (andrei)
29  *  2003-04-01  added opt (condition) lumps (andrei)
30  *  2003-04-02  added more subst lumps: SUBST_{SND,RCV}_ALL  
31  *              => ip:port;transport=proto (andrei)
32  *  2005-03-22  the type of type attribute changed to enum _hdr_types_t (janakj)
33  *
34  */
35
36 /*!
37  * \file
38  * \brief SIP-router core :: Data_lumps
39  * \ingroup core
40  * Module: \ref core
41  */
42
43
44 #ifndef data_lump_h
45 #define data_lump_h
46
47 #include "lump_struct.h"
48 #include "parser/msg_parser.h"
49 #include "parser/hf.h"
50
51
52 /* adds a header right after an anchor point if exists */
53 struct lump* add_new_lump(struct lump** list, char* new_hdr,
54                                                          int len, enum _hdr_types_t type);
55
56 /*! \brief adds a header to the end */
57 struct lump* append_new_lump(struct lump** list, char* new_hdr,
58                                                          int len, enum _hdr_types_t type);
59 /*! \brief inserts a header to the beginning */
60 struct lump* insert_new_lump(struct lump** list, char* new_hdr,
61                                                           int len, enum _hdr_types_t type);
62 struct lump* insert_new_lump_after(struct lump* after,
63                                                                         char* new_hdr, int len, enum _hdr_types_t type);
64 struct lump* insert_new_lump_before(struct lump* before, char* new_hdr,
65                                                                         int len,enum _hdr_types_t type);
66 /*! \brief substitutions (replace with ip address, port etc) */
67 struct lump* insert_subst_lump_after(struct lump* after,  enum lump_subst subst,
68                                                                         enum _hdr_types_t type);
69 struct lump* insert_subst_lump_before(struct lump* before,enum lump_subst subst,
70                                                                         enum _hdr_types_t type);
71
72 /*! \brief conditional lumps */
73 struct lump* insert_cond_lump_after(struct lump* after, enum lump_conditions c,
74                                                                         enum _hdr_types_t type);
75 struct lump* insert_cond_lump_before(struct lump* after, enum lump_conditions c,
76                                                                         enum _hdr_types_t type);
77
78 /*! \brief removes an already existing header */
79 /* set an anchor if there is no existing one at the given offset,
80  * otherwise return the existing anchor */
81 struct lump* anchor_lump2(struct sip_msg* msg, int offset, int len, enum _hdr_types_t type,
82                                                                 int *is_ref);
83 struct lump* del_lump(struct sip_msg* msg, int offset, int len, enum _hdr_types_t type);
84 /*! \brief set an anchor */
85 struct lump* anchor_lump(struct sip_msg* msg, int offset, int len, enum _hdr_types_t type);
86
87
88
89 /*! \brief duplicates a lump list shallowly in pkg-mem */
90 struct lump* dup_lump_list( struct lump *l );
91 /*! \brief frees a shallowly duplicated lump list */
92 void free_duped_lump_list(struct lump* l);
93
94
95 /*! \brief remove all non-SHMEM lumps from the list */
96 void del_nonshm_lump( struct lump** lump_list );
97
98 #endif