ref.h: doc: fix typo
[babeltrace.git] / include / babeltrace / plugin / component-internal.h
CommitLineData
633edee0
JG
1#ifndef BABELTRACE_PLUGIN_COMPONENT_INTERNAL_H
2#define BABELTRACE_PLUGIN_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>
2bd8a567 31#include <babeltrace/plugin/plugin-system.h>
47e5a032 32#include <babeltrace/plugin/component.h>
fb2dcc52 33#include <babeltrace/plugin/component-class-internal.h>
b8a06801 34#include <babeltrace/object-internal.h>
0db5ca2c 35#include <glib.h>
38d02a17 36#include <stdio.h>
90354d3a 37
633edee0 38struct bt_component {
b8a06801 39 struct bt_object base;
fb2dcc52 40 struct bt_component_class *class;
0db5ca2c 41 GString *name;
b8a06801 42 /** Source, Sink or Filter destroy */
8738a040 43 bt_component_destroy_cb destroy;
584e4e78 44
b8a06801 45 /** User-defined data and its destruction callback */
0777b693 46 void *user_data;
8738a040 47 bt_component_destroy_cb user_destroy;
fec2a9f2
JG
48
49 /**
50 * Used to protect operations which may only be used during
51 * a component's initialization.
52 */
53 bool initializing;
90354d3a
JG
54};
55
0777b693 56BT_HIDDEN
47e5a032 57enum bt_component_status bt_component_init(struct bt_component *component,
8738a040 58 bt_component_destroy_cb destroy);
0777b693 59
38b48196
JG
60BT_HIDDEN
61enum bt_component_type bt_component_get_type(struct bt_component *component);
62
5645cd95
JG
63BT_HIDDEN
64struct bt_notification_iterator *bt_component_create_iterator(
65 struct bt_component *component);
66
633edee0 67#endif /* BABELTRACE_PLUGIN_COMPONENT_INTERNAL_H */
This page took 0.028489 seconds and 4 git commands to generate.