Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
wtp_tid.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2016 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /*
58  * wtp_tid.h - tid verification implementation header
59  *
60  * By Aarno Syvšnen for WapIT Ltd
61  */
62 
63 #ifndef WTP_TID_H
64 #define WTP_TID_H
65 
67 
68 #include <math.h>
69 #include <stdlib.h>
70 
71 #include "gwlib/gwlib.h"
72 #include "wap_events.h"
73 #include "wtp_resp.h"
74 
75 #define WTP_TID_WINDOW_SIZE (1L << 14)
76 
77 /*
78  * Constants defining the result of tid validation
79  */
80 enum {
82  ok,
84 };
85 
86 /*
87  * Tid cache item consists of initiator identifier and cached tid.
88  */
89 struct WTPCached_tid {
91  long tid;
92 };
93 
94 /*
95  * Initialize tid cache. MUST be called before calling other functions in this
96  * module.
97  */
98 
99 void wtp_tid_cache_init(void);
100 
101 /*
102  * Shut down the tid cache. MUST be called after tid cache isn't used anymore.
103  */
104 void wtp_tid_cache_shutdown(void);
105 
106 /*
107  * Does the tid validation test, by using a simple window mechanism
108  *
109  * Returns: no_cached_tid, if the peer has no cached last tid, or the result
110  * of the test (ok, fail);
111  */
112 
113 int wtp_tid_is_valid(WAPEvent *event, WTPRespMachine *machine);
114 
115 /*
116  * Changes the tid value belonging to an existing initiator
117  */
118 void wtp_tid_set_by_machine(WTPRespMachine *machine, long tid);
119 
120 #endif
121 
122 
void wtp_tid_cache_shutdown(void)
Definition: wtp_tid.c:107
int wtp_tid_is_valid(WAPEvent *event, WTPRespMachine *machine)
Definition: wtp_tid.c:119
WAPAddrTuple * addr_tuple
Definition: wtp_tid.h:90
void wtp_tid_cache_init(void)
Definition: wtp_tid.c:102
long tid
Definition: wtp_tid.h:91
Definition: wtp_tid.h:82
Definition: wtp_tid.h:83
void wtp_tid_set_by_machine(WTPRespMachine *machine, long tid)
Definition: wtp_tid.c:185
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.