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 | /* | |
bbb7b5f0 | 5 | * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation |
d3e4dcd8 PP |
6 | * |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
8 | * of this software and associated documentation files (the "Software"), to deal | |
9 | * in the Software without restriction, including without limitation the rights | |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | * copies of the Software, and to permit persons to whom the Software is | |
12 | * furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
23 | * SOFTWARE. | |
24 | */ | |
25 | ||
4fa90f32 PP |
26 | #ifndef __BT_IN_BABELTRACE_H |
27 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
28 | #endif | |
29 | ||
0d72b8c3 PP |
30 | #include <stdint.h> |
31 | ||
3fadfbc0 | 32 | #include <babeltrace2/graph/component-class.h> |
3fadfbc0 | 33 | #include <babeltrace2/types.h> |
f4e38e70 PP |
34 | #include <babeltrace2/logging.h> |
35 | ||
d3e4dcd8 PP |
36 | #ifdef __cplusplus |
37 | extern "C" { | |
38 | #endif | |
39 | ||
d24d5663 PP |
40 | typedef bt_component_class_init_method_status |
41 | (*bt_component_class_sink_init_method)( | |
b19ff26f PP |
42 | bt_self_component_sink *self_component, |
43 | const bt_value *params, void *init_method_data); | |
0d72b8c3 PP |
44 | |
45 | typedef void (*bt_component_class_sink_finalize_method)( | |
b19ff26f | 46 | bt_self_component_sink *self_component); |
0d72b8c3 | 47 | |
d24d5663 | 48 | typedef bt_component_class_query_method_status |
0d72b8c3 | 49 | (*bt_component_class_sink_query_method)( |
b19ff26f | 50 | bt_self_component_class_sink *comp_class, |
3c729b9a | 51 | bt_private_query_executor *query_executor, |
b19ff26f PP |
52 | const char *object, const bt_value *params, |
53 | const bt_value **result); | |
0d72b8c3 | 54 | |
d24d5663 | 55 | typedef bt_component_class_port_connected_method_status |
0d72b8c3 | 56 | (*bt_component_class_sink_input_port_connected_method)( |
b19ff26f PP |
57 | bt_self_component_sink *self_component, |
58 | bt_self_component_port_input *self_port, | |
59 | const bt_port_output *other_port); | |
0d72b8c3 | 60 | |
d24d5663 PP |
61 | typedef enum bt_component_class_sink_graph_is_configured_method_status { |
62 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
63 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
64 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
65 | } bt_component_class_sink_graph_is_configured_method_status; | |
66 | ||
67 | typedef bt_component_class_sink_graph_is_configured_method_status | |
5badd463 PP |
68 | (*bt_component_class_sink_graph_is_configured_method)( |
69 | bt_self_component_sink *self_component); | |
70 | ||
d24d5663 PP |
71 | typedef enum bt_component_class_sink_consume_method_status { |
72 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
73 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
74 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
75 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN, | |
76 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END = __BT_FUNC_STATUS_END, | |
77 | } bt_component_class_sink_consume_method_status; | |
78 | ||
79 | typedef bt_component_class_sink_consume_method_status | |
80 | (*bt_component_class_sink_consume_method)( | |
81 | bt_self_component_sink *self_component); | |
d94d92ac PP |
82 | |
83 | static inline | |
b19ff26f PP |
84 | bt_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 | 90 | extern |
b19ff26f | 91 | bt_component_class_sink *bt_component_class_sink_create( |
0d72b8c3 PP |
92 | const char *name, |
93 | bt_component_class_sink_consume_method method); | |
94 | ||
d24d5663 PP |
95 | extern |
96 | bt_component_class_set_method_status | |
97 | bt_component_class_sink_set_init_method( | |
b19ff26f | 98 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
99 | bt_component_class_sink_init_method method); |
100 | ||
d24d5663 PP |
101 | extern |
102 | bt_component_class_set_method_status | |
103 | bt_component_class_sink_set_finalize_method( | |
b19ff26f | 104 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
105 | bt_component_class_sink_finalize_method method); |
106 | ||
d24d5663 PP |
107 | extern |
108 | bt_component_class_set_method_status | |
d0cf29ee | 109 | bt_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 | ||
d24d5663 PP |
113 | extern |
114 | bt_component_class_set_method_status | |
5badd463 PP |
115 | bt_component_class_sink_set_graph_is_configured_method( |
116 | bt_component_class_sink *comp_class, | |
117 | bt_component_class_sink_graph_is_configured_method method); | |
118 | ||
d24d5663 PP |
119 | extern |
120 | bt_component_class_set_method_status | |
121 | bt_component_class_sink_set_query_method( | |
b19ff26f | 122 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
123 | bt_component_class_sink_query_method method); |
124 | ||
d3e4dcd8 PP |
125 | #ifdef __cplusplus |
126 | } | |
127 | #endif | |
128 | ||
924dc299 | 129 | #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H */ |