Add ctf-text entry point initialization comment
[babeltrace.git] / plugins / iterator.c
1 /*
2 * iterator.c
3 *
4 * Babeltrace Notification Iterator
5 *
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * SOFTWARE.
27 */
28
29 #include <babeltrace/compiler.h>
30 #include <babeltrace/plugin/component.h>
31 #include <babeltrace/plugin/source-internal.h>
32 #include <babeltrace/plugin/notification/iterator.h>
33 #include <babeltrace/plugin/notification/iterator-internal.h>
34
35 static
36 void bt_notification_iterator_destroy(struct bt_ref *ref)
37 {
38 struct bt_notification_iterator *iterator;
39
40 if (!ref) {
41 return;
42 }
43
44 iterator = container_of(ref, struct bt_notification_iterator,
45 ref);
46 assert(iterator->user_destroy || !iterator->user_data);
47 iterator->user_destroy(iterator);
48 g_free(iterator);
49 }
50
51 BT_HIDDEN
52 struct bt_notification_iterator *bt_notification_iterator_create(
53 struct bt_component *component)
54 {
55 struct bt_notification_iterator *iterator = NULL;
56
57 if (!component ||
58 bt_component_get_type(component) != BT_COMPONENT_TYPE_SOURCE) {
59 goto end;
60 }
61
62 iterator = g_new0(struct bt_notification_iterator, 1);
63 if (!iterator) {
64 goto end;
65 }
66
67 bt_ref_init(&iterator->ref, bt_notification_iterator_destroy);
68 end:
69 return iterator;
70 }
71
72 BT_HIDDEN
73 enum bt_notification_iterator_status bt_notification_iterator_validate(
74 struct bt_notification_iterator *iterator)
75 {
76 enum bt_notification_iterator_status ret =
77 BT_NOTIFICATION_ITERATOR_STATUS_OK;
78
79 if (!iterator || !iterator->get || !iterator->next) {
80 ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
81 goto end;
82 }
83 end:
84 return ret;
85 }
86
87 void bt_notification_iterator_get(struct bt_notification_iterator *iterator)
88 {
89 if (!iterator) {
90 return;
91 }
92
93 bt_ref_get(&iterator->ref);
94 }
95
96 void bt_notification_iterator_put(struct bt_notification_iterator *iterator)
97 {
98 if (!iterator) {
99 return;
100 }
101
102 bt_ref_put(&iterator->ref);
103 }
104
105 enum bt_notification_iterator_status bt_notification_iterator_set_get_cb(
106 struct bt_notification_iterator *iterator,
107 bt_notification_iterator_get_cb get)
108 {
109 enum bt_notification_iterator_status ret;
110
111 if (!iterator || !get) {
112 ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
113 goto end;
114 }
115
116
117 end:
118 return ret;
119 }
This page took 0.03147 seconds and 4 git commands to generate.