Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
wap_ppg_push_machine.def
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  * wap_ppg_session_machine.def: macro call to generate the machine to store
59  * data for WAP connected pushes.
60  * See architecture document for guidance how to use this.
61  *
62  * Fields of the machine have following meaning:
63  * a) Identification: pi_push_id, push_id, sender_address
64  *
65  * b) Implementing PAP attribute (see PPG Services, Chapter 6):
66  * message_state, code, desc, event_time, delivery_method
67  *
68  * c) Session this push uses: session_id, addr_tuple
69  *
70  * d) fields to implement time dependent push: timestamp and field to
71  * store the message
72  *
73  * e) field to implement priority: a priority field. Priority scheme
74  * stores the message, too.
75  *
76  * f) fields to store push message data until the session is establish-
77  * ed: push headers, push data, push capabilities.
78  *
79  * g) field to define network and bearer PI is asking: address_type
80  *
81  * h) fields to specify reporting to PI: progress_notes_requested, ppg_
82  * notify_requested_to
83  *
84  * i) PI authentication fields: authentication fields for this push:
85  * authenticated, trusted.
86  *
87  * j) Smsc used for pushing
88  *
89  * k) fields used for delivery reports: dlr_url, dlr_mask, smsbox_id,
90  * service_name
91  *
92  * By Aarno Syvšnen for Wapit Ltd, for Wiral Ltd and for Global Networks Inc
93  */
94 
95 #if !defined(MACHINE)
96  #error "Macro MACHINE is missing"
97 #elif !defined(INTEGER)
98  #error "Macro INTEGER is missing"
99 #elif !defined(OCTSTR)
100  #error "Macro OCTSTR is missing"
101 #elif !defined(OPTIONAL_OCTSTR)
102  #error "Macro OPTIONAL_OCTSTR is missing"
103 #elif !defined(ADDRTUPLE)
104  #error "Macro ADDRTUPLE is missing"
105 #elif !defined(CAPABILITIES)
106  #error "Macro CAPABILITIES is missing"
107 #elif !defined(HTTPHEADER)
108  #error "Macro HTTPHEADER is missing"
109 #endif
110 
111 MACHINE(OCTSTR(pi_push_id) /* this id is selected by PI and SHOULD
112  include data separating different PIs */
113  INTEGER(push_id) /* this id is generated by Kannel */
114  OPTIONAL_OCTSTR(sender_address) /* PPG address known by PI */
115  INTEGER(message_state) /* Implementing PAP attribute */
116  INTEGER(code)
117  OPTIONAL_OCTSTR(desc)
118  OCTSTR(event_time)
119  INTEGER(delivery_method)
120  INTEGER(session_id) /* link to the push session */
121  ADDRTUPLE(addr_tuple)
122  OPTIONAL_OCTSTR(deliver_after_timestamp) /* for time dependent push,
123  in PAP format */
124  INTEGER(priority) /* for QoS attribute priority */
125  HTTPHEADER(push_headers)
126  OPTIONAL_OCTSTR(push_data)
127  INTEGER(address_type) /* defining the network */
128  INTEGER(progress_notes_requested)/* do we send progress notes about
129  this push */
130  OPTIONAL_OCTSTR(ppg_notify_requested_to) /* do we notify PI the
131  results */
132  INTEGER(authenticated) /* transferring trust from the client to
133  PPG */
134  INTEGER(trusted)
135  OPTIONAL_OCTSTR(smsc_id) /* smsc used for pushes */
136  OPTIONAL_OCTSTR(dlr_url) /* for delivery reports */
137  INTEGER(dlr_mask)
138  OPTIONAL_OCTSTR(smsbox_id)
139  OPTIONAL_OCTSTR(service_name)
140  )
141 
142 #undef MACHINE
143 #undef INTEGER
144 #undef OCTSTR
145 #undef OPTIONAL_OCTSTR
146 #undef ADDRTUPLE
147 #undef CAPABILITIES
148 #undef HTTPHEADER
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.