aa56d2665fd5156f4d5ae9dd876236a49b39809c
[babeltrace.git] / include / babeltrace2 / graph / component-class-sink.h
1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H
2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H
3
4 /*
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
28 #endif
29
30 #include <stdint.h>
31
32 #include <babeltrace2/graph/component-class.h>
33 #include <babeltrace2/types.h>
34 #include <babeltrace2/logging.h>
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 typedef bt_component_class_get_supported_mip_versions_method_status
41 (*bt_component_class_sink_get_supported_mip_versions_method)(
42 bt_self_component_class_sink *comp_class,
43 const bt_value *params, void *init_method_data,
44 bt_logging_level log_level,
45 bt_integer_range_set_unsigned *supported_versions);
46
47 typedef bt_component_class_initialize_method_status
48 (*bt_component_class_sink_initialize_method)(
49 bt_self_component_sink *self_component,
50 bt_self_component_sink_configuration *config,
51 const bt_value *params, void *init_method_data);
52
53 typedef void (*bt_component_class_sink_finalize_method)(
54 bt_self_component_sink *self_component);
55
56 typedef bt_component_class_query_method_status
57 (*bt_component_class_sink_query_method)(
58 bt_self_component_class_sink *comp_class,
59 bt_private_query_executor *query_executor,
60 const char *object, const bt_value *params,
61 void *method_data, const bt_value **result);
62
63 typedef bt_component_class_port_connected_method_status
64 (*bt_component_class_sink_input_port_connected_method)(
65 bt_self_component_sink *self_component,
66 bt_self_component_port_input *self_port,
67 const bt_port_output *other_port);
68
69 typedef enum bt_component_class_sink_graph_is_configured_method_status {
70 BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK,
71 BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
72 BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
73 } bt_component_class_sink_graph_is_configured_method_status;
74
75 typedef bt_component_class_sink_graph_is_configured_method_status
76 (*bt_component_class_sink_graph_is_configured_method)(
77 bt_self_component_sink *self_component);
78
79 typedef enum bt_component_class_sink_consume_method_status {
80 BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK,
81 BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
82 BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
83 BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
84 BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END = __BT_FUNC_STATUS_END,
85 } bt_component_class_sink_consume_method_status;
86
87 typedef bt_component_class_sink_consume_method_status
88 (*bt_component_class_sink_consume_method)(
89 bt_self_component_sink *self_component);
90
91 static inline
92 bt_component_class *bt_component_class_sink_as_component_class(
93 bt_component_class_sink *comp_cls_sink)
94 {
95 return __BT_UPCAST(bt_component_class, comp_cls_sink);
96 }
97
98 extern bt_component_class_set_method_status
99 bt_component_class_sink_set_get_supported_mip_versions_method(
100 bt_component_class_sink *comp_class,
101 bt_component_class_sink_get_supported_mip_versions_method method);
102
103 extern
104 bt_component_class_sink *bt_component_class_sink_create(
105 const char *name,
106 bt_component_class_sink_consume_method method);
107
108 extern
109 bt_component_class_set_method_status
110 bt_component_class_sink_set_initialize_method(
111 bt_component_class_sink *comp_class,
112 bt_component_class_sink_initialize_method method);
113
114 extern
115 bt_component_class_set_method_status
116 bt_component_class_sink_set_finalize_method(
117 bt_component_class_sink *comp_class,
118 bt_component_class_sink_finalize_method method);
119
120 extern
121 bt_component_class_set_method_status
122 bt_component_class_sink_set_input_port_connected_method(
123 bt_component_class_sink *comp_class,
124 bt_component_class_sink_input_port_connected_method method);
125
126 extern
127 bt_component_class_set_method_status
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
132 extern
133 bt_component_class_set_method_status
134 bt_component_class_sink_set_query_method(
135 bt_component_class_sink *comp_class,
136 bt_component_class_sink_query_method method);
137
138 #ifdef __cplusplus
139 }
140 #endif
141
142 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H */
This page took 0.032332 seconds and 3 git commands to generate.