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