stasis: use ao2_t_alloc for certain object allocators
[asterisk/asterisk.git] / main / stasis_message.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Stasis Message API.
22  *
23  * \author David M. Lee, II <dlee@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/astobj2.h"
35 #include "asterisk/stasis.h"
36 #include "asterisk/utils.h"
37
38 /*! \internal */
39 struct stasis_message_type {
40         struct stasis_message_vtable *vtable;
41         char *name;
42 };
43
44 static struct stasis_message_vtable null_vtable = {};
45
46 static void message_type_dtor(void *obj)
47 {
48         struct stasis_message_type *type = obj;
49         ast_free(type->name);
50         type->name = NULL;
51 }
52
53 struct stasis_message_type *stasis_message_type_create(const char *name,
54         struct stasis_message_vtable *vtable)
55 {
56         struct stasis_message_type *type;
57
58         type = ao2_t_alloc(sizeof(*type), message_type_dtor, name);
59         if (!type) {
60                 return NULL;
61         }
62         if (!vtable) {
63                 /* Null object pattern, FTW! */
64                 vtable = &null_vtable;
65         }
66
67         type->name = ast_strdup(name);
68         if (!type->name) {
69                 ao2_cleanup(type);
70                 return NULL;
71         }
72         type->vtable = vtable;
73
74         return type;
75 }
76
77 const char *stasis_message_type_name(const struct stasis_message_type *type)
78 {
79         return type->name;
80 }
81
82 /*! \internal */
83 struct stasis_message {
84         /*! Time the message was created */
85         struct timeval timestamp;
86         /*! Type of the message */
87         struct stasis_message_type *type;
88         /*! Where this message originated.  NULL if aggregate message. */
89         const struct ast_eid *eid_ptr;
90         /*! Message content */
91         void *data;
92         /*! Where this message originated. */
93         struct ast_eid eid;
94 };
95
96 static void stasis_message_dtor(void *obj)
97 {
98         struct stasis_message *message = obj;
99         ao2_cleanup(message->type);
100         ao2_cleanup(message->data);
101 }
102
103 struct stasis_message *stasis_message_create_full(struct stasis_message_type *type, void *data, const struct ast_eid *eid)
104 {
105         struct stasis_message *message;
106
107         if (type == NULL || data == NULL) {
108                 return NULL;
109         }
110
111         message = ao2_t_alloc(sizeof(*message), stasis_message_dtor, type->name);
112         if (message == NULL) {
113                 return NULL;
114         }
115
116         message->timestamp = ast_tvnow();
117         ao2_ref(type, +1);
118         message->type = type;
119         ao2_ref(data, +1);
120         message->data = data;
121         if (eid) {
122                 message->eid_ptr = &message->eid;
123                 message->eid = *eid;
124         }
125
126         return message;
127 }
128
129 struct stasis_message *stasis_message_create(struct stasis_message_type *type, void *data)
130 {
131         return stasis_message_create_full(type, data, &ast_eid_default);
132 }
133
134 const struct ast_eid *stasis_message_eid(const struct stasis_message *msg)
135 {
136         if (msg == NULL) {
137                 return NULL;
138         }
139         return msg->eid_ptr;
140 }
141
142 struct stasis_message_type *stasis_message_type(const struct stasis_message *msg)
143 {
144         if (msg == NULL) {
145                 return NULL;
146         }
147         return msg->type;
148 }
149
150 void *stasis_message_data(const struct stasis_message *msg)
151 {
152         if (msg == NULL) {
153                 return NULL;
154         }
155         return msg->data;
156 }
157
158 const struct timeval *stasis_message_timestamp(const struct stasis_message *msg)
159 {
160         if (msg == NULL) {
161                 return NULL;
162         }
163         return &msg->timestamp;
164 }
165
166 #define INVOKE_VIRTUAL(fn, ...)                         \
167         ({                                              \
168                 if (msg == NULL) {                      \
169                         return NULL;                    \
170                 }                                       \
171                 ast_assert(msg->type != NULL);          \
172                 ast_assert(msg->type->vtable != NULL);  \
173                 if (msg->type->vtable->fn == NULL) {    \
174                         return NULL;                    \
175                 }                                       \
176                 msg->type->vtable->fn(__VA_ARGS__);     \
177         })
178
179 struct ast_manager_event_blob *stasis_message_to_ami(struct stasis_message *msg)
180 {
181         return INVOKE_VIRTUAL(to_ami, msg);
182 }
183
184 struct ast_json *stasis_message_to_json(
185         struct stasis_message *msg,
186         struct stasis_message_sanitizer *sanitize)
187 {
188         return INVOKE_VIRTUAL(to_json, msg, sanitize);
189 }
190
191 struct ast_event *stasis_message_to_event(struct stasis_message *msg)
192 {
193         return INVOKE_VIRTUAL(to_event, msg);
194 }