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>
35 struct bt_component_class
;
37 struct bt_private_component
;
38 struct bt_private_port
;
41 struct bt_private_notification_iterator
;
44 * Component class type.
46 enum bt_component_class_type
{
47 BT_COMPONENT_CLASS_TYPE_UNKNOWN
= -1,
49 /** A source component is a notification generator. */
50 BT_COMPONENT_CLASS_TYPE_SOURCE
= 0,
52 /** A sink component handles incoming notifications. */
53 BT_COMPONENT_CLASS_TYPE_SINK
= 1,
55 /** A filter component implements both Source and Sink interfaces. */
56 BT_COMPONENT_CLASS_TYPE_FILTER
= 2,
59 typedef enum bt_component_status (*bt_component_class_init_method
)(
60 struct bt_private_component
*private_component
,
61 struct bt_value
*params
, void *init_method_data
);
63 typedef void (*bt_component_class_finalize_method
)(
64 struct bt_private_component
*private_component
);
66 typedef enum bt_notification_iterator_status
67 (*bt_component_class_notification_iterator_init_method
)(
68 struct bt_private_component
*private_component
,
69 struct bt_private_port
*private_port
,
70 struct bt_private_notification_iterator
*private_notification_iterator
);
72 typedef void (*bt_component_class_notification_iterator_finalize_method
)(
73 struct bt_private_notification_iterator
*private_notification_iterator
);
75 typedef struct bt_notification
*(*bt_component_class_notification_iterator_get_method
)(
76 struct bt_private_notification_iterator
*private_notification_iterator
);
78 typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method
)(
79 struct bt_private_notification_iterator
*private_notification_iterator
);
81 typedef enum bt_notification_iterator_status
82 (*bt_component_class_notification_iterator_seek_time_method
)(
83 struct bt_private_notification_iterator
*private_notification_iterator
,
86 typedef struct bt_value
*(*bt_component_class_query_method
)(
87 struct bt_component_class
*component_class
,
88 const char *object
, struct bt_value
*params
);
90 typedef enum bt_component_status (*bt_component_class_accept_port_connection_method
)(
91 struct bt_private_component
*private_component
,
92 struct bt_private_port
*self_private_port
,
93 struct bt_port
*other_port
);
95 typedef void (*bt_component_class_port_disconnected_method
)(
96 struct bt_private_component
*private_component
,
97 struct bt_private_port
*private_port
);
99 extern int bt_component_class_set_init_method(
100 struct bt_component_class
*component_class
,
101 bt_component_class_init_method init_method
);
103 extern int bt_component_class_set_finalize_method(
104 struct bt_component_class
*component_class
,
105 bt_component_class_finalize_method finalize_method
);
107 extern int bt_component_class_set_accept_port_connection_method(
108 struct bt_component_class
*component_class
,
109 bt_component_class_accept_port_connection_method accept_port_connection_method
);
111 extern int bt_component_class_set_port_disconnected_method(
112 struct bt_component_class
*component_class
,
113 bt_component_class_port_disconnected_method port_disconnected_method
);
115 extern int bt_component_class_set_query_method(
116 struct bt_component_class
*component_class
,
117 bt_component_class_query_method query_method
);
119 extern int bt_component_class_set_description(
120 struct bt_component_class
*component_class
,
121 const char *description
);
123 extern int bt_component_class_set_help(
124 struct bt_component_class
*component_class
,
127 extern int bt_component_class_freeze(
128 struct bt_component_class
*component_class
);
131 * Get a component class' name.
133 * @param component_class Component class of which to get the name
134 * @returns Name of the component class
136 extern const char *bt_component_class_get_name(
137 struct bt_component_class
*component_class
);
140 * Get a component class' description.
142 * Component classes may provide an optional description. It may, however,
145 * @param component_class Component class of which to get the description
146 * @returns Description of the component class, or NULL.
148 extern const char *bt_component_class_get_description(
149 struct bt_component_class
*component_class
);
151 extern const char *bt_component_class_get_help(
152 struct bt_component_class
*component_class
);
154 extern struct bt_value
*bt_component_class_query(
155 struct bt_component_class
*component_class
,
156 const char *object
, struct bt_value
*params
);
159 * Get a component class' type.
161 * @param component_class Component class of which to get the type
162 * @returns One of #bt_component_type
164 extern enum bt_component_class_type
bt_component_class_get_type(
165 struct bt_component_class
*component_class
);
171 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */