lib: Reset libbabeltrace2 to SONANE 0
[babeltrace.git] / include / babeltrace / graph / component-class-source.h
1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H
2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
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
27 #include <stdint.h>
28
29 /* For bt_self_component_status */
30 #include <babeltrace/graph/self-component.h>
31
32 /* For bt_self_message_iterator_status */
33 #include <babeltrace/graph/self-message-iterator.h>
34
35 /* For bt_query_status */
36 #include <babeltrace/graph/component-class.h>
37
38 /* For bt_component_class_status */
39 #include <babeltrace/graph/component-class-const.h>
40
41 /*
42 * For bt_component_class, bt_component_class_source, bt_port_input,
43 * bt_query_executor, bt_self_component_class_source,
44 * bt_self_component_source, bt_self_component_port_output, bt_value,
45 * bt_message_array_const, bt_bool, bt_self_message_iterator,
46 * __BT_UPCAST
47 */
48 #include <babeltrace/types.h>
49
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53
54 typedef bt_self_component_status
55 (*bt_component_class_source_init_method)(
56 bt_self_component_source *self_component,
57 const bt_value *params, void *init_method_data);
58
59 typedef void (*bt_component_class_source_finalize_method)(
60 bt_self_component_source *self_component);
61
62 typedef bt_self_message_iterator_status
63 (*bt_component_class_source_message_iterator_init_method)(
64 bt_self_message_iterator *message_iterator,
65 bt_self_component_source *self_component,
66 bt_self_component_port_output *port);
67
68 typedef void
69 (*bt_component_class_source_message_iterator_finalize_method)(
70 bt_self_message_iterator *message_iterator);
71
72 typedef bt_self_message_iterator_status
73 (*bt_component_class_source_message_iterator_next_method)(
74 bt_self_message_iterator *message_iterator,
75 bt_message_array_const msgs, uint64_t capacity,
76 uint64_t *count);
77
78 typedef bt_self_message_iterator_status
79 (*bt_component_class_source_message_iterator_seek_ns_from_origin_method)(
80 bt_self_message_iterator *message_iterator,
81 int64_t ns_from_origin);
82
83 typedef bt_self_message_iterator_status
84 (*bt_component_class_source_message_iterator_seek_beginning_method)(
85 bt_self_message_iterator *message_iterator);
86
87 typedef bt_bool
88 (*bt_component_class_source_message_iterator_can_seek_ns_from_origin_method)(
89 bt_self_message_iterator *message_iterator,
90 int64_t ns_from_origin);
91
92 typedef bt_bool
93 (*bt_component_class_source_message_iterator_can_seek_beginning_method)(
94 bt_self_message_iterator *message_iterator);
95
96 typedef bt_query_status (*bt_component_class_source_query_method)(
97 bt_self_component_class_source *comp_class,
98 const bt_query_executor *query_executor,
99 const char *object, const bt_value *params,
100 const bt_value **result);
101
102 typedef bt_self_component_status
103 (*bt_component_class_source_accept_output_port_connection_method)(
104 bt_self_component_source *self_component,
105 bt_self_component_port_output *self_port,
106 const bt_port_input *other_port);
107
108 typedef bt_self_component_status
109 (*bt_component_class_source_output_port_connected_method)(
110 bt_self_component_source *self_component,
111 bt_self_component_port_output *self_port,
112 const bt_port_input *other_port);
113
114 static inline
115 bt_component_class *bt_component_class_source_as_component_class(
116 bt_component_class_source *comp_cls_source)
117 {
118 return __BT_UPCAST(bt_component_class, comp_cls_source);
119 }
120
121 extern
122 bt_component_class_source *bt_component_class_source_create(
123 const char *name,
124 bt_component_class_source_message_iterator_next_method method);
125
126 extern bt_component_class_status
127 bt_component_class_source_set_init_method(
128 bt_component_class_source *comp_class,
129 bt_component_class_source_init_method method);
130
131 extern bt_component_class_status
132 bt_component_class_source_set_finalize_method(
133 bt_component_class_source *comp_class,
134 bt_component_class_source_finalize_method method);
135
136 extern bt_component_class_status
137 bt_component_class_source_set_accept_output_port_connection_method(
138 bt_component_class_source *comp_class,
139 bt_component_class_source_accept_output_port_connection_method method);
140
141 extern bt_component_class_status
142 bt_component_class_source_set_output_port_connected_method(
143 bt_component_class_source *comp_class,
144 bt_component_class_source_output_port_connected_method method);
145
146 extern bt_component_class_status
147 bt_component_class_source_set_query_method(
148 bt_component_class_source *comp_class,
149 bt_component_class_source_query_method method);
150
151 extern bt_component_class_status
152 bt_component_class_source_set_message_iterator_init_method(
153 bt_component_class_source *comp_class,
154 bt_component_class_source_message_iterator_init_method method);
155
156 extern bt_component_class_status
157 bt_component_class_source_set_message_iterator_finalize_method(
158 bt_component_class_source *comp_class,
159 bt_component_class_source_message_iterator_finalize_method method);
160
161 extern bt_component_class_status
162 bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
163 bt_component_class_source *comp_class,
164 bt_component_class_source_message_iterator_seek_ns_from_origin_method method);
165
166 extern bt_component_class_status
167 bt_component_class_source_set_message_iterator_seek_beginning_method(
168 bt_component_class_source *comp_class,
169 bt_component_class_source_message_iterator_seek_beginning_method method);
170
171 extern bt_bool
172 bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
173 bt_component_class_source *comp_class,
174 bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method);
175
176 extern bt_bool
177 bt_component_class_source_set_message_iterator_can_seek_beginning_method(
178 bt_component_class_source *comp_class,
179 bt_component_class_source_message_iterator_can_seek_beginning_method method);
180
181 #ifdef __cplusplus
182 }
183 #endif
184
185 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H */
This page took 0.034565 seconds and 4 git commands to generate.