950f541a6e0877cef8a7d3eb1e60feeabb0f4f10
[sip-router] / data_lump.h
1 /*
2  * $Id$
3  *
4  * adding/removing headers or any other data chunk from a message
5  */
6
7 #ifndef data_lump_h
8 #define data_lump_h
9
10
11 enum { LUMP_NOP=0, LUMP_DEL, LUMP_ADD };
12
13 struct lump{
14         int type; /* VIA, OTHER, UNSPEC(=0), ... */
15         int op;   /* DEL, ADD, NOP, UNSPEC(=0) */
16         
17         union{
18                 int offset; /* used for DEL, MODIFY */
19                 char * value; /* used for ADD */
20         }u;
21         int len; /* length of this header field */
22         
23         
24         struct lump* before; /* list of headers to be inserted in front of the
25                                                                 current one */
26         struct lump* after; /* list of headers to be inserted immediately after
27                                                           the current one */
28         
29         struct lump* next;
30 };
31
32 /*
33  * hdrs must be kept sorted after their offset (DEL, NOP, UNSPEC)
34  * and/or their position (ADD). E.g.:
35  *  - to delete header Z insert it in to the list according to its offset 
36  *   and with op=DELETE
37  * - if you want to add a new header X after a  header Y, insert Y in the list
38  *   with op NOP and after it X (op ADD).
39  * - if you want X before Y, insert X in Y's before list.
40  * - if you want X to be the first header just put it first in hdr_lst.
41  *  -if you want to replace Y with X, insert Y with op=DELETE and then X with
42  *  op=ADD.
43  * before and after must contain only ADD ops!
44  * 
45  * Difference between "after" & "next" when ADDing:
46  * "after" forces the new header immediately after the current one while
47  * "next" means another header can be inserted between them.
48  * 
49  */
50
51
52
53 /* adds a header to the end */
54 struct lump* append_new_lump(struct lump** list, char* new_hdr,
55                                                          int len, int type);
56 /* inserts a header to the beginning */
57 struct lump* insert_new_lump(struct lump** list, char* new_hdr,
58                                                           int len, int type);
59 struct lump* insert_new_lump_after(struct lump* after,
60                                                                         char* new_hdr, int len, int type);
61 struct lump* insert_new_lump_before(struct lump* before, char* new_hdr,
62                                                                         int len,int type);
63
64
65 /* removes an already existing header */
66 struct lump* del_lump(struct lump** list, int offset, int len, int type);
67 /* set an anchor */
68 struct lump* anchor_lump(struct lump** list, int offset, int len, int type);
69
70
71 /* frees the content of a lump struct */
72 void free_lump(struct lump* l);
73 /*frees an entire lump list, recursively */
74 void free_lump_list(struct lump* lump_list);
75
76 #endif