Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
bb_store.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  * bb_store.h : declarations for the bearerbox box SMS storage/retrieval module
59  *
60  * Author: Alexander Malysh, 2005
61  */
62 
63 #ifndef BB_STORE_H_
64 #define BB_STORE_H_
65 
66 #define BB_STORE_DEFAULT_DUMP_FREQ 10
67 
68 /* return number of SMS messages in current store (file) */
69 extern long (*store_messages)(void);
70 
71 /* assign ID and save given message to store. Return -1 if save failed */
72 extern int (*store_save)(Msg *msg);
73 
74 /*
75  * Store ack/nack to the store file for a given message with a given status.
76  * @return: -1 if save failed ; 0 otherwise.
77  */
78 extern int (*store_save_ack)(Msg *msg, ack_status_t status);
79 
80 /* load store from file; delete any messages that have been relayed,
81  * and create a new store file from remaining. Calling this function
82  * might take a while, depending on store size
83  * Return -1 if something fails (bb can then PANIC normally)
84  */
85 extern int (*store_load)(void(*receive_msg)(Msg*));
86 
87 /* dump currently non-acknowledged messages into file. This is done
88  * automatically now and then, but can be forced. Return -1 if file
89  * problems
90  */
91 extern int (*store_dump)(void);
92 
93 /*
94  * Function pointers used inside the storage subsystem to pack and
95  * unpack a Msg with variable serialization functions.
96  */
97 extern Octstr* (*store_msg_pack)(Msg *msg);
98 extern Msg* (*store_msg_unpack)(Octstr *os);
99 
100 /* initialize system. Return -1 if fname is bad (too long). */
101 int store_init(Cfg *cfg, const Octstr *type, const Octstr *fname, long dump_freq,
102  void *pack_func, void *unpack_func);
103 
104 /* init shutdown (system dies when all acks have been processed) */
105 extern void (*store_shutdown)(void);
106 
107 /* return all containing messages in the current store */
108 Octstr* store_status(int status_type);
109 
110 extern void (*store_for_each_message)(void(*callback_fn)(Msg*, void*), void *data);
111 
112 
116 int store_spool_init(const Octstr *fname);
117 int store_file_init(const Octstr *fname, long dump_freq);
118 #ifdef HAVE_REDIS
119 int store_redis_init(Cfg *cfg);
120 #endif
121 
122 #endif /*BB_STORE_H_*/
123 
int(* store_save_ack)(Msg *msg, ack_status_t status)
Definition: bb_store.c:73
void(* store_for_each_message)(void(*callback_fn)(Msg *, void *), void *data)
Definition: bb_store.c:79
int type
Definition: smsc_cimd2.c:215
int store_init(Cfg *cfg, const Octstr *type, const Octstr *fname, long dump_freq, void *pack_func, void *unpack_func)
Definition: bb_store.c:82
Octstr * store_status(int status_type)
Definition: bb_store.c:148
int(* store_load)(void(*receive_msg)(Msg *))
Definition: bb_store.c:74
Definition: msg.h:79
Definition: cfg.c:164
void * data
void(* store_shutdown)(void)
Definition: bb_store.c:76
static Cfg * cfg
Definition: smsbox.c:115
int(* store_dump)(void)
Definition: bb_store.c:75
Definition: octstr.c:118
void(* callback_fn)(Msg *msg, void *data)
ack_status_t
Definition: msg.h:124
int(* store_save)(Msg *msg)
Definition: bb_store.c:72
int store_spool_init(const Octstr *fname)
int store_file_init(const Octstr *fname, long dump_freq)
static XMLRPCDocument * msg
Definition: test_xmlrpc.c:86
long(* store_messages)(void)
Definition: bb_store.c:71
Octstr * status
Definition: bb_store.c:108
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.