Hide bt_component_sink_consume
[babeltrace.git] / include / babeltrace / component / 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>
33b34c43
PP
31#include <babeltrace/component/component.h>
32#include <babeltrace/component/component-class-internal.h>
366e034f 33#include <babeltrace/component/component-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
633edee0 41struct bt_component {
b8a06801 42 struct bt_object base;
fb2dcc52 43 struct bt_component_class *class;
0db5ca2c 44 GString *name;
584e4e78 45
d3e4dcd8
PP
46 /**
47 * Internal destroy function specific to a source, filter, or
48 * sink component object.
49 */
50 bt_component_class_destroy_method destroy;
51
52 /** User-defined data */
0777b693 53 void *user_data;
fec2a9f2
JG
54
55 /**
56 * Used to protect operations which may only be used during
57 * a component's initialization.
58 */
59 bool initializing;
90354d3a
JG
60};
61
0777b693 62BT_HIDDEN
47e5a032 63enum bt_component_status bt_component_init(struct bt_component *component,
d3e4dcd8 64 bt_component_class_destroy_method destroy);
38b48196 65
5645cd95
JG
66BT_HIDDEN
67struct bt_notification_iterator *bt_component_create_iterator(
8b0ce102 68 struct bt_component *component, void *init_method_data);
5645cd95 69
366e034f
JG
70BT_HIDDEN
71enum bt_component_status bt_component_set_graph(struct bt_component *component,
72 struct bt_graph *graph);
73
74BT_HIDDEN
75int bt_component_init_input_ports(struct bt_component *component,
76 GPtrArray **input_ports);
77
78BT_HIDDEN
79int bt_component_init_output_ports(struct bt_component *component,
80 GPtrArray **output_ports);
81
82BT_HIDDEN
83struct bt_port *bt_component_get_port(GPtrArray *ports, const char *name);
84
85BT_HIDDEN
86struct bt_port *bt_component_get_port_at_index(GPtrArray *ports, int index);
87
88BT_HIDDEN
89struct bt_port *bt_component_add_port(
90 struct bt_component *component,GPtrArray *ports,
91 enum bt_port_type port_type, const char *name);
92
93BT_HIDDEN
94enum bt_component_status bt_component_remove_port(
95 struct bt_component *component, GPtrArray *ports,
96 const char *name);
97
33b34c43 98#endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */
This page took 0.030636 seconds and 4 git commands to generate.