Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H |
2 | #define BABELTRACE2_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 | ||
d24d5663 | 29 | /* For bt_component_class_*_status */ |
3fadfbc0 | 30 | #include <babeltrace2/graph/component-class.h> |
0d72b8c3 | 31 | |
b19ff26f PP |
32 | /* |
33 | * For bt_component_class, bt_component_class_sink, bt_port_output, | |
34 | * bt_query_executor, bt_self_component_class_sink, | |
005f1204 PP |
35 | * bt_self_component_sink, bt_self_component_port_input, bt_value, |
36 | * __BT_UPCAST | |
b19ff26f | 37 | */ |
3fadfbc0 | 38 | #include <babeltrace2/types.h> |
b19ff26f | 39 | |
f4e38e70 PP |
40 | /* For bt_logging_level */ |
41 | #include <babeltrace2/logging.h> | |
42 | ||
d24d5663 PP |
43 | /* For __BT_FUNC_STATUS_* */ |
44 | #define __BT_FUNC_STATUS_ENABLE | |
45 | #include <babeltrace2/func-status.h> | |
46 | #undef __BT_FUNC_STATUS_ENABLE | |
47 | ||
d3e4dcd8 PP |
48 | #ifdef __cplusplus |
49 | extern "C" { | |
50 | #endif | |
51 | ||
d24d5663 PP |
52 | typedef bt_component_class_init_method_status |
53 | (*bt_component_class_sink_init_method)( | |
b19ff26f PP |
54 | bt_self_component_sink *self_component, |
55 | const bt_value *params, void *init_method_data); | |
0d72b8c3 PP |
56 | |
57 | typedef void (*bt_component_class_sink_finalize_method)( | |
b19ff26f | 58 | bt_self_component_sink *self_component); |
0d72b8c3 | 59 | |
d24d5663 | 60 | typedef bt_component_class_query_method_status |
0d72b8c3 | 61 | (*bt_component_class_sink_query_method)( |
b19ff26f PP |
62 | bt_self_component_class_sink *comp_class, |
63 | const bt_query_executor *query_executor, | |
64 | const char *object, const bt_value *params, | |
f4e38e70 | 65 | bt_logging_level logging_level, |
b19ff26f | 66 | const bt_value **result); |
0d72b8c3 | 67 | |
d24d5663 | 68 | typedef bt_component_class_port_connected_method_status |
0d72b8c3 | 69 | (*bt_component_class_sink_input_port_connected_method)( |
b19ff26f PP |
70 | bt_self_component_sink *self_component, |
71 | bt_self_component_port_input *self_port, | |
72 | const bt_port_output *other_port); | |
0d72b8c3 | 73 | |
d24d5663 PP |
74 | typedef enum bt_component_class_sink_graph_is_configured_method_status { |
75 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
76 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
77 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
78 | } bt_component_class_sink_graph_is_configured_method_status; | |
79 | ||
80 | typedef bt_component_class_sink_graph_is_configured_method_status | |
5badd463 PP |
81 | (*bt_component_class_sink_graph_is_configured_method)( |
82 | bt_self_component_sink *self_component); | |
83 | ||
d24d5663 PP |
84 | typedef enum bt_component_class_sink_consume_method_status { |
85 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
86 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
87 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
88 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN, | |
89 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END = __BT_FUNC_STATUS_END, | |
90 | } bt_component_class_sink_consume_method_status; | |
91 | ||
92 | typedef bt_component_class_sink_consume_method_status | |
93 | (*bt_component_class_sink_consume_method)( | |
94 | bt_self_component_sink *self_component); | |
d94d92ac PP |
95 | |
96 | static inline | |
b19ff26f PP |
97 | bt_component_class *bt_component_class_sink_as_component_class( |
98 | bt_component_class_sink *comp_cls_sink) | |
d94d92ac | 99 | { |
005f1204 | 100 | return __BT_UPCAST(bt_component_class, comp_cls_sink); |
d94d92ac | 101 | } |
d3e4dcd8 | 102 | |
0d72b8c3 | 103 | extern |
b19ff26f | 104 | bt_component_class_sink *bt_component_class_sink_create( |
0d72b8c3 PP |
105 | const char *name, |
106 | bt_component_class_sink_consume_method method); | |
107 | ||
d24d5663 PP |
108 | extern |
109 | bt_component_class_set_method_status | |
110 | bt_component_class_sink_set_init_method( | |
b19ff26f | 111 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
112 | bt_component_class_sink_init_method method); |
113 | ||
d24d5663 PP |
114 | extern |
115 | bt_component_class_set_method_status | |
116 | bt_component_class_sink_set_finalize_method( | |
b19ff26f | 117 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
118 | bt_component_class_sink_finalize_method method); |
119 | ||
d24d5663 PP |
120 | extern |
121 | bt_component_class_set_method_status | |
d0cf29ee | 122 | bt_component_class_sink_set_input_port_connected_method( |
b19ff26f | 123 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
124 | bt_component_class_sink_input_port_connected_method method); |
125 | ||
d24d5663 PP |
126 | extern |
127 | bt_component_class_set_method_status | |
5badd463 PP |
128 | bt_component_class_sink_set_graph_is_configured_method( |
129 | bt_component_class_sink *comp_class, | |
130 | bt_component_class_sink_graph_is_configured_method method); | |
131 | ||
d24d5663 PP |
132 | extern |
133 | bt_component_class_set_method_status | |
134 | bt_component_class_sink_set_query_method( | |
b19ff26f | 135 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
136 | bt_component_class_sink_query_method method); |
137 | ||
d3e4dcd8 PP |
138 | #ifdef __cplusplus |
139 | } | |
140 | #endif | |
141 | ||
d24d5663 PP |
142 | #include <babeltrace2/undef-func-status.h> |
143 | ||
924dc299 | 144 | #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H */ |