1 #ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_H
2 #define BABELTRACE_COMPONENT_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>
36 struct bt_component_class
;
38 struct bt_private_component
;
39 struct bt_private_port
;
42 struct bt_private_notification_iterator
;
45 * Component class type.
47 enum bt_component_class_type
{
48 BT_COMPONENT_CLASS_TYPE_UNKNOWN
= -1,
50 /** A source component is a notification generator. */
51 BT_COMPONENT_CLASS_TYPE_SOURCE
= 0,
53 /** A sink component handles incoming notifications. */
54 BT_COMPONENT_CLASS_TYPE_SINK
= 1,
56 /** A filter component implements both Source and Sink interfaces. */
57 BT_COMPONENT_CLASS_TYPE_FILTER
= 2,
60 typedef enum bt_component_status (*bt_component_class_init_method
)(
61 struct bt_private_component
*private_component
,
62 struct bt_value
*params
, void *init_method_data
);
64 typedef void (*bt_component_class_finalize_method
)(
65 struct bt_private_component
*private_component
);
67 typedef enum bt_notification_iterator_status
68 (*bt_component_class_notification_iterator_init_method
)(
69 struct bt_private_notification_iterator
*private_notification_iterator
,
70 struct bt_private_port
*private_port
);
72 typedef void (*bt_component_class_notification_iterator_finalize_method
)(
73 struct bt_private_notification_iterator
*private_notification_iterator
);
75 typedef struct bt_notification_iterator_next_return (*bt_component_class_notification_iterator_next_method
)(
76 struct bt_private_notification_iterator
*private_notification_iterator
);
78 typedef enum bt_notification_iterator_status
79 (*bt_component_class_notification_iterator_seek_time_method
)(
80 struct bt_private_notification_iterator
*private_notification_iterator
,
83 typedef struct bt_value
*(*bt_component_class_query_method
)(
84 struct bt_component_class
*component_class
,
85 const char *object
, struct bt_value
*params
);
87 typedef enum bt_component_status (*bt_component_class_accept_port_connection_method
)(
88 struct bt_private_component
*private_component
,
89 struct bt_private_port
*self_private_port
,
90 struct bt_port
*other_port
);
92 typedef void (*bt_component_class_port_connected_method
)(
93 struct bt_private_component
*private_component
,
94 struct bt_private_port
*self_private_port
,
95 struct bt_port
*other_port
);
97 typedef void (*bt_component_class_port_disconnected_method
)(
98 struct bt_private_component
*private_component
,
99 struct bt_private_port
*private_port
);
101 extern int bt_component_class_set_init_method(
102 struct bt_component_class
*component_class
,
103 bt_component_class_init_method init_method
);
105 extern int bt_component_class_set_finalize_method(
106 struct bt_component_class
*component_class
,
107 bt_component_class_finalize_method finalize_method
);
109 extern int bt_component_class_set_accept_port_connection_method(
110 struct bt_component_class
*component_class
,
111 bt_component_class_accept_port_connection_method accept_port_connection_method
);
113 extern int bt_component_class_set_port_connected_method(
114 struct bt_component_class
*component_class
,
115 bt_component_class_port_connected_method port_connected_method
);
117 extern int bt_component_class_set_port_disconnected_method(
118 struct bt_component_class
*component_class
,
119 bt_component_class_port_disconnected_method port_disconnected_method
);
121 extern int bt_component_class_set_query_method(
122 struct bt_component_class
*component_class
,
123 bt_component_class_query_method query_method
);
125 extern int bt_component_class_set_description(
126 struct bt_component_class
*component_class
,
127 const char *description
);
129 extern int bt_component_class_set_help(
130 struct bt_component_class
*component_class
,
133 extern int bt_component_class_freeze(
134 struct bt_component_class
*component_class
);
137 * Get a component class' name.
139 * @param component_class Component class of which to get the name
140 * @returns Name of the component class
142 extern const char *bt_component_class_get_name(
143 struct bt_component_class
*component_class
);
146 * Get a component class' description.
148 * Component classes may provide an optional description. It may, however,
151 * @param component_class Component class of which to get the description
152 * @returns Description of the component class, or NULL.
154 extern const char *bt_component_class_get_description(
155 struct bt_component_class
*component_class
);
157 extern const char *bt_component_class_get_help(
158 struct bt_component_class
*component_class
);
160 extern struct bt_value
*bt_component_class_query(
161 struct bt_component_class
*component_class
,
162 const char *object
, struct bt_value
*params
);
165 * Get a component class' type.
167 * @param component_class Component class of which to get the type
168 * @returns One of #bt_component_type
170 extern enum bt_component_class_type
bt_component_class_get_type(
171 struct bt_component_class
*component_class
);
177 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */