Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
dlr.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  * gw/dlr.h
59  *
60  * Implementation of handling delivery reports (DLRs)
61  *
62  * Andreas Fink <andreas@fink.org>, 18.08.2001
63  * Stipe Tolj <stolj@wapme.de>, 22.03.2002
64  * Alexander Malysh <amalysh at kannel.org>, 2016
65  */
66 
67 #ifndef DLR_H
68 #define DLR_H 1
69 
70 #define DLR_UNDEFINED -1
71 #define DLR_NOTHING 0x00
72 #define DLR_SUCCESS 0x01
73 #define DLR_FAIL 0x02
74 #define DLR_BUFFERED 0x04
75 #define DLR_SMSC_SUCCESS 0x08
76 #define DLR_SMSC_FAIL 0x10
77 #define DLR_EXPIRED 0x20|DLR_FAIL
78 #define DLR_UNKNOWN 0x40|DLR_FAIL
79 
80 #define DLR_IS_DEFINED(dlr) (dlr != DLR_UNDEFINED)
81 #define DLR_IS_ENABLED(dlr) (DLR_IS_DEFINED(dlr) && (dlr & (DLR_SUCCESS | DLR_FAIL | DLR_BUFFERED | DLR_SMSC_SUCCESS | DLR_SMSC_FAIL | DLR_EXPIRED | DLR_UNKNOWN)))
82 #define DLR_IS_ENABLED_DEVICE(dlr) (DLR_IS_DEFINED(dlr) && (dlr & (DLR_SUCCESS | DLR_FAIL | DLR_BUFFERED | DLR_EXPIRED | DLR_UNKNOWN)))
83 #define DLR_IS_ENABLED_SMSC(dlr) (DLR_IS_DEFINED(dlr) && (dlr & (DLR_SMSC_SUCCESS | DLR_SMSC_FAIL)))
84 #define DLR_IS_NOT_FINAL(dlr) (DLR_IS_DEFINED(dlr) && (dlr & (DLR_BUFFERED | DLR_SMSC_SUCCESS)))
85 #define DLR_IS_SUCCESS_OR_FAIL(dlr) (DLR_IS_DEFINED(dlr) && (dlr & (DLR_SUCCESS | DLR_FAIL | DLR_EXPIRED | DLR_UNKNOWN)))
86 #define DLR_IS_SUCCESS(dlr) (DLR_IS_DEFINED(dlr) && (dlr & DLR_SUCCESS))
87 #define DLR_IS_FAIL(dlr) (DLR_IS_DEFINED(dlr) && (dlr & (DLR_FAIL|DLR_EXPIRED|DLR_UNKNOWN)))
88 #define DLR_IS_BUFFERED(dlr) (DLR_IS_DEFINED(dlr) && (dlr & DLR_BUFFERED))
89 #define DLR_IS_SMSC_SUCCESS(dlr) (DLR_IS_DEFINED(dlr) && (dlr & DLR_SMSC_SUCCESS))
90 #define DLR_IS_SMSC_FAIL(dlr) (DLR_IS_DEFINED(dlr) && (dlr & DLR_SMSC_FAIL))
91 
92 /* DLR initialization routine (abstracted) */
93 void dlr_init(Cfg *cfg);
94 
95 /* DLR shutdown routine (abstracted) */
96 void dlr_shutdown(void);
97 
98 /*
99  * Add a new entry to the list
100  */
101 void dlr_add(const Octstr *smsc, const Octstr *ts, Msg *msg, int use_dst);
102 
103 /*
104  * Find an entry in the list. If there is one a message is returned and
105  * the entry is removed from the list otherwhise the message returned is NULL
106  */
107 Msg* dlr_find(const Octstr *smsc, const Octstr *ts, const Octstr *dst, int type, int use_dst);
108 
109 /* return the number of DLR messages in the current waiting queue */
110 long dlr_messages(void);
111 
112 /*
113  * Flush all DLR messages in the current waiting queue.
114  * Beware to take bearerbox to suspended state before doing this.
115  */
116 void dlr_flush(void);
117 
118 /*
119  * Return type of dlr storage
120  */
121 const char* dlr_type(void);
122 
123 /*
124  * Helper function, create DLR from given message
125  */
126 Msg* create_dlr_from_msg(const Octstr *smsc, const Msg *msg, const Octstr *reply, long stat);
127 
128 /*
129  * Yet not used functions.
130  */
131 void dlr_save(const char *filename);
132 void dlr_load(const char *filename);
133 
134 #endif /* DLR_H */
135 
Msg * dlr_find(const Octstr *smsc, const Octstr *ts, const Octstr *dst, int type, int use_dst)
Definition: dlr.c:387
void dlr_shutdown(void)
Definition: dlr.c:299
int type
Definition: smsc_cimd2.c:215
Definition: msg.h:79
Definition: cfg.c:164
Msg * create_dlr_from_msg(const Octstr *smsc, const Msg *msg, const Octstr *reply, long stat)
Definition: dlr.c:501
void dlr_save(const char *filename)
void dlr_add(const Octstr *smsc, const Octstr *ts, Msg *msg, int use_dst)
Definition: dlr.c:330
char filename[FILENAME_MAX+1]
Definition: log.c:135
long dlr_messages(void)
Definition: dlr.c:308
static Cfg * cfg
Definition: smsbox.c:115
Definition: octstr.c:118
Octstr * smsc
Definition: dlr_p.h:79
const char * dlr_type(void)
Definition: dlr.c:319
void dlr_init(Cfg *cfg)
Definition: dlr.c:233
static XMLRPCDocument * msg
Definition: test_xmlrpc.c:86
int use_dst
Definition: dlr_p.h:87
void dlr_load(const char *filename)
static void reply(HTTPClient *c, List *push_headers)
void dlr_flush(void)
Definition: dlr.c:491
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.