Commit | Line | Data |
---|---|---|
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> |
0db5ca2c | 35 | #include <glib.h> |
38d02a17 | 36 | #include <stdio.h> |
90354d3a | 37 | |
3230ee6b PP |
38 | typedef void (*bt_component_destroy_listener_func)( |
39 | struct bt_component *class, void *data); | |
40 | ||
41 | struct bt_component_destroy_listener { | |
42 | bt_component_destroy_listener_func func; | |
43 | void *data; | |
44 | }; | |
45 | ||
633edee0 | 46 | struct bt_component { |
b8a06801 | 47 | struct bt_object base; |
fb2dcc52 | 48 | struct bt_component_class *class; |
0db5ca2c | 49 | GString *name; |
584e4e78 | 50 | |
72b913fb | 51 | /* |
d3e4dcd8 PP |
52 | * Internal destroy function specific to a source, filter, or |
53 | * sink component object. | |
54 | */ | |
890882ef | 55 | void (*destroy)(struct bt_component *); |
d3e4dcd8 | 56 | |
72b913fb | 57 | /* User-defined data */ |
0777b693 | 58 | void *user_data; |
fec2a9f2 | 59 | |
72b913fb | 60 | /* |
fec2a9f2 JG |
61 | * Used to protect operations which may only be used during |
62 | * a component's initialization. | |
63 | */ | |
64 | bool initializing; | |
90354d3a | 65 | |
72b913fb PP |
66 | /* Input and output ports (weak references) */ |
67 | GPtrArray *input_ports; | |
68 | GPtrArray *output_ports; | |
3230ee6b PP |
69 | |
70 | /* Array of struct bt_component_destroy_listener */ | |
71 | GArray *destroy_listeners; | |
72b913fb | 72 | }; |
38b48196 | 73 | |
890882ef PP |
74 | static inline |
75 | struct bt_component *bt_component_from_private( | |
76 | struct bt_private_component *private_component) | |
77 | { | |
78 | return (void *) private_component; | |
79 | } | |
80 | ||
81 | static inline | |
82 | struct bt_private_component *bt_private_component_from_component( | |
83 | struct bt_component *component) | |
84 | { | |
85 | return (void *) component; | |
86 | } | |
5645cd95 | 87 | |
2d41b99e | 88 | BT_HIDDEN |
72b913fb | 89 | enum bt_component_status bt_component_accept_port_connection( |
8f4799f7 PP |
90 | struct bt_component *component, struct bt_port *self_port, |
91 | struct bt_port *other_port); | |
72b913fb | 92 | |
0d8b4d8e PP |
93 | BT_HIDDEN |
94 | void bt_component_port_connected(struct bt_component *comp, | |
95 | struct bt_port *self_port, struct bt_port *other_port); | |
96 | ||
72b913fb PP |
97 | BT_HIDDEN |
98 | void bt_component_port_disconnected(struct bt_component *comp, | |
99 | struct bt_port *port); | |
2d41b99e | 100 | |
366e034f | 101 | BT_HIDDEN |
f60c8b34 | 102 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
103 | struct bt_graph *graph); |
104 | ||
105 | BT_HIDDEN | |
544d0515 | 106 | int64_t bt_component_get_input_port_count(struct bt_component *comp); |
366e034f JG |
107 | |
108 | BT_HIDDEN | |
544d0515 | 109 | int64_t bt_component_get_output_port_count(struct bt_component *comp); |
366e034f JG |
110 | |
111 | BT_HIDDEN | |
9ac68eb1 PP |
112 | struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp, |
113 | uint64_t index); | |
366e034f JG |
114 | |
115 | BT_HIDDEN | |
9ac68eb1 PP |
116 | struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp, |
117 | uint64_t index); | |
366e034f JG |
118 | |
119 | BT_HIDDEN | |
9ac68eb1 | 120 | struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp, |
72b913fb | 121 | const char *name); |
366e034f JG |
122 | |
123 | BT_HIDDEN | |
9ac68eb1 | 124 | struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp, |
366e034f JG |
125 | const char *name); |
126 | ||
72b913fb PP |
127 | BT_HIDDEN |
128 | struct bt_port *bt_component_add_input_port( | |
3e9b0023 PP |
129 | struct bt_component *component, const char *name, |
130 | void *user_data); | |
72b913fb PP |
131 | |
132 | BT_HIDDEN | |
133 | struct bt_port *bt_component_add_output_port( | |
3e9b0023 PP |
134 | struct bt_component *component, const char *name, |
135 | void *user_data); | |
72b913fb PP |
136 | |
137 | BT_HIDDEN | |
138 | enum bt_component_status bt_component_remove_port( | |
139 | struct bt_component *component, struct bt_port *port); | |
140 | ||
3230ee6b PP |
141 | BT_HIDDEN |
142 | void bt_component_add_destroy_listener(struct bt_component *component, | |
143 | bt_component_destroy_listener_func func, void *data); | |
144 | ||
145 | BT_HIDDEN | |
146 | void bt_component_remove_destroy_listener(struct bt_component *component, | |
147 | bt_component_destroy_listener_func func, void *data); | |
148 | ||
33b34c43 | 149 | #endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */ |