Rename `init` methods to `initialize`
[babeltrace.git] / include / babeltrace2 / graph / component-class-source.h
1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H
2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_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_source_get_supported_mip_versions_method)(
42 bt_self_component_class_source *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_source_initialize_method)(
49 bt_self_component_source *self_component,
50 bt_self_component_source_configuration *config,
51 const bt_value *params, void *init_method_data);
52
53 typedef void (*bt_component_class_source_finalize_method)(
54 bt_self_component_source *self_component);
55
56 typedef bt_component_class_message_iterator_initialize_method_status
57 (*bt_component_class_source_message_iterator_initialize_method)(
58 bt_self_message_iterator *message_iterator,
59 bt_self_message_iterator_configuration *config,
60 bt_self_component_source *self_component,
61 bt_self_component_port_output *port);
62
63 typedef void
64 (*bt_component_class_source_message_iterator_finalize_method)(
65 bt_self_message_iterator *message_iterator);
66
67 typedef bt_component_class_message_iterator_next_method_status
68 (*bt_component_class_source_message_iterator_next_method)(
69 bt_self_message_iterator *message_iterator,
70 bt_message_array_const msgs, uint64_t capacity,
71 uint64_t *count);
72
73 typedef bt_component_class_message_iterator_seek_ns_from_origin_method_status
74 (*bt_component_class_source_message_iterator_seek_ns_from_origin_method)(
75 bt_self_message_iterator *message_iterator,
76 int64_t ns_from_origin);
77
78 typedef bt_component_class_message_iterator_seek_beginning_method_status
79 (*bt_component_class_source_message_iterator_seek_beginning_method)(
80 bt_self_message_iterator *message_iterator);
81
82 typedef bt_component_class_message_iterator_can_seek_ns_from_origin_method_status
83 (*bt_component_class_source_message_iterator_can_seek_ns_from_origin_method)(
84 bt_self_message_iterator *message_iterator,
85 int64_t ns_from_origin, bt_bool *can_seek);
86
87 typedef bt_component_class_message_iterator_can_seek_beginning_method_status
88 (*bt_component_class_source_message_iterator_can_seek_beginning_method)(
89 bt_self_message_iterator *message_iterator, bt_bool *can_seek);
90
91 typedef bt_component_class_query_method_status
92 (*bt_component_class_source_query_method)(
93 bt_self_component_class_source *comp_class,
94 bt_private_query_executor *query_executor,
95 const char *object, const bt_value *params,
96 void *method_data, const bt_value **result);
97
98 typedef bt_component_class_port_connected_method_status
99 (*bt_component_class_source_output_port_connected_method)(
100 bt_self_component_source *self_component,
101 bt_self_component_port_output *self_port,
102 const bt_port_input *other_port);
103
104 static inline
105 bt_component_class *bt_component_class_source_as_component_class(
106 bt_component_class_source *comp_cls_source)
107 {
108 return __BT_UPCAST(bt_component_class, comp_cls_source);
109 }
110
111 extern
112 bt_component_class_source *bt_component_class_source_create(
113 const char *name,
114 bt_component_class_source_message_iterator_next_method method);
115
116 extern bt_component_class_set_method_status
117 bt_component_class_source_set_get_supported_mip_versions_method(
118 bt_component_class_source *comp_class,
119 bt_component_class_source_get_supported_mip_versions_method method);
120
121 extern bt_component_class_set_method_status
122 bt_component_class_source_set_initialize_method(
123 bt_component_class_source *comp_class,
124 bt_component_class_source_initialize_method method);
125
126 extern bt_component_class_set_method_status
127 bt_component_class_source_set_finalize_method(
128 bt_component_class_source *comp_class,
129 bt_component_class_source_finalize_method method);
130
131 extern bt_component_class_set_method_status
132 bt_component_class_source_set_output_port_connected_method(
133 bt_component_class_source *comp_class,
134 bt_component_class_source_output_port_connected_method method);
135
136 extern bt_component_class_set_method_status
137 bt_component_class_source_set_query_method(
138 bt_component_class_source *comp_class,
139 bt_component_class_source_query_method method);
140
141 extern bt_component_class_set_method_status
142 bt_component_class_source_set_message_iterator_initialize_method(
143 bt_component_class_source *comp_class,
144 bt_component_class_source_message_iterator_initialize_method method);
145
146 extern bt_component_class_set_method_status
147 bt_component_class_source_set_message_iterator_finalize_method(
148 bt_component_class_source *comp_class,
149 bt_component_class_source_message_iterator_finalize_method method);
150
151 extern bt_component_class_set_method_status
152 bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
153 bt_component_class_source *comp_class,
154 bt_component_class_source_message_iterator_seek_ns_from_origin_method method);
155
156 extern bt_component_class_set_method_status
157 bt_component_class_source_set_message_iterator_seek_beginning_method(
158 bt_component_class_source *comp_class,
159 bt_component_class_source_message_iterator_seek_beginning_method method);
160
161 extern bt_component_class_set_method_status
162 bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
163 bt_component_class_source *comp_class,
164 bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method);
165
166 extern bt_component_class_set_method_status
167 bt_component_class_source_set_message_iterator_can_seek_beginning_method(
168 bt_component_class_source *comp_class,
169 bt_component_class_source_message_iterator_can_seek_beginning_method method);
170
171 #ifdef __cplusplus
172 }
173 #endif
174
175 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H */
This page took 0.033089 seconds and 4 git commands to generate.