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