Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H | |
d3e4dcd8 PP |
3 | |
4 | /* | |
0554db57 | 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 | ||
96ffdc46 PP |
27 | #include <stdint.h> |
28 | ||
b7c5b62e | 29 | /* For bt_self_component_status */ |
96ffdc46 PP |
30 | #include <babeltrace/graph/self-component.h> |
31 | ||
b7c5b62e | 32 | /* For bt_query_status */ |
96ffdc46 PP |
33 | #include <babeltrace/graph/component-class.h> |
34 | ||
3f7f8234 PP |
35 | /* For bt_component_class_status */ |
36 | #include <babeltrace/graph/component-class-const.h> | |
37 | ||
b9879703 PP |
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 | */ | |
43 | #include <babeltrace/types.h> | |
44 | ||
d3e4dcd8 PP |
45 | #ifdef __cplusplus |
46 | extern "C" { | |
47 | #endif | |
48 | ||
b7c5b62e | 49 | typedef bt_self_component_status (*bt_component_class_sink_init_method)( |
b9879703 PP |
50 | bt_self_component_sink *self_component, |
51 | const bt_value *params, void *init_method_data); | |
96ffdc46 PP |
52 | |
53 | typedef void (*bt_component_class_sink_finalize_method)( | |
b9879703 | 54 | bt_self_component_sink *self_component); |
96ffdc46 | 55 | |
b7c5b62e | 56 | typedef bt_query_status |
96ffdc46 | 57 | (*bt_component_class_sink_query_method)( |
b9879703 PP |
58 | bt_self_component_class_sink *comp_class, |
59 | const bt_query_executor *query_executor, | |
60 | const char *object, const bt_value *params, | |
61 | const bt_value **result); | |
96ffdc46 | 62 | |
b7c5b62e | 63 | typedef bt_self_component_status |
96ffdc46 | 64 | (*bt_component_class_sink_accept_input_port_connection_method)( |
b9879703 PP |
65 | bt_self_component_sink *self_component, |
66 | bt_self_component_port_input *self_port, | |
67 | const bt_port_output *other_port); | |
96ffdc46 | 68 | |
b7c5b62e | 69 | typedef bt_self_component_status |
96ffdc46 | 70 | (*bt_component_class_sink_input_port_connected_method)( |
b9879703 PP |
71 | bt_self_component_sink *self_component, |
72 | bt_self_component_port_input *self_port, | |
73 | const bt_port_output *other_port); | |
96ffdc46 | 74 | |
734a0572 PP |
75 | typedef bt_self_component_status |
76 | (*bt_component_class_sink_graph_is_configured_method)( | |
77 | bt_self_component_sink *self_component); | |
78 | ||
b7c5b62e | 79 | typedef bt_self_component_status (*bt_component_class_sink_consume_method)( |
b9879703 | 80 | bt_self_component_sink *self_component); |
d27a81b2 PP |
81 | |
82 | static inline | |
b9879703 PP |
83 | bt_component_class *bt_component_class_sink_as_component_class( |
84 | bt_component_class_sink *comp_cls_sink) | |
d27a81b2 PP |
85 | { |
86 | return (void *) comp_cls_sink; | |
87 | } | |
d3e4dcd8 | 88 | |
96ffdc46 | 89 | extern |
b9879703 | 90 | bt_component_class_sink *bt_component_class_sink_create( |
96ffdc46 PP |
91 | const char *name, |
92 | bt_component_class_sink_consume_method method); | |
93 | ||
3f7f8234 | 94 | extern bt_component_class_status bt_component_class_sink_set_init_method( |
b9879703 | 95 | bt_component_class_sink *comp_class, |
96ffdc46 PP |
96 | bt_component_class_sink_init_method method); |
97 | ||
3f7f8234 | 98 | extern bt_component_class_status bt_component_class_sink_set_finalize_method( |
b9879703 | 99 | bt_component_class_sink *comp_class, |
96ffdc46 PP |
100 | bt_component_class_sink_finalize_method method); |
101 | ||
3f7f8234 PP |
102 | extern bt_component_class_status |
103 | bt_component_class_sink_set_accept_input_port_connection_method( | |
b9879703 | 104 | bt_component_class_sink *comp_class, |
96ffdc46 PP |
105 | bt_component_class_sink_accept_input_port_connection_method method); |
106 | ||
3f7f8234 PP |
107 | extern bt_component_class_status |
108 | bt_component_class_sink_set_input_port_connected_method( | |
b9879703 | 109 | bt_component_class_sink *comp_class, |
96ffdc46 PP |
110 | bt_component_class_sink_input_port_connected_method method); |
111 | ||
734a0572 PP |
112 | extern bt_component_class_status |
113 | bt_component_class_sink_set_graph_is_configured_method( | |
114 | bt_component_class_sink *comp_class, | |
115 | bt_component_class_sink_graph_is_configured_method method); | |
116 | ||
3f7f8234 | 117 | extern bt_component_class_status bt_component_class_sink_set_query_method( |
b9879703 | 118 | bt_component_class_sink *comp_class, |
96ffdc46 PP |
119 | bt_component_class_sink_query_method method); |
120 | ||
d3e4dcd8 PP |
121 | #ifdef __cplusplus |
122 | } | |
123 | #endif | |
124 | ||
1ca80abd | 125 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H */ |