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-internal.h>
30 #include <babeltrace/values.h>
31 #include <babeltrace/graph/component-sink-internal.h>
32 #include <babeltrace/graph/component-internal.h>
33 #include <babeltrace/graph/notification.h>
36 enum bt_component_status
bt_component_sink_validate(
37 struct bt_component
*component
)
39 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
42 ret
= BT_COMPONENT_STATUS_INVALID
;
46 if (!component
->class) {
47 ret
= BT_COMPONENT_STATUS_INVALID
;
51 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
52 ret
= BT_COMPONENT_STATUS_INVALID
;
60 void bt_component_sink_destroy(struct bt_component
*component
)
65 struct bt_component
*bt_component_sink_create(
66 struct bt_component_class
*class, struct bt_value
*params
)
68 struct bt_component_sink
*sink
= NULL
;
70 sink
= g_new0(struct bt_component_sink
, 1);
76 return sink
? &sink
->parent
: NULL
;
80 enum bt_component_status
bt_component_sink_consume(
81 struct bt_component
*component
)
83 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
84 struct bt_component_class_sink
*sink_class
= NULL
;
87 ret
= BT_COMPONENT_STATUS_INVALID
;
91 if (bt_component_get_class_type(component
) != BT_COMPONENT_CLASS_TYPE_SINK
) {
92 ret
= BT_COMPONENT_STATUS_UNSUPPORTED
;
96 sink_class
= container_of(component
->class, struct bt_component_class_sink
, parent
);
97 assert(sink_class
->methods
.consume
);
98 ret
= sink_class
->methods
.consume(bt_private_component_from_component(component
));
103 enum bt_component_status
bt_component_sink_get_input_port_count(
104 struct bt_component
*component
, uint64_t *count
)
106 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
108 if (!component
|| !count
||
109 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
110 status
= BT_COMPONENT_STATUS_INVALID
;
114 *count
= bt_component_get_input_port_count(component
);
119 struct bt_port
*bt_component_sink_get_input_port(
120 struct bt_component
*component
, const char *name
)
122 struct bt_port
*port
= NULL
;
124 if (!component
|| !name
||
125 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
129 port
= bt_component_get_input_port(component
, name
);
134 struct bt_port
*bt_component_sink_get_input_port_at_index(
135 struct bt_component
*component
, int index
)
137 struct bt_port
*port
= NULL
;
140 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
144 port
= bt_component_get_input_port_at_index(component
, index
);
149 struct bt_port
*bt_component_sink_get_default_input_port(
150 struct bt_component
*component
)
152 return bt_component_sink_get_input_port(component
,
153 DEFAULT_INPUT_PORT_NAME
);
156 struct bt_private_port
*
157 bt_private_component_sink_get_input_private_port_at_index(
158 struct bt_private_component
*private_component
, int index
)
160 return bt_private_port_from_port(
161 bt_component_sink_get_input_port_at_index(
162 bt_component_from_private(private_component
), index
));
165 struct bt_private_port
*bt_private_component_sink_get_default_input_private_port(
166 struct bt_private_component
*private_component
)
168 return bt_private_port_from_port(
169 bt_component_sink_get_default_input_port(
170 bt_component_from_private(private_component
)));
173 struct bt_private_port
*bt_private_component_sink_add_input_private_port(
174 struct bt_private_component
*private_component
,
177 struct bt_port
*port
= NULL
;
178 struct bt_component
*component
=
179 bt_component_from_private(private_component
);
182 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
186 port
= bt_component_add_input_port(component
, name
);
188 return bt_private_port_from_port(port
);