lib: graph.c: add missing `enum` and `const` keywords
[babeltrace.git] / src / lib / graph / component.h
CommitLineData
6ac74c0c
PP
1#ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
2#define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
90354d3a
JG
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
90354d3a
JG
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
90354d3a
JG
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
91d81473 27#include "common/macros.h"
3fadfbc0 28#include <babeltrace2/graph/component-const.h>
d24d5663 29#include <babeltrace2/graph/component-class.h>
578e048b 30#include "lib/object.h"
3fadfbc0 31#include <babeltrace2/types.h>
e874da19 32#include <babeltrace2/logging.h>
578e048b 33#include "common/assert.h"
0db5ca2c 34#include <glib.h>
38d02a17 35#include <stdio.h>
90354d3a 36
578e048b
MJ
37#include "component-class.h"
38#include "port.h"
39
3230ee6b
PP
40typedef void (*bt_component_destroy_listener_func)(
41 struct bt_component *class, void *data);
42
43struct bt_component_destroy_listener {
44 bt_component_destroy_listener_func func;
45 void *data;
46};
47
e5be10ef
PP
48struct bt_graph;
49
633edee0 50struct bt_component {
b8a06801 51 struct bt_object base;
fb2dcc52 52 struct bt_component_class *class;
0db5ca2c 53 GString *name;
e874da19 54 bt_logging_level log_level;
584e4e78 55
72b913fb 56 /*
d3e4dcd8
PP
57 * Internal destroy function specific to a source, filter, or
58 * sink component object.
59 */
890882ef 60 void (*destroy)(struct bt_component *);
d3e4dcd8 61
72b913fb 62 /* User-defined data */
0777b693 63 void *user_data;
fec2a9f2 64
72b913fb
PP
65 /* Input and output ports (weak references) */
66 GPtrArray *input_ports;
67 GPtrArray *output_ports;
3230ee6b
PP
68
69 /* Array of struct bt_component_destroy_listener */
70 GArray *destroy_listeners;
36712f1d
PP
71
72 bool initialized;
72b913fb 73};
38b48196 74
e5be10ef
PP
75static inline
76struct bt_graph *bt_component_borrow_graph(struct bt_component *comp)
77{
78 BT_ASSERT(comp);
79 return (void *) bt_object_borrow_parent(&comp->base);
80}
81
36712f1d 82BT_HIDDEN
d94d92ac 83int bt_component_create(struct bt_component_class *component_class,
e874da19
PP
84 const char *name, bt_logging_level log_level,
85 struct bt_component **component);
36712f1d 86
0d8b4d8e 87BT_HIDDEN
d24d5663
PP
88enum bt_component_class_port_connected_method_status
89bt_component_port_connected(
bf55043c 90 struct bt_component *comp,
0d8b4d8e
PP
91 struct bt_port *self_port, struct bt_port *other_port);
92
366e034f 93BT_HIDDEN
f60c8b34 94void bt_component_set_graph(struct bt_component *component,
366e034f
JG
95 struct bt_graph *graph);
96
97BT_HIDDEN
0d72b8c3 98uint64_t bt_component_get_input_port_count(const struct bt_component *comp);
366e034f
JG
99
100BT_HIDDEN
0d72b8c3 101uint64_t bt_component_get_output_port_count(const struct bt_component *comp);
366e034f
JG
102
103BT_HIDDEN
d94d92ac
PP
104struct bt_port_input *bt_component_borrow_input_port_by_index(
105 struct bt_component *comp, uint64_t index);
366e034f
JG
106
107BT_HIDDEN
d94d92ac
PP
108struct bt_port_output *bt_component_borrow_output_port_by_index(
109 struct bt_component *comp, uint64_t index);
366e034f
JG
110
111BT_HIDDEN
d94d92ac
PP
112struct bt_port_input *bt_component_borrow_input_port_by_name(
113 struct bt_component *comp, const char *name);
366e034f
JG
114
115BT_HIDDEN
d94d92ac
PP
116struct bt_port_output *bt_component_borrow_output_port_by_name(
117 struct bt_component *comp, const char *name);
366e034f 118
72b913fb 119BT_HIDDEN
d24d5663 120enum bt_self_component_add_port_status bt_component_add_input_port(
3e9b0023 121 struct bt_component *component, const char *name,
8cc56726 122 void *user_data, struct bt_port **port);
72b913fb
PP
123
124BT_HIDDEN
d24d5663 125enum bt_self_component_add_port_status bt_component_add_output_port(
3e9b0023 126 struct bt_component *component, const char *name,
8cc56726 127 void *user_data, struct bt_port **port);
72b913fb
PP
128
129BT_HIDDEN
d94d92ac
PP
130void bt_component_remove_port(struct bt_component *component,
131 struct bt_port *port);
72b913fb 132
3230ee6b
PP
133BT_HIDDEN
134void bt_component_add_destroy_listener(struct bt_component *component,
135 bt_component_destroy_listener_func func, void *data);
136
137BT_HIDDEN
138void bt_component_remove_destroy_listener(struct bt_component *component,
139 bt_component_destroy_listener_func func, void *data);
140
6ac74c0c 141#endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */
This page took 0.068413 seconds and 4 git commands to generate.