Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
wtp_pack.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_pack.h - WTP implementation, message module header
59  *
60  * By Aarno Syvšnen for WapIT Ltd.
61  */
62 
63 #ifndef WTP_SEND_H
64 #define WTP_SEND_H
65 
66 #include "gwlib/gwlib.h"
67 #include "wap_events.h"
68 #include "wtp_init.h"
69 #include "wtp_resp.h"
70 #include "wtp.h"
71 #include "wap.h"
72 
73 /*
74  * Create a datagram event, having invoke PDU as user data. Fetches address,
75  * tid and tid_new from the initiator state machine, other fields from event.
76  * Only for the wtp initiator.
77  *
78  * Return message to be sent.
79  */
80 
81 WAPEvent *wtp_pack_invoke(WTPInitMachine *init_machine, WAPEvent *event);
82 
83 /*
84  * Create a datagram event, having result PDU as user data. Fetches SDU
85  * from WTP event, address four-tuple and machine state information
86  * (are we resending the packet) from WTP machine. Handles all
87  * errors by itself. Returns message, if OK, else NULL. Only for wtp
88  * responder.
89  */
90 
91 WAPEvent *wtp_pack_result(WTPRespMachine *resp_machine, WAPEvent *event);
92 
93 /*
94  * Same as above but for a segmented result.
95  */
96 WAPEvent *wtp_pack_sar_result(WTPRespMachine *resp_machine, int psn);
97 
98 /*
99  * Create a datagram event, having abort PDU as user data. Fetches SDU
100  * from WTP event, address four-tuple from WTP machine.
101  * Handles all errors by itself. Both for wtp initiator and responder.
102  */
103 
104 WAPEvent *wtp_pack_abort(long abort_type, long abort_reason, long tid,
105  WAPAddrTuple *address);
106 
107 /*
108  * Create a datagram event, having ack PDU as user data. Creates SDU by
109  * itself, fetches address four-tuple and machine state from WTP machine.
110  * Ack_type is a flag telling whether we are doing tid verification or not,
111  * rid_flag tells are we retransmitting. Handles all errors by itself.
112  * Both for wtp initiator and responder.
113  */
114 
115 WAPEvent *wtp_pack_ack(long ack_type, int rid_flag, long tid,
116  WAPAddrTuple *address);
117 
118 /*
119  * Same as above but for a segmented ack
120  */
121 WAPEvent *wtp_pack_sar_ack(long ack_type, long tid, WAPAddrTuple *address, int psn);
122 
123 /*
124  * Set or unset the retransmission indicator on a PDU that has already
125  * been packed as a datagram. dgram must be of type T_DUnitdata_Req.
126  */
127 void wtp_pack_set_rid(WAPEvent *dgram, long rid);
128 #endif
WAPEvent * wtp_pack_abort(long abort_type, long abort_reason, long tid, WAPAddrTuple *address)
Definition: wtp_pack.c:223
void wtp_pack_set_rid(WAPEvent *dgram, long rid)
Definition: wtp_pack.c:215
WAPEvent * wtp_pack_ack(long ack_type, int rid_flag, long tid, WAPAddrTuple *address)
Definition: wtp_pack.c:243
WAPEvent * wtp_pack_sar_result(WTPRespMachine *resp_machine, int psn)
Definition: wtp_pack.c:167
WAPEvent * wtp_pack_result(WTPRespMachine *resp_machine, WAPEvent *event)
Definition: wtp_pack.c:143
WAPEvent * wtp_pack_invoke(WTPInitMachine *init_machine, WAPEvent *event)
Definition: wtp_pack.c:115
WAPEvent * wtp_pack_sar_ack(long ack_type, long tid, WAPAddrTuple *address, int psn)
Definition: wtp_pack.c:263
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.