Split notification iterator API into base and specialized functions
[babeltrace.git] / include / babeltrace / graph / component-class.h
CommitLineData
1ca80abd
PP
1#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_H
2#define BABELTRACE_GRAPH_COMPONENT_CLASS_H
fc11e32c
JG
3
4/*
5 * Babeltrace - Component Class Interface.
6 *
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 * SOFTWARE.
26 */
27
cd95962c 28#include <stdint.h>
cc469c42
PP
29#include <babeltrace/graph/component-status.h>
30#include <babeltrace/graph/notification-iterator.h>
c7eee084 31#include <babeltrace/graph/query-executor.h>
c55a9f58 32#include <babeltrace/types.h>
33b34c43 33
fc11e32c
JG
34#ifdef __cplusplus
35extern "C" {
36#endif
37
fc11e32c 38struct bt_component_class;
cd95962c 39struct bt_component;
890882ef
PP
40struct bt_private_component;
41struct bt_private_port;
8f4799f7 42struct bt_port;
cd95962c 43struct bt_value;
90157d89 44struct bt_private_connection_private_notification_iterator;
c7eee084 45struct bt_query_executor;
fc11e32c 46
d3e4dcd8
PP
47/**
48 * Component class type.
49 */
50enum bt_component_class_type {
51 BT_COMPONENT_CLASS_TYPE_UNKNOWN = -1,
52
53 /** A source component is a notification generator. */
54 BT_COMPONENT_CLASS_TYPE_SOURCE = 0,
55
56 /** A sink component handles incoming notifications. */
57 BT_COMPONENT_CLASS_TYPE_SINK = 1,
58
59 /** A filter component implements both Source and Sink interfaces. */
60 BT_COMPONENT_CLASS_TYPE_FILTER = 2,
61};
62
90157d89 63struct bt_notification_iterator_next_method_return {
a22f4171
PP
64 struct bt_notification *notification;
65 enum bt_notification_iterator_status status;
66};
67
90157d89 68struct bt_component_class_query_method_return {
c7eee084
PP
69 struct bt_value *result;
70 enum bt_query_status status;
71};
72
d3e4dcd8 73typedef enum bt_component_status (*bt_component_class_init_method)(
890882ef
PP
74 struct bt_private_component *private_component,
75 struct bt_value *params, void *init_method_data);
d3e4dcd8 76
64cadc66 77typedef void (*bt_component_class_finalize_method)(
890882ef 78 struct bt_private_component *private_component);
d3e4dcd8 79
d3eb6e8f
PP
80typedef enum bt_notification_iterator_status
81 (*bt_component_class_notification_iterator_init_method)(
90157d89 82 struct bt_private_connection_private_notification_iterator *notification_iterator,
91457551 83 struct bt_private_port *private_port);
d3eb6e8f 84
64cadc66 85typedef void (*bt_component_class_notification_iterator_finalize_method)(
90157d89 86 struct bt_private_connection_private_notification_iterator *notification_iterator);
d3eb6e8f 87
90157d89
PP
88typedef struct bt_notification_iterator_next_method_return
89(*bt_component_class_notification_iterator_next_method)(
90 struct bt_private_connection_private_notification_iterator *notification_iterator);
d3eb6e8f 91
90157d89 92typedef struct bt_component_class_query_method_return (*bt_component_class_query_method)(
efa96d5d 93 struct bt_component_class *component_class,
c7eee084 94 struct bt_query_executor *query_executor,
a67681c1 95 const char *object, struct bt_value *params);
efa96d5d 96
72b913fb 97typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)(
890882ef 98 struct bt_private_component *private_component,
8f4799f7
PP
99 struct bt_private_port *self_private_port,
100 struct bt_port *other_port);
72b913fb 101
0d8b4d8e
PP
102typedef void (*bt_component_class_port_connected_method)(
103 struct bt_private_component *private_component,
104 struct bt_private_port *self_private_port,
105 struct bt_port *other_port);
106
72b913fb 107typedef void (*bt_component_class_port_disconnected_method)(
890882ef
PP
108 struct bt_private_component *private_component,
109 struct bt_private_port *private_port);
2d41b99e 110
d3e4dcd8
PP
111extern int bt_component_class_set_init_method(
112 struct bt_component_class *component_class,
90157d89 113 bt_component_class_init_method method);
d3e4dcd8 114
64cadc66 115extern int bt_component_class_set_finalize_method(
d3e4dcd8 116 struct bt_component_class *component_class,
90157d89 117 bt_component_class_finalize_method method);
d3e4dcd8 118
72b913fb
PP
119extern int bt_component_class_set_accept_port_connection_method(
120 struct bt_component_class *component_class,
90157d89 121 bt_component_class_accept_port_connection_method method);
72b913fb 122
0d8b4d8e
PP
123extern int bt_component_class_set_port_connected_method(
124 struct bt_component_class *component_class,
90157d89 125 bt_component_class_port_connected_method method);
0d8b4d8e 126
72b913fb 127extern int bt_component_class_set_port_disconnected_method(
2d41b99e 128 struct bt_component_class *component_class,
90157d89 129 bt_component_class_port_disconnected_method method);
72b913fb
PP
130
131extern int bt_component_class_set_query_method(
132 struct bt_component_class *component_class,
90157d89 133 bt_component_class_query_method method);
2d41b99e 134
d3e4dcd8
PP
135extern int bt_component_class_set_description(
136 struct bt_component_class *component_class,
137 const char *description);
38b48196 138
5536d9a6
PP
139extern int bt_component_class_set_help(
140 struct bt_component_class *component_class,
141 const char *help);
142
1e4d8103
PP
143extern int bt_component_class_freeze(
144 struct bt_component_class *component_class);
145
38b48196
JG
146/**
147 * Get a component class' name.
148 *
149 * @param component_class Component class of which to get the name
150 * @returns Name of the component class
151 */
152extern const char *bt_component_class_get_name(
153 struct bt_component_class *component_class);
154
7c7c0433
JG
155/**
156 * Get a component class' description.
157 *
158 * Component classes may provide an optional description. It may, however,
159 * opt not to.
160 *
161 * @param component_class Component class of which to get the description
162 * @returns Description of the component class, or NULL.
163 */
f3bc2010 164extern const char *bt_component_class_get_description(
7c7c0433
JG
165 struct bt_component_class *component_class);
166
5536d9a6
PP
167extern const char *bt_component_class_get_help(
168 struct bt_component_class *component_class);
169
38b48196
JG
170/**
171 * Get a component class' type.
172 *
173 * @param component_class Component class of which to get the type
174 * @returns One of #bt_component_type
175 */
d3e4dcd8 176extern enum bt_component_class_type bt_component_class_get_type(
fc11e32c
JG
177 struct bt_component_class *component_class);
178
2154eb7d 179static inline
c55a9f58 180bt_bool bt_component_class_is_source(struct bt_component_class *component_class)
2154eb7d
PP
181{
182 return bt_component_class_get_type(component_class) ==
183 BT_COMPONENT_CLASS_TYPE_SOURCE;
184}
185
186static inline
c55a9f58 187bt_bool bt_component_class_is_filter(struct bt_component_class *component_class)
2154eb7d
PP
188{
189 return bt_component_class_get_type(component_class) ==
190 BT_COMPONENT_CLASS_TYPE_FILTER;
191}
192
193static inline
c55a9f58 194bt_bool bt_component_class_is_sink(struct bt_component_class *component_class)
2154eb7d
PP
195{
196 return bt_component_class_get_type(component_class) ==
197 BT_COMPONENT_CLASS_TYPE_SINK;
198}
199
d3e4dcd8
PP
200#ifdef __cplusplus
201}
202#endif
203
1ca80abd 204#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */
This page took 0.043727 seconds and 4 git commands to generate.