lib: prepare the ground for stateful query operations
[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_init_method_status
41 (*bt_component_class_source_init_method)(
42 bt_self_component_source *self_component,
43 const bt_value *params, void *init_method_data);
44
45 typedef void (*bt_component_class_source_finalize_method)(
46 bt_self_component_source *self_component);
47
48 typedef bt_component_class_message_iterator_init_method_status
49 (*bt_component_class_source_message_iterator_init_method)(
50 bt_self_message_iterator *message_iterator,
51 bt_self_component_source *self_component,
52 bt_self_component_port_output *port);
53
54 typedef void
55 (*bt_component_class_source_message_iterator_finalize_method)(
56 bt_self_message_iterator *message_iterator);
57
58 typedef bt_component_class_message_iterator_next_method_status
59 (*bt_component_class_source_message_iterator_next_method)(
60 bt_self_message_iterator *message_iterator,
61 bt_message_array_const msgs, uint64_t capacity,
62 uint64_t *count);
63
64 typedef bt_component_class_message_iterator_seek_ns_from_origin_method_status
65 (*bt_component_class_source_message_iterator_seek_ns_from_origin_method)(
66 bt_self_message_iterator *message_iterator,
67 int64_t ns_from_origin);
68
69 typedef bt_component_class_message_iterator_seek_beginning_method_status
70 (*bt_component_class_source_message_iterator_seek_beginning_method)(
71 bt_self_message_iterator *message_iterator);
72
73 typedef bt_bool
74 (*bt_component_class_source_message_iterator_can_seek_ns_from_origin_method)(
75 bt_self_message_iterator *message_iterator,
76 int64_t ns_from_origin);
77
78 typedef bt_bool
79 (*bt_component_class_source_message_iterator_can_seek_beginning_method)(
80 bt_self_message_iterator *message_iterator);
81
82 typedef bt_component_class_query_method_status
83 (*bt_component_class_source_query_method)(
84 bt_self_component_class_source *comp_class,
85 bt_private_query_executor *query_executor,
86 const char *object, const bt_value *params,
87 const bt_value **result);
88
89 typedef bt_component_class_port_connected_method_status
90 (*bt_component_class_source_output_port_connected_method)(
91 bt_self_component_source *self_component,
92 bt_self_component_port_output *self_port,
93 const bt_port_input *other_port);
94
95 static inline
96 bt_component_class *bt_component_class_source_as_component_class(
97 bt_component_class_source *comp_cls_source)
98 {
99 return __BT_UPCAST(bt_component_class, comp_cls_source);
100 }
101
102 extern
103 bt_component_class_source *bt_component_class_source_create(
104 const char *name,
105 bt_component_class_source_message_iterator_next_method method);
106
107 extern bt_component_class_set_method_status
108 bt_component_class_source_set_init_method(
109 bt_component_class_source *comp_class,
110 bt_component_class_source_init_method method);
111
112 extern bt_component_class_set_method_status
113 bt_component_class_source_set_finalize_method(
114 bt_component_class_source *comp_class,
115 bt_component_class_source_finalize_method method);
116
117 extern bt_component_class_set_method_status
118 bt_component_class_source_set_output_port_connected_method(
119 bt_component_class_source *comp_class,
120 bt_component_class_source_output_port_connected_method method);
121
122 extern bt_component_class_set_method_status
123 bt_component_class_source_set_query_method(
124 bt_component_class_source *comp_class,
125 bt_component_class_source_query_method method);
126
127 extern bt_component_class_set_method_status
128 bt_component_class_source_set_message_iterator_init_method(
129 bt_component_class_source *comp_class,
130 bt_component_class_source_message_iterator_init_method method);
131
132 extern bt_component_class_set_method_status
133 bt_component_class_source_set_message_iterator_finalize_method(
134 bt_component_class_source *comp_class,
135 bt_component_class_source_message_iterator_finalize_method method);
136
137 extern bt_component_class_set_method_status
138 bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
139 bt_component_class_source *comp_class,
140 bt_component_class_source_message_iterator_seek_ns_from_origin_method method);
141
142 extern bt_component_class_set_method_status
143 bt_component_class_source_set_message_iterator_seek_beginning_method(
144 bt_component_class_source *comp_class,
145 bt_component_class_source_message_iterator_seek_beginning_method method);
146
147 extern bt_component_class_set_method_status
148 bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
149 bt_component_class_source *comp_class,
150 bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method);
151
152 extern bt_component_class_set_method_status
153 bt_component_class_source_set_message_iterator_can_seek_beginning_method(
154 bt_component_class_source *comp_class,
155 bt_component_class_source_message_iterator_can_seek_beginning_method method);
156
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H */
This page took 0.036164 seconds and 4 git commands to generate.