Split notification iterator API into base and specialized functions
[babeltrace.git] / include / babeltrace / graph / component-class.h
... / ...
CommitLineData
1#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_H
2#define BABELTRACE_GRAPH_COMPONENT_CLASS_H
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
28#include <stdint.h>
29#include <babeltrace/graph/component-status.h>
30#include <babeltrace/graph/notification-iterator.h>
31#include <babeltrace/graph/query-executor.h>
32#include <babeltrace/types.h>
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38struct bt_component_class;
39struct bt_component;
40struct bt_private_component;
41struct bt_private_port;
42struct bt_port;
43struct bt_value;
44struct bt_private_connection_private_notification_iterator;
45struct bt_query_executor;
46
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
63struct bt_notification_iterator_next_method_return {
64 struct bt_notification *notification;
65 enum bt_notification_iterator_status status;
66};
67
68struct bt_component_class_query_method_return {
69 struct bt_value *result;
70 enum bt_query_status status;
71};
72
73typedef enum bt_component_status (*bt_component_class_init_method)(
74 struct bt_private_component *private_component,
75 struct bt_value *params, void *init_method_data);
76
77typedef void (*bt_component_class_finalize_method)(
78 struct bt_private_component *private_component);
79
80typedef enum bt_notification_iterator_status
81 (*bt_component_class_notification_iterator_init_method)(
82 struct bt_private_connection_private_notification_iterator *notification_iterator,
83 struct bt_private_port *private_port);
84
85typedef void (*bt_component_class_notification_iterator_finalize_method)(
86 struct bt_private_connection_private_notification_iterator *notification_iterator);
87
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);
91
92typedef struct bt_component_class_query_method_return (*bt_component_class_query_method)(
93 struct bt_component_class *component_class,
94 struct bt_query_executor *query_executor,
95 const char *object, struct bt_value *params);
96
97typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)(
98 struct bt_private_component *private_component,
99 struct bt_private_port *self_private_port,
100 struct bt_port *other_port);
101
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
107typedef void (*bt_component_class_port_disconnected_method)(
108 struct bt_private_component *private_component,
109 struct bt_private_port *private_port);
110
111extern int bt_component_class_set_init_method(
112 struct bt_component_class *component_class,
113 bt_component_class_init_method method);
114
115extern int bt_component_class_set_finalize_method(
116 struct bt_component_class *component_class,
117 bt_component_class_finalize_method method);
118
119extern int bt_component_class_set_accept_port_connection_method(
120 struct bt_component_class *component_class,
121 bt_component_class_accept_port_connection_method method);
122
123extern int bt_component_class_set_port_connected_method(
124 struct bt_component_class *component_class,
125 bt_component_class_port_connected_method method);
126
127extern int bt_component_class_set_port_disconnected_method(
128 struct bt_component_class *component_class,
129 bt_component_class_port_disconnected_method method);
130
131extern int bt_component_class_set_query_method(
132 struct bt_component_class *component_class,
133 bt_component_class_query_method method);
134
135extern int bt_component_class_set_description(
136 struct bt_component_class *component_class,
137 const char *description);
138
139extern int bt_component_class_set_help(
140 struct bt_component_class *component_class,
141 const char *help);
142
143extern int bt_component_class_freeze(
144 struct bt_component_class *component_class);
145
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
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 */
164extern const char *bt_component_class_get_description(
165 struct bt_component_class *component_class);
166
167extern const char *bt_component_class_get_help(
168 struct bt_component_class *component_class);
169
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 */
176extern enum bt_component_class_type bt_component_class_get_type(
177 struct bt_component_class *component_class);
178
179static inline
180bt_bool bt_component_class_is_source(struct bt_component_class *component_class)
181{
182 return bt_component_class_get_type(component_class) ==
183 BT_COMPONENT_CLASS_TYPE_SOURCE;
184}
185
186static inline
187bt_bool bt_component_class_is_filter(struct bt_component_class *component_class)
188{
189 return bt_component_class_get_type(component_class) ==
190 BT_COMPONENT_CLASS_TYPE_FILTER;
191}
192
193static inline
194bt_bool bt_component_class_is_sink(struct bt_component_class *component_class)
195{
196 return bt_component_class_get_type(component_class) ==
197 BT_COMPONENT_CLASS_TYPE_SINK;
198}
199
200#ifdef __cplusplus
201}
202#endif
203
204#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */
This page took 0.023196 seconds and 4 git commands to generate.