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