lib: Reset libbabeltrace2 to SONANE 0
[babeltrace.git] / include / babeltrace / graph / component-class-sink.h
CommitLineData
1ca80abd
PP
1#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H
2#define BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H
d3e4dcd8
PP
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
d3e4dcd8
PP
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
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
0d72b8c3
PP
27#include <stdint.h>
28
4cdfc5e8 29/* For bt_self_component_status */
0d72b8c3
PP
30#include <babeltrace/graph/self-component.h>
31
4cdfc5e8 32/* For bt_query_status */
0d72b8c3
PP
33#include <babeltrace/graph/component-class.h>
34
d0cf29ee
PP
35/* For bt_component_class_status */
36#include <babeltrace/graph/component-class-const.h>
37
b19ff26f
PP
38/*
39 * For bt_component_class, bt_component_class_sink, bt_port_output,
40 * bt_query_executor, bt_self_component_class_sink,
005f1204
PP
41 * bt_self_component_sink, bt_self_component_port_input, bt_value,
42 * __BT_UPCAST
b19ff26f
PP
43 */
44#include <babeltrace/types.h>
45
d3e4dcd8
PP
46#ifdef __cplusplus
47extern "C" {
48#endif
49
4cdfc5e8 50typedef bt_self_component_status (*bt_component_class_sink_init_method)(
b19ff26f
PP
51 bt_self_component_sink *self_component,
52 const bt_value *params, void *init_method_data);
0d72b8c3
PP
53
54typedef void (*bt_component_class_sink_finalize_method)(
b19ff26f 55 bt_self_component_sink *self_component);
0d72b8c3 56
4cdfc5e8 57typedef bt_query_status
0d72b8c3 58(*bt_component_class_sink_query_method)(
b19ff26f
PP
59 bt_self_component_class_sink *comp_class,
60 const bt_query_executor *query_executor,
61 const char *object, const bt_value *params,
62 const bt_value **result);
0d72b8c3 63
4cdfc5e8 64typedef bt_self_component_status
0d72b8c3 65(*bt_component_class_sink_accept_input_port_connection_method)(
b19ff26f
PP
66 bt_self_component_sink *self_component,
67 bt_self_component_port_input *self_port,
68 const bt_port_output *other_port);
0d72b8c3 69
4cdfc5e8 70typedef bt_self_component_status
0d72b8c3 71(*bt_component_class_sink_input_port_connected_method)(
b19ff26f
PP
72 bt_self_component_sink *self_component,
73 bt_self_component_port_input *self_port,
74 const bt_port_output *other_port);
0d72b8c3 75
5badd463
PP
76typedef bt_self_component_status
77(*bt_component_class_sink_graph_is_configured_method)(
78 bt_self_component_sink *self_component);
79
4cdfc5e8 80typedef bt_self_component_status (*bt_component_class_sink_consume_method)(
b19ff26f 81 bt_self_component_sink *self_component);
d94d92ac
PP
82
83static inline
b19ff26f
PP
84bt_component_class *bt_component_class_sink_as_component_class(
85 bt_component_class_sink *comp_cls_sink)
d94d92ac 86{
005f1204 87 return __BT_UPCAST(bt_component_class, comp_cls_sink);
d94d92ac 88}
d3e4dcd8 89
0d72b8c3 90extern
b19ff26f 91bt_component_class_sink *bt_component_class_sink_create(
0d72b8c3
PP
92 const char *name,
93 bt_component_class_sink_consume_method method);
94
d0cf29ee 95extern bt_component_class_status bt_component_class_sink_set_init_method(
b19ff26f 96 bt_component_class_sink *comp_class,
0d72b8c3
PP
97 bt_component_class_sink_init_method method);
98
d0cf29ee 99extern bt_component_class_status bt_component_class_sink_set_finalize_method(
b19ff26f 100 bt_component_class_sink *comp_class,
0d72b8c3
PP
101 bt_component_class_sink_finalize_method method);
102
d0cf29ee
PP
103extern bt_component_class_status
104bt_component_class_sink_set_accept_input_port_connection_method(
b19ff26f 105 bt_component_class_sink *comp_class,
0d72b8c3
PP
106 bt_component_class_sink_accept_input_port_connection_method method);
107
d0cf29ee
PP
108extern bt_component_class_status
109bt_component_class_sink_set_input_port_connected_method(
b19ff26f 110 bt_component_class_sink *comp_class,
0d72b8c3
PP
111 bt_component_class_sink_input_port_connected_method method);
112
5badd463
PP
113extern bt_component_class_status
114bt_component_class_sink_set_graph_is_configured_method(
115 bt_component_class_sink *comp_class,
116 bt_component_class_sink_graph_is_configured_method method);
117
d0cf29ee 118extern bt_component_class_status bt_component_class_sink_set_query_method(
b19ff26f 119 bt_component_class_sink *comp_class,
0d72b8c3
PP
120 bt_component_class_sink_query_method method);
121
d3e4dcd8
PP
122#ifdef __cplusplus
123}
124#endif
125
1ca80abd 126#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H */
This page took 0.054631 seconds and 4 git commands to generate.