1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_H
2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_H
5 * Babeltrace - Component Class Interface.
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
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
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>
38 struct bt_component_class
;
40 struct bt_private_component
;
41 struct bt_private_port
;
44 struct bt_private_notification_iterator
;
45 struct bt_query_executor
;
48 * Component class type.
50 enum bt_component_class_type
{
51 BT_COMPONENT_CLASS_TYPE_UNKNOWN
= -1,
53 /** A source component is a notification generator. */
54 BT_COMPONENT_CLASS_TYPE_SOURCE
= 0,
56 /** A sink component handles incoming notifications. */
57 BT_COMPONENT_CLASS_TYPE_SINK
= 1,
59 /** A filter component implements both Source and Sink interfaces. */
60 BT_COMPONENT_CLASS_TYPE_FILTER
= 2,
63 struct bt_notification_iterator_next_return
{
64 struct bt_notification
*notification
;
65 enum bt_notification_iterator_status status
;
68 struct bt_component_class_query_return
{
69 struct bt_value
*result
;
70 enum bt_query_status status
;
73 typedef 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
);
77 typedef void (*bt_component_class_finalize_method
)(
78 struct bt_private_component
*private_component
);
80 typedef enum bt_notification_iterator_status
81 (*bt_component_class_notification_iterator_init_method
)(
82 struct bt_private_notification_iterator
*private_notification_iterator
,
83 struct bt_private_port
*private_port
);
85 typedef void (*bt_component_class_notification_iterator_finalize_method
)(
86 struct bt_private_notification_iterator
*private_notification_iterator
);
88 typedef struct bt_notification_iterator_next_return (*bt_component_class_notification_iterator_next_method
)(
89 struct bt_private_notification_iterator
*private_notification_iterator
);
91 typedef struct bt_component_class_query_return (*bt_component_class_query_method
)(
92 struct bt_component_class
*component_class
,
93 struct bt_query_executor
*query_executor
,
94 const char *object
, struct bt_value
*params
);
96 typedef enum bt_component_status (*bt_component_class_accept_port_connection_method
)(
97 struct bt_private_component
*private_component
,
98 struct bt_private_port
*self_private_port
,
99 struct bt_port
*other_port
);
101 typedef void (*bt_component_class_port_connected_method
)(
102 struct bt_private_component
*private_component
,
103 struct bt_private_port
*self_private_port
,
104 struct bt_port
*other_port
);
106 typedef void (*bt_component_class_port_disconnected_method
)(
107 struct bt_private_component
*private_component
,
108 struct bt_private_port
*private_port
);
110 extern int bt_component_class_set_init_method(
111 struct bt_component_class
*component_class
,
112 bt_component_class_init_method init_method
);
114 extern int bt_component_class_set_finalize_method(
115 struct bt_component_class
*component_class
,
116 bt_component_class_finalize_method finalize_method
);
118 extern int bt_component_class_set_accept_port_connection_method(
119 struct bt_component_class
*component_class
,
120 bt_component_class_accept_port_connection_method accept_port_connection_method
);
122 extern int bt_component_class_set_port_connected_method(
123 struct bt_component_class
*component_class
,
124 bt_component_class_port_connected_method port_connected_method
);
126 extern int bt_component_class_set_port_disconnected_method(
127 struct bt_component_class
*component_class
,
128 bt_component_class_port_disconnected_method port_disconnected_method
);
130 extern int bt_component_class_set_query_method(
131 struct bt_component_class
*component_class
,
132 bt_component_class_query_method query_method
);
134 extern int bt_component_class_set_description(
135 struct bt_component_class
*component_class
,
136 const char *description
);
138 extern int bt_component_class_set_help(
139 struct bt_component_class
*component_class
,
142 extern int bt_component_class_freeze(
143 struct bt_component_class
*component_class
);
146 * Get a component class' name.
148 * @param component_class Component class of which to get the name
149 * @returns Name of the component class
151 extern const char *bt_component_class_get_name(
152 struct bt_component_class
*component_class
);
155 * Get a component class' description.
157 * Component classes may provide an optional description. It may, however,
160 * @param component_class Component class of which to get the description
161 * @returns Description of the component class, or NULL.
163 extern const char *bt_component_class_get_description(
164 struct bt_component_class
*component_class
);
166 extern const char *bt_component_class_get_help(
167 struct bt_component_class
*component_class
);
170 * Get a component class' type.
172 * @param component_class Component class of which to get the type
173 * @returns One of #bt_component_type
175 extern enum bt_component_class_type
bt_component_class_get_type(
176 struct bt_component_class
*component_class
);
179 bt_bool
bt_component_class_is_source(struct bt_component_class
*component_class
)
181 return bt_component_class_get_type(component_class
) ==
182 BT_COMPONENT_CLASS_TYPE_SOURCE
;
186 bt_bool
bt_component_class_is_filter(struct bt_component_class
*component_class
)
188 return bt_component_class_get_type(component_class
) ==
189 BT_COMPONENT_CLASS_TYPE_FILTER
;
193 bt_bool
bt_component_class_is_sink(struct bt_component_class
*component_class
)
195 return bt_component_class_get_type(component_class
) ==
196 BT_COMPONENT_CLASS_TYPE_SINK
;
203 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */