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