Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
msg.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  * msg.h - declarations for message manipulation
59  *
60  * This file declares the Msg data type and the functions to manipulate it.
61  *
62  * Lars Wirzenius
63  */
64 
65 
66 #ifndef MSG_H
67 #define MSG_H
68 
69 #include "gwlib/gwlib.h"
70 
71 #define MSG_PARAM_UNDEFINED -1
72 
73 enum msg_type {
74  #define MSG(type, stmt) type,
75  #include "msg-decl.h"
76  msg_type_count
77 };
78 
79 typedef struct {
80  enum msg_type type;
81 
82  #define INTEGER(name) long name;
83  #define OCTSTR(name) Octstr *name;
84  #define UUID(name) uuid_t name;
85  #define VOID(name) void *name;
86  #define MSG(type, stmt) struct type stmt type;
87  #include "msg-decl.h"
88 } Msg;
89 
90 struct split_parts {
91  /* original large message */
93  /* how many parts still not sent */
95  /* status of splitted message parts */
96  long status;
97  /* pointer to SMSCConn */
98  void *smsc_conn;
99 };
100 
101 /* enums for Msg fields */
102 
103 /* sms message type */
104 
105 enum {
106  mo = 0,
107  mt_reply = 1,
108  mt_push = 2,
111 };
112 
113 /* admin commands */
114 enum {
121 };
122 
123 /* ack message status */
124 typedef enum {
126  ack_failed = 1, /* do not try again (e.g. no route) */
127  ack_failed_tmp = 2, /* temporary failed, try again (e.g. queue full) */
129 } ack_status_t;
130 
131 /*
132  * Create a new, empty Msg object. Panics if fails.
133  */
134 Msg *msg_create_real(enum msg_type type, const char *file, long line,
135  const char *func);
136 #define msg_create(type) \
137  gw_claim_area(msg_create_real((type), __FILE__, __LINE__, __func__))
138 
139 /*
140  * Create a new Msg object that is a copy of an existing one.
141  * Panics if fails.
142  */
145 
146 /*
147  * Return type of the message
148  */
149 enum msg_type msg_type(Msg *msg);
150 
151 
152 /*
153  * Destroy an Msg object. All fields are also destroyed.
154  */
155 void msg_destroy(Msg *msg);
156 
157 
158 /*
159  * Destroy an Msg object. Wrapper around msg_destroy to make it suitable for
160  * gwlist_destroy.
161  */
162 void msg_destroy_item(void *msg);
163 
164 
165 /*
166  * For debugging: Output with `debug' (in gwlib/log.h) the contents of
167  * an Msg object.
168  */
169 void msg_dump(Msg *msg, int level);
170 
171 
172 /*
173  * Pack an Msg into an Octstr. Panics if fails.
174  */
176 
177 
178 /*
179  * Unpack an Msg from an Octstr. Return NULL for failure, otherwise a pointer
180  * to the Msg.
181  */
182 Msg *msg_unpack_real(Octstr *os, const char *file, long line, const char *func);
183 #define msg_unpack(os) \
184  gw_claim_area(msg_unpack_real((os), __FILE__, __LINE__, __func__))
186 
187 #endif
Counter * parts_left
Definition: msg.h:94
Definition: msg.h:106
Definition: msg.h:109
msg_type
Definition: msg.h:73
int type
Definition: smsc_cimd2.c:215
Definition: msg.h:110
FILE * file
Definition: log.c:133
Msg * msg_unpack_wrapper(Octstr *os)
Definition: msg.c:256
long status
Definition: msg.h:96
Definition: msg.h:108
Definition: msg.h:79
void msg_destroy(Msg *msg)
Definition: msg.c:132
Octstr * msg_pack(Msg *msg)
Definition: msg.c:181
Msg * msg_unpack_real(Octstr *os, const char *file, long line, const char *func)
Definition: msg.c:206
void msg_destroy_item(void *msg)
Definition: msg.c:147
void * smsc_conn
Definition: msg.h:98
Definition: octstr.c:118
void msg_dump(Msg *msg, int level)
Definition: msg.c:152
Msg * msg_duplicate(Msg *msg)
Definition: msg.c:111
Msg * orig
Definition: msg.h:92
ack_status_t
Definition: msg.h:124
Definition: msg.h:107
static XMLRPCDocument * msg
Definition: test_xmlrpc.c:86
Msg * msg_create_real(enum msg_type type, const char *file, long line, const char *func)
Definition: msg.c:93
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.