Commit | Line | Data |
---|---|---|
33b34c43 PP |
1 | #ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_H |
2 | #define BABELTRACE_COMPONENT_COMPONENT_CLASS_H | |
fc11e32c JG |
3 | |
4 | /* | |
5 | * Babeltrace - Component Class Interface. | |
6 | * | |
7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
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: | |
15 | * | |
16 | * The above copyright notice and this permission notice shall be included in | |
17 | * all copies or substantial portions of the Software. | |
18 | * | |
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 | |
25 | * SOFTWARE. | |
26 | */ | |
27 | ||
33b34c43 PP |
28 | #include <babeltrace/component/component.h> |
29 | ||
fc11e32c JG |
30 | #ifdef __cplusplus |
31 | extern "C" { | |
32 | #endif | |
33 | ||
fc11e32c JG |
34 | struct bt_component_class; |
35 | ||
d3e4dcd8 PP |
36 | /** |
37 | * Component class type. | |
38 | */ | |
39 | enum bt_component_class_type { | |
40 | BT_COMPONENT_CLASS_TYPE_UNKNOWN = -1, | |
41 | ||
42 | /** A source component is a notification generator. */ | |
43 | BT_COMPONENT_CLASS_TYPE_SOURCE = 0, | |
44 | ||
45 | /** A sink component handles incoming notifications. */ | |
46 | BT_COMPONENT_CLASS_TYPE_SINK = 1, | |
47 | ||
48 | /** A filter component implements both Source and Sink interfaces. */ | |
49 | BT_COMPONENT_CLASS_TYPE_FILTER = 2, | |
50 | }; | |
51 | ||
52 | typedef enum bt_component_status (*bt_component_class_init_method)( | |
6358c163 PP |
53 | struct bt_component *component, struct bt_value *params, |
54 | void *init_method_data); | |
d3e4dcd8 PP |
55 | |
56 | typedef void (*bt_component_class_destroy_method)(struct bt_component *component); | |
57 | ||
d3eb6e8f PP |
58 | typedef enum bt_notification_iterator_status |
59 | (*bt_component_class_notification_iterator_init_method)( | |
60 | struct bt_component *component, | |
8b0ce102 | 61 | struct bt_notification_iterator *iterator, void *init_method_data); |
d3eb6e8f PP |
62 | |
63 | typedef void (*bt_component_class_notification_iterator_destroy_method)( | |
64 | struct bt_notification_iterator *iterator); | |
65 | ||
66 | typedef struct bt_notification *(*bt_component_class_notification_iterator_get_method)( | |
67 | struct bt_notification_iterator *iterator); | |
68 | ||
69 | typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method)( | |
70 | struct bt_notification_iterator *iterator); | |
71 | ||
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); | |
75 | ||
a67681c1 | 76 | typedef struct bt_value *(*bt_component_class_query_method)( |
efa96d5d | 77 | struct bt_component_class *component_class, |
a67681c1 | 78 | const char *object, struct bt_value *params); |
efa96d5d | 79 | |
2d41b99e JG |
80 | typedef enum bt_component_status (*bt_component_class_new_connection_method)( |
81 | struct bt_port *own_port, struct bt_connection *connection); | |
82 | ||
d3e4dcd8 PP |
83 | extern int bt_component_class_set_init_method( |
84 | struct bt_component_class *component_class, | |
85 | bt_component_class_init_method init_method); | |
86 | ||
87 | extern int bt_component_class_set_destroy_method( | |
88 | struct bt_component_class *component_class, | |
89 | bt_component_class_destroy_method destroy_method); | |
90 | ||
2d41b99e JG |
91 | extern int bt_component_class_set_new_connection_method( |
92 | struct bt_component_class *component_class, | |
93 | bt_component_class_new_connection_method new_connection_method); | |
94 | ||
d3e4dcd8 PP |
95 | extern int bt_component_class_set_description( |
96 | struct bt_component_class *component_class, | |
97 | const char *description); | |
38b48196 | 98 | |
5536d9a6 PP |
99 | extern int bt_component_class_set_help( |
100 | struct bt_component_class *component_class, | |
101 | const char *help); | |
102 | ||
1e4d8103 PP |
103 | extern int bt_component_class_freeze( |
104 | struct bt_component_class *component_class); | |
105 | ||
38b48196 JG |
106 | /** |
107 | * Get a component class' name. | |
108 | * | |
109 | * @param component_class Component class of which to get the name | |
110 | * @returns Name of the component class | |
111 | */ | |
112 | extern const char *bt_component_class_get_name( | |
113 | struct bt_component_class *component_class); | |
114 | ||
7c7c0433 JG |
115 | /** |
116 | * Get a component class' description. | |
117 | * | |
118 | * Component classes may provide an optional description. It may, however, | |
119 | * opt not to. | |
120 | * | |
121 | * @param component_class Component class of which to get the description | |
122 | * @returns Description of the component class, or NULL. | |
123 | */ | |
f3bc2010 | 124 | extern const char *bt_component_class_get_description( |
7c7c0433 JG |
125 | struct bt_component_class *component_class); |
126 | ||
5536d9a6 PP |
127 | extern const char *bt_component_class_get_help( |
128 | struct bt_component_class *component_class); | |
129 | ||
a67681c1 | 130 | extern int bt_component_class_set_query_method( |
efa96d5d | 131 | struct bt_component_class *component_class, |
a67681c1 | 132 | bt_component_class_query_method query_method); |
efa96d5d | 133 | |
2d41b99e JG |
134 | extern int bt_component_class_set_new_connection_method( |
135 | struct bt_component_class *component_class, | |
136 | bt_component_class_new_connection_method new_connection_method); | |
137 | ||
a67681c1 | 138 | extern struct bt_value *bt_component_class_query( |
efa96d5d | 139 | struct bt_component_class *component_class, |
a67681c1 | 140 | const char *object, struct bt_value *params); |
efa96d5d | 141 | |
38b48196 JG |
142 | /** |
143 | * Get a component class' type. | |
144 | * | |
145 | * @param component_class Component class of which to get the type | |
146 | * @returns One of #bt_component_type | |
147 | */ | |
d3e4dcd8 | 148 | extern enum bt_component_class_type bt_component_class_get_type( |
fc11e32c JG |
149 | struct bt_component_class *component_class); |
150 | ||
d3e4dcd8 PP |
151 | #ifdef __cplusplus |
152 | } | |
153 | #endif | |
154 | ||
33b34c43 | 155 | #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */ |