Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H | |
d3e4dcd8 PP |
3 | |
4 | /* | |
e2f7325d | 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 | ||
0d72b8c3 PP |
27 | #include <stdint.h> |
28 | ||
4cdfc5e8 | 29 | /* For bt_self_component_status */ |
0d72b8c3 PP |
30 | #include <babeltrace/graph/self-component.h> |
31 | ||
4cdfc5e8 | 32 | /* For bt_query_status */ |
0d72b8c3 PP |
33 | #include <babeltrace/graph/component-class.h> |
34 | ||
b19ff26f PP |
35 | /* |
36 | * For bt_component_class, bt_component_class_sink, bt_port_output, | |
37 | * bt_query_executor, bt_self_component_class_sink, | |
38 | * bt_self_component_sink, bt_self_component_port_input, bt_value | |
39 | */ | |
40 | #include <babeltrace/types.h> | |
41 | ||
d3e4dcd8 PP |
42 | #ifdef __cplusplus |
43 | extern "C" { | |
44 | #endif | |
45 | ||
4cdfc5e8 | 46 | typedef bt_self_component_status (*bt_component_class_sink_init_method)( |
b19ff26f PP |
47 | bt_self_component_sink *self_component, |
48 | const bt_value *params, void *init_method_data); | |
0d72b8c3 PP |
49 | |
50 | typedef void (*bt_component_class_sink_finalize_method)( | |
b19ff26f | 51 | bt_self_component_sink *self_component); |
0d72b8c3 | 52 | |
4cdfc5e8 | 53 | typedef bt_query_status |
0d72b8c3 | 54 | (*bt_component_class_sink_query_method)( |
b19ff26f PP |
55 | bt_self_component_class_sink *comp_class, |
56 | const bt_query_executor *query_executor, | |
57 | const char *object, const bt_value *params, | |
58 | const bt_value **result); | |
0d72b8c3 | 59 | |
4cdfc5e8 | 60 | typedef bt_self_component_status |
0d72b8c3 | 61 | (*bt_component_class_sink_accept_input_port_connection_method)( |
b19ff26f PP |
62 | bt_self_component_sink *self_component, |
63 | bt_self_component_port_input *self_port, | |
64 | const bt_port_output *other_port); | |
0d72b8c3 | 65 | |
4cdfc5e8 | 66 | typedef bt_self_component_status |
0d72b8c3 | 67 | (*bt_component_class_sink_input_port_connected_method)( |
b19ff26f PP |
68 | bt_self_component_sink *self_component, |
69 | bt_self_component_port_input *self_port, | |
70 | const bt_port_output *other_port); | |
0d72b8c3 PP |
71 | |
72 | typedef void | |
73 | (*bt_component_class_sink_input_port_disconnected_method)( | |
b19ff26f PP |
74 | bt_self_component_sink *self_component, |
75 | bt_self_component_port_input *self_port); | |
0d72b8c3 | 76 | |
4cdfc5e8 | 77 | typedef bt_self_component_status (*bt_component_class_sink_consume_method)( |
b19ff26f | 78 | bt_self_component_sink *self_component); |
d94d92ac PP |
79 | |
80 | static inline | |
b19ff26f PP |
81 | bt_component_class *bt_component_class_sink_as_component_class( |
82 | bt_component_class_sink *comp_cls_sink) | |
d94d92ac PP |
83 | { |
84 | return (void *) comp_cls_sink; | |
85 | } | |
d3e4dcd8 | 86 | |
0d72b8c3 | 87 | extern |
b19ff26f | 88 | bt_component_class_sink *bt_component_class_sink_create( |
0d72b8c3 PP |
89 | const char *name, |
90 | bt_component_class_sink_consume_method method); | |
91 | ||
92 | extern int bt_component_class_sink_set_init_method( | |
b19ff26f | 93 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
94 | bt_component_class_sink_init_method method); |
95 | ||
96 | extern int bt_component_class_sink_set_finalize_method( | |
b19ff26f | 97 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
98 | bt_component_class_sink_finalize_method method); |
99 | ||
100 | extern int bt_component_class_sink_set_accept_input_port_connection_method( | |
b19ff26f | 101 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
102 | bt_component_class_sink_accept_input_port_connection_method method); |
103 | ||
104 | extern int bt_component_class_sink_set_input_port_connected_method( | |
b19ff26f | 105 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
106 | bt_component_class_sink_input_port_connected_method method); |
107 | ||
108 | extern int bt_component_class_sink_set_input_port_disconnected_method( | |
b19ff26f | 109 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
110 | bt_component_class_sink_input_port_disconnected_method method); |
111 | ||
112 | extern int bt_component_class_sink_set_query_method( | |
b19ff26f | 113 | bt_component_class_sink *comp_class, |
0d72b8c3 PP |
114 | bt_component_class_sink_query_method method); |
115 | ||
d3e4dcd8 PP |
116 | #ifdef __cplusplus |
117 | } | |
118 | #endif | |
119 | ||
1ca80abd | 120 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H */ |