1 #ifndef BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SINK_H
2 #define BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SINK_H
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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
28 /* For enum bt_notification_array */
29 #include <babeltrace/graph/notification.h>
31 /* For enum bt_self_component_status */
32 #include <babeltrace/graph/self-component.h>
34 /* For enum bt_query_status */
35 #include <babeltrace/graph/private-component-class.h>
41 struct bt_self_component_class_sink
;
42 struct bt_component_class_sink
;
43 struct bt_self_component_sink
;
44 struct bt_private_component_class
;
45 struct bt_private_component_class_sink
;
46 struct bt_self_component_port_input
;
47 struct bt_port_output
;
48 struct bt_query_executor
;
51 typedef enum bt_self_component_status
52 (*bt_private_component_class_sink_init_method
)(
53 struct bt_self_component_sink
*self_component
,
54 const struct bt_value
*params
, void *init_method_data
);
56 typedef void (*bt_private_component_class_sink_finalize_method
)(
57 struct bt_self_component_sink
*self_component
);
59 typedef enum bt_query_status
60 (*bt_private_component_class_sink_query_method
)(
61 struct bt_self_component_class_sink
*comp_class
,
62 struct bt_query_executor
*query_executor
,
63 const char *object
, const struct bt_value
*params
,
64 const struct bt_value
**result
);
66 typedef enum bt_self_component_status
67 (*bt_private_component_class_sink_accept_input_port_connection_method
)(
68 struct bt_self_component_sink
*self_component
,
69 struct bt_self_component_port_input
*self_port
,
70 struct bt_port_output
*other_port
);
72 typedef enum bt_self_component_status
73 (*bt_private_component_class_sink_input_port_connected_method
)(
74 struct bt_self_component_sink
*self_component
,
75 struct bt_self_component_port_input
*self_port
,
76 struct bt_port_output
*other_port
);
79 (*bt_private_component_class_sink_input_port_disconnected_method
)(
80 struct bt_self_component_sink
*self_component
,
81 struct bt_self_component_port_input
*self_port
);
83 typedef enum bt_self_component_status
84 (*bt_private_component_class_sink_consume_method
)(
85 struct bt_self_component_sink
*self_component
);
88 struct bt_private_component_class
*
89 bt_private_component_class_sink_as_private_component_class(
90 struct bt_private_component_class_sink
*priv_comp_cls_sink
)
92 return (void *) priv_comp_cls_sink
;
96 struct bt_component_class_sink
*
97 bt_private_component_class_sink_as_component_class_sink(
98 struct bt_private_component_class_sink
*priv_comp_cls_sink
)
100 return (void *) priv_comp_cls_sink
;
104 struct bt_private_component_class_sink
*bt_private_component_class_sink_create(
106 bt_private_component_class_sink_consume_method method
);
108 extern int bt_private_component_class_sink_set_init_method(
109 struct bt_private_component_class_sink
*comp_class
,
110 bt_private_component_class_sink_init_method method
);
112 extern int bt_private_component_class_sink_set_finalize_method(
113 struct bt_private_component_class_sink
*comp_class
,
114 bt_private_component_class_sink_finalize_method method
);
116 extern int bt_private_component_class_sink_set_accept_input_port_connection_method(
117 struct bt_private_component_class_sink
*comp_class
,
118 bt_private_component_class_sink_accept_input_port_connection_method method
);
120 extern int bt_private_component_class_sink_set_input_port_connected_method(
121 struct bt_private_component_class_sink
*comp_class
,
122 bt_private_component_class_sink_input_port_connected_method method
);
124 extern int bt_private_component_class_sink_set_input_port_disconnected_method(
125 struct bt_private_component_class_sink
*comp_class
,
126 bt_private_component_class_sink_input_port_disconnected_method method
);
128 extern int bt_private_component_class_sink_set_query_method(
129 struct bt_private_component_class_sink
*comp_class
,
130 bt_private_component_class_sink_query_method method
);
136 #endif /* BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SINK_H */