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
28 #include <babeltrace/component/component.h>
34 struct bt_component_class
;
37 * Component class type.
39 enum bt_component_class_type
{
40 BT_COMPONENT_CLASS_TYPE_UNKNOWN
= -1,
42 /** A source component is a notification generator. */
43 BT_COMPONENT_CLASS_TYPE_SOURCE
= 0,
45 /** A sink component handles incoming notifications. */
46 BT_COMPONENT_CLASS_TYPE_SINK
= 1,
48 /** A filter component implements both Source and Sink interfaces. */
49 BT_COMPONENT_CLASS_TYPE_FILTER
= 2,
52 typedef enum bt_component_status (*bt_component_class_init_method
)(
53 struct bt_component
*component
, struct bt_value
*params
,
54 void *init_method_data
);
56 typedef void (*bt_component_class_destroy_method
)(struct bt_component
*component
);
58 typedef enum bt_notification_iterator_status
59 (*bt_component_class_notification_iterator_init_method
)(
60 struct bt_component
*component
,
61 struct bt_notification_iterator
*iterator
);
63 typedef void (*bt_component_class_notification_iterator_destroy_method
)(
64 struct bt_notification_iterator
*iterator
);
66 typedef struct bt_notification
*(*bt_component_class_notification_iterator_get_method
)(
67 struct bt_notification_iterator
*iterator
);
69 typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method
)(
70 struct bt_notification_iterator
*iterator
);
72 typedef enum bt_notification_iterator_status
73 (*bt_component_class_notification_iterator_seek_time_method
)(
74 struct bt_notification_iterator
*iterator
, int64_t time
);
76 extern int bt_component_class_set_init_method(
77 struct bt_component_class
*component_class
,
78 bt_component_class_init_method init_method
);
80 extern int bt_component_class_set_destroy_method(
81 struct bt_component_class
*component_class
,
82 bt_component_class_destroy_method destroy_method
);
84 extern int bt_component_class_set_description(
85 struct bt_component_class
*component_class
,
86 const char *description
);
88 extern int bt_component_class_freeze(
89 struct bt_component_class
*component_class
);
92 * Get a component class' name.
94 * @param component_class Component class of which to get the name
95 * @returns Name of the component class
97 extern const char *bt_component_class_get_name(
98 struct bt_component_class
*component_class
);
101 * Get a component class' description.
103 * Component classes may provide an optional description. It may, however,
106 * @param component_class Component class of which to get the description
107 * @returns Description of the component class, or NULL.
109 extern const char *bt_component_class_get_description(
110 struct bt_component_class
*component_class
);
113 * Get a component class' type.
115 * @param component_class Component class of which to get the type
116 * @returns One of #bt_component_type
118 extern enum bt_component_class_type
bt_component_class_get_type(
119 struct bt_component_class
*component_class
);
125 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */