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