Make bt_graph_connect_ports() return a status code
[babeltrace.git] / include / babeltrace / graph / component-internal.h
CommitLineData
33b34c43
PP
1#ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
2#define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
90354d3a
JG
3
4/*
633edee0 5 * BabelTrace - Component internal
90354d3a
JG
6 *
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * SOFTWARE.
28 */
29
0db5ca2c 30#include <babeltrace/babeltrace-internal.h>
b2e0c907
PP
31#include <babeltrace/graph/component.h>
32#include <babeltrace/graph/component-class-internal.h>
33#include <babeltrace/graph/port-internal.h>
b8a06801 34#include <babeltrace/object-internal.h>
c55a9f58 35#include <babeltrace/types.h>
0db5ca2c 36#include <glib.h>
38d02a17 37#include <stdio.h>
90354d3a 38
3230ee6b
PP
39typedef void (*bt_component_destroy_listener_func)(
40 struct bt_component *class, void *data);
41
42struct bt_component_destroy_listener {
43 bt_component_destroy_listener_func func;
44 void *data;
45};
46
633edee0 47struct bt_component {
b8a06801 48 struct bt_object base;
fb2dcc52 49 struct bt_component_class *class;
0db5ca2c 50 GString *name;
584e4e78 51
72b913fb 52 /*
d3e4dcd8
PP
53 * Internal destroy function specific to a source, filter, or
54 * sink component object.
55 */
890882ef 56 void (*destroy)(struct bt_component *);
d3e4dcd8 57
72b913fb 58 /* User-defined data */
0777b693 59 void *user_data;
fec2a9f2 60
72b913fb
PP
61 /* Input and output ports (weak references) */
62 GPtrArray *input_ports;
63 GPtrArray *output_ports;
3230ee6b
PP
64
65 /* Array of struct bt_component_destroy_listener */
66 GArray *destroy_listeners;
72b913fb 67};
38b48196 68
890882ef
PP
69static inline
70struct bt_component *bt_component_from_private(
71 struct bt_private_component *private_component)
72{
73 return (void *) private_component;
74}
75
76static inline
77struct bt_private_component *bt_private_component_from_component(
78 struct bt_component *component)
79{
80 return (void *) component;
81}
5645cd95 82
2d41b99e 83BT_HIDDEN
72b913fb 84enum bt_component_status bt_component_accept_port_connection(
8f4799f7
PP
85 struct bt_component *component, struct bt_port *self_port,
86 struct bt_port *other_port);
72b913fb 87
0d8b4d8e
PP
88BT_HIDDEN
89void bt_component_port_connected(struct bt_component *comp,
90 struct bt_port *self_port, struct bt_port *other_port);
91
72b913fb
PP
92BT_HIDDEN
93void bt_component_port_disconnected(struct bt_component *comp,
94 struct bt_port *port);
2d41b99e 95
366e034f 96BT_HIDDEN
f60c8b34 97void bt_component_set_graph(struct bt_component *component,
366e034f
JG
98 struct bt_graph *graph);
99
100BT_HIDDEN
544d0515 101int64_t bt_component_get_input_port_count(struct bt_component *comp);
366e034f
JG
102
103BT_HIDDEN
544d0515 104int64_t bt_component_get_output_port_count(struct bt_component *comp);
366e034f
JG
105
106BT_HIDDEN
9ac68eb1
PP
107struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp,
108 uint64_t index);
366e034f
JG
109
110BT_HIDDEN
9ac68eb1
PP
111struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp,
112 uint64_t index);
366e034f
JG
113
114BT_HIDDEN
9ac68eb1 115struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp,
72b913fb 116 const char *name);
366e034f
JG
117
118BT_HIDDEN
9ac68eb1 119struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp,
366e034f
JG
120 const char *name);
121
72b913fb
PP
122BT_HIDDEN
123struct bt_port *bt_component_add_input_port(
3e9b0023
PP
124 struct bt_component *component, const char *name,
125 void *user_data);
72b913fb
PP
126
127BT_HIDDEN
128struct bt_port *bt_component_add_output_port(
3e9b0023
PP
129 struct bt_component *component, const char *name,
130 void *user_data);
72b913fb
PP
131
132BT_HIDDEN
133enum bt_component_status bt_component_remove_port(
134 struct bt_component *component, struct bt_port *port);
135
3230ee6b
PP
136BT_HIDDEN
137void bt_component_add_destroy_listener(struct bt_component *component,
138 bt_component_destroy_listener_func func, void *data);
139
140BT_HIDDEN
141void bt_component_remove_destroy_listener(struct bt_component *component,
142 bt_component_destroy_listener_func func, void *data);
143
262e5473
PP
144static inline
145const char *bt_component_status_string(enum bt_component_status status)
146{
147 switch (status) {
148 case BT_COMPONENT_STATUS_OK:
149 return "BT_COMPONENT_STATUS_OK";
150 case BT_COMPONENT_STATUS_END:
151 return "BT_COMPONENT_STATUS_END";
152 case BT_COMPONENT_STATUS_AGAIN:
153 return "BT_COMPONENT_STATUS_AGAIN";
154 case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
155 return "BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
156 case BT_COMPONENT_STATUS_ERROR:
157 return "BT_COMPONENT_STATUS_ERROR";
158 case BT_COMPONENT_STATUS_UNSUPPORTED:
159 return "BT_COMPONENT_STATUS_UNSUPPORTED";
160 case BT_COMPONENT_STATUS_INVALID:
161 return "BT_COMPONENT_STATUS_INVALID";
162 case BT_COMPONENT_STATUS_NOMEM:
163 return "BT_COMPONENT_STATUS_NOMEM";
164 case BT_COMPONENT_STATUS_NOT_FOUND:
165 return "BT_COMPONENT_STATUS_NOT_FOUND";
166 default:
167 return "(unknown)";
168 }
169}
170
33b34c43 171#endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */
This page took 0.040414 seconds and 4 git commands to generate.