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/types.h>
37 struct bt_component_class
;
39 struct bt_private_component
;
40 struct bt_private_port
;
43 struct bt_private_notification_iterator
;
46 * Component class type.
48 enum bt_component_class_type
{
49 BT_COMPONENT_CLASS_TYPE_UNKNOWN
= -1,
51 /** A source component is a notification generator. */
52 BT_COMPONENT_CLASS_TYPE_SOURCE
= 0,
54 /** A sink component handles incoming notifications. */
55 BT_COMPONENT_CLASS_TYPE_SINK
= 1,
57 /** A filter component implements both Source and Sink interfaces. */
58 BT_COMPONENT_CLASS_TYPE_FILTER
= 2,
61 typedef enum bt_component_status (*bt_component_class_init_method
)(
62 struct bt_private_component
*private_component
,
63 struct bt_value
*params
, void *init_method_data
);
65 typedef void (*bt_component_class_finalize_method
)(
66 struct bt_private_component
*private_component
);
68 typedef enum bt_notification_iterator_status
69 (*bt_component_class_notification_iterator_init_method
)(
70 struct bt_private_notification_iterator
*private_notification_iterator
,
71 struct bt_private_port
*private_port
);
73 typedef void (*bt_component_class_notification_iterator_finalize_method
)(
74 struct bt_private_notification_iterator
*private_notification_iterator
);
76 typedef struct bt_notification_iterator_next_return (*bt_component_class_notification_iterator_next_method
)(
77 struct bt_private_notification_iterator
*private_notification_iterator
);
79 typedef enum bt_notification_iterator_status
80 (*bt_component_class_notification_iterator_seek_time_method
)(
81 struct bt_private_notification_iterator
*private_notification_iterator
,
84 typedef struct bt_value
*(*bt_component_class_query_method
)(
85 struct bt_component_class
*component_class
,
86 const char *object
, struct bt_value
*params
);
88 typedef enum bt_component_status (*bt_component_class_accept_port_connection_method
)(
89 struct bt_private_component
*private_component
,
90 struct bt_private_port
*self_private_port
,
91 struct bt_port
*other_port
);
93 typedef void (*bt_component_class_port_connected_method
)(
94 struct bt_private_component
*private_component
,
95 struct bt_private_port
*self_private_port
,
96 struct bt_port
*other_port
);
98 typedef void (*bt_component_class_port_disconnected_method
)(
99 struct bt_private_component
*private_component
,
100 struct bt_private_port
*private_port
);
102 extern int bt_component_class_set_init_method(
103 struct bt_component_class
*component_class
,
104 bt_component_class_init_method init_method
);
106 extern int bt_component_class_set_finalize_method(
107 struct bt_component_class
*component_class
,
108 bt_component_class_finalize_method finalize_method
);
110 extern int bt_component_class_set_accept_port_connection_method(
111 struct bt_component_class
*component_class
,
112 bt_component_class_accept_port_connection_method accept_port_connection_method
);
114 extern int bt_component_class_set_port_connected_method(
115 struct bt_component_class
*component_class
,
116 bt_component_class_port_connected_method port_connected_method
);
118 extern int bt_component_class_set_port_disconnected_method(
119 struct bt_component_class
*component_class
,
120 bt_component_class_port_disconnected_method port_disconnected_method
);
122 extern int bt_component_class_set_query_method(
123 struct bt_component_class
*component_class
,
124 bt_component_class_query_method query_method
);
126 extern int bt_component_class_set_description(
127 struct bt_component_class
*component_class
,
128 const char *description
);
130 extern int bt_component_class_set_help(
131 struct bt_component_class
*component_class
,
134 extern int bt_component_class_freeze(
135 struct bt_component_class
*component_class
);
138 * Get a component class' name.
140 * @param component_class Component class of which to get the name
141 * @returns Name of the component class
143 extern const char *bt_component_class_get_name(
144 struct bt_component_class
*component_class
);
147 * Get a component class' description.
149 * Component classes may provide an optional description. It may, however,
152 * @param component_class Component class of which to get the description
153 * @returns Description of the component class, or NULL.
155 extern const char *bt_component_class_get_description(
156 struct bt_component_class
*component_class
);
158 extern const char *bt_component_class_get_help(
159 struct bt_component_class
*component_class
);
161 extern struct bt_value
*bt_component_class_query(
162 struct bt_component_class
*component_class
,
163 const char *object
, struct bt_value
*params
);
166 * Get a component class' type.
168 * @param component_class Component class of which to get the type
169 * @returns One of #bt_component_type
171 extern enum bt_component_class_type
bt_component_class_get_type(
172 struct bt_component_class
*component_class
);
175 bt_bool
bt_component_class_is_source(struct bt_component_class
*component_class
)
177 return bt_component_class_get_type(component_class
) ==
178 BT_COMPONENT_CLASS_TYPE_SOURCE
;
182 bt_bool
bt_component_class_is_filter(struct bt_component_class
*component_class
)
184 return bt_component_class_get_type(component_class
) ==
185 BT_COMPONENT_CLASS_TYPE_FILTER
;
189 bt_bool
bt_component_class_is_sink(struct bt_component_class
*component_class
)
191 return bt_component_class_get_type(component_class
) ==
192 BT_COMPONENT_CLASS_TYPE_SINK
;
199 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */