BT_GRAPH_STATUS_CANCELED is not an error, thus use a positive value
[babeltrace.git] / lib / graph / sink.c
1 /*
2 * sink.c
3 *
4 * Babeltrace Sink Component
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-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>
34
35 BT_HIDDEN
36 enum bt_component_status bt_component_sink_validate(
37 struct bt_component *component)
38 {
39 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
40
41 if (!component) {
42 ret = BT_COMPONENT_STATUS_INVALID;
43 goto end;
44 }
45
46 if (!component->class) {
47 ret = BT_COMPONENT_STATUS_INVALID;
48 goto end;
49 }
50
51 if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
52 ret = BT_COMPONENT_STATUS_INVALID;
53 goto end;
54 }
55 end:
56 return ret;
57 }
58
59 BT_HIDDEN
60 void bt_component_sink_destroy(struct bt_component *component)
61 {
62 }
63
64 BT_HIDDEN
65 struct bt_component *bt_component_sink_create(
66 struct bt_component_class *class, struct bt_value *params)
67 {
68 struct bt_component_sink *sink = NULL;
69
70 sink = g_new0(struct bt_component_sink, 1);
71 if (!sink) {
72 goto end;
73 }
74
75 end:
76 return sink ? &sink->parent : NULL;
77 }
78
79 BT_HIDDEN
80 enum bt_component_status bt_component_sink_consume(
81 struct bt_component *component)
82 {
83 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
84 struct bt_component_class_sink *sink_class = NULL;
85
86 if (!component) {
87 ret = BT_COMPONENT_STATUS_INVALID;
88 goto end;
89 }
90
91 if (bt_component_get_class_type(component) != BT_COMPONENT_CLASS_TYPE_SINK) {
92 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
93 goto end;
94 }
95
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));
99 end:
100 return ret;
101 }
102
103 int64_t bt_component_sink_get_input_port_count(struct bt_component *component)
104 {
105 int64_t ret;
106
107 if (!component ||
108 component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
109 ret = (int64_t) -1;
110 goto end;
111 }
112
113 ret = bt_component_get_input_port_count(component);
114 end:
115 return ret;
116 }
117
118 struct bt_port *bt_component_sink_get_input_port_by_name(
119 struct bt_component *component, const char *name)
120 {
121 struct bt_port *port = NULL;
122
123 if (!component || !name ||
124 component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
125 goto end;
126 }
127
128 port = bt_component_get_input_port_by_name(component, name);
129 end:
130 return port;
131 }
132
133 struct bt_port *bt_component_sink_get_input_port_by_index(
134 struct bt_component *component, uint64_t index)
135 {
136 struct bt_port *port = NULL;
137
138 if (!component ||
139 component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
140 goto end;
141 }
142
143 port = bt_component_get_input_port_by_index(component, index);
144 end:
145 return port;
146 }
147
148 struct bt_private_port *
149 bt_private_component_sink_get_input_private_port_by_index(
150 struct bt_private_component *private_component, uint64_t index)
151 {
152 return bt_private_port_from_port(
153 bt_component_sink_get_input_port_by_index(
154 bt_component_from_private(private_component), index));
155 }
156
157 struct bt_private_port *
158 bt_private_component_sink_get_input_private_port_by_name(
159 struct bt_private_component *private_component,
160 const char *name)
161 {
162 return bt_private_port_from_port(
163 bt_component_sink_get_input_port_by_name(
164 bt_component_from_private(private_component), name));
165 }
166
167 struct bt_private_port *bt_private_component_sink_add_input_private_port(
168 struct bt_private_component *private_component,
169 const char *name, void *user_data)
170 {
171 struct bt_port *port = NULL;
172 struct bt_component *component =
173 bt_component_from_private(private_component);
174
175 if (!component ||
176 component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
177 goto end;
178 }
179
180 port = bt_component_add_input_port(component, name, user_data);
181 end:
182 return bt_private_port_from_port(port);
183 }
This page took 0.03305 seconds and 4 git commands to generate.