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