4 * Babeltrace Sink Component
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 #include <babeltrace/compiler.h>
30 #include <babeltrace/plugin/sink-internal.h>
31 #include <babeltrace/plugin/component-internal.h>
32 #include <babeltrace/plugin/notification/notification.h>
35 enum bt_component_status
bt_component_sink_validate(
36 struct bt_component
*component
)
38 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
39 struct bt_component_sink
*sink
;
41 sink
= container_of(component
, struct bt_component_sink
, parent
);
42 if (sink
->registered_notifications_mask
== 0) {
44 * A sink must be registered to at least one notification type.
46 printf_error("Invalid sink component; not registered to any notification");
47 ret
= BT_COMPONENT_STATUS_INVALID
;
51 if (!sink
->handle_notification
) {
52 printf_error("Invalid sink component; no notification handling callback defined.");
53 ret
= BT_COMPONENT_STATUS_INVALID
;
61 struct bt_component
*bt_component_sink_create(
62 struct bt_component_class
*class, struct bt_value
*params
)
64 struct bt_component_sink
*sink
= NULL
;
65 enum bt_component_status ret
;
67 sink
= g_new0(struct bt_component_sink
, 1);
72 sink
->parent
.class = bt_get(class);
73 ret
= bt_component_init(&sink
->parent
, NULL
);
74 if (ret
!= BT_COMPONENT_STATUS_OK
) {
78 ret
= bt_component_sink_register_notification_type(&sink
->parent
,
79 BT_NOTIFICATION_TYPE_EVENT
);
80 if (ret
!= BT_COMPONENT_STATUS_OK
) {
84 return sink
? &sink
->parent
: NULL
;
90 enum bt_component_status
bt_component_sink_handle_notification(
91 struct bt_component
*component
,
92 struct bt_notification
*notification
)
94 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
95 struct bt_component_sink
*sink
= NULL
;
97 if (!component
|| !notification
) {
98 ret
= BT_COMPONENT_STATUS_INVALID
;
102 if (bt_component_get_type(component
) != BT_COMPONENT_TYPE_SINK
) {
103 ret
= BT_COMPONENT_STATUS_UNSUPPORTED
;
107 sink
= container_of(component
, struct bt_component_sink
, parent
);
108 assert(sink
->handle_notification
);
109 ret
= sink
->handle_notification(component
, notification
);
114 enum bt_component_status
bt_component_sink_register_notification_type(
115 struct bt_component
*component
, enum bt_notification_type type
)
117 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
118 struct bt_component_sink
*sink
= NULL
;
121 ret
= BT_COMPONENT_STATUS_INVALID
;
125 if (bt_component_get_type(component
) != BT_COMPONENT_TYPE_SINK
) {
126 ret
= BT_COMPONENT_STATUS_UNSUPPORTED
;
130 if (type
<= BT_NOTIFICATION_TYPE_UNKNOWN
||
131 type
>= BT_NOTIFICATION_TYPE_NR
) {
132 ret
= BT_COMPONENT_STATUS_INVALID
;
135 sink
= container_of(component
, struct bt_component_sink
, parent
);
136 if (type
== BT_NOTIFICATION_TYPE_ALL
) {
137 sink
->registered_notifications_mask
= ~(notification_mask_t
) 0;
139 sink
->registered_notifications_mask
|=
140 (notification_mask_t
) 1 << type
;
146 enum bt_component_status
bt_component_sink_set_handle_notification_cb(
147 struct bt_component
*component
,
148 bt_component_sink_handle_notification_cb handle_notification
)
150 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
151 struct bt_component_sink
*sink
= NULL
;
154 ret
= BT_COMPONENT_STATUS_INVALID
;
158 if (bt_component_get_type(component
) != BT_COMPONENT_TYPE_SINK
) {
159 ret
= BT_COMPONENT_STATUS_UNSUPPORTED
;
163 sink
= container_of(component
, struct bt_component_sink
, parent
);
164 sink
->handle_notification
= handle_notification
;