1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H
2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
32 #include <babeltrace2/graph/component-class.h>
33 #include <babeltrace2/types.h>
34 #include <babeltrace2/logging.h>
40 typedef bt_component_class_init_method_status
41 (*bt_component_class_sink_init_method
)(
42 bt_self_component_sink
*self_component
,
43 const bt_value
*params
, void *init_method_data
);
45 typedef void (*bt_component_class_sink_finalize_method
)(
46 bt_self_component_sink
*self_component
);
48 typedef bt_component_class_query_method_status
49 (*bt_component_class_sink_query_method
)(
50 bt_self_component_class_sink
*comp_class
,
51 bt_private_query_executor
*query_executor
,
52 const char *object
, const bt_value
*params
,
53 const bt_value
**result
);
55 typedef bt_component_class_port_connected_method_status
56 (*bt_component_class_sink_input_port_connected_method
)(
57 bt_self_component_sink
*self_component
,
58 bt_self_component_port_input
*self_port
,
59 const bt_port_output
*other_port
);
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
;
67 typedef bt_component_class_sink_graph_is_configured_method_status
68 (*bt_component_class_sink_graph_is_configured_method
)(
69 bt_self_component_sink
*self_component
);
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
;
79 typedef bt_component_class_sink_consume_method_status
80 (*bt_component_class_sink_consume_method
)(
81 bt_self_component_sink
*self_component
);
84 bt_component_class
*bt_component_class_sink_as_component_class(
85 bt_component_class_sink
*comp_cls_sink
)
87 return __BT_UPCAST(bt_component_class
, comp_cls_sink
);
91 bt_component_class_sink
*bt_component_class_sink_create(
93 bt_component_class_sink_consume_method method
);
96 bt_component_class_set_method_status
97 bt_component_class_sink_set_init_method(
98 bt_component_class_sink
*comp_class
,
99 bt_component_class_sink_init_method method
);
102 bt_component_class_set_method_status
103 bt_component_class_sink_set_finalize_method(
104 bt_component_class_sink
*comp_class
,
105 bt_component_class_sink_finalize_method method
);
108 bt_component_class_set_method_status
109 bt_component_class_sink_set_input_port_connected_method(
110 bt_component_class_sink
*comp_class
,
111 bt_component_class_sink_input_port_connected_method method
);
114 bt_component_class_set_method_status
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
);
120 bt_component_class_set_method_status
121 bt_component_class_sink_set_query_method(
122 bt_component_class_sink
*comp_class
,
123 bt_component_class_sink_query_method method
);
129 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H */