| 1 | #ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_H |
| 2 | #define BABELTRACE_COMPONENT_COMPONENT_CLASS_H |
| 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 | |
| 28 | #include <babeltrace/component/component.h> |
| 29 | #include <stdint.h> |
| 30 | |
| 31 | #ifdef __cplusplus |
| 32 | extern "C" { |
| 33 | #endif |
| 34 | |
| 35 | struct bt_component_class; |
| 36 | struct bt_component; |
| 37 | struct bt_port; |
| 38 | struct bt_connection; |
| 39 | struct bt_value; |
| 40 | struct bt_notification_iterator; |
| 41 | |
| 42 | /** |
| 43 | * Component class type. |
| 44 | */ |
| 45 | enum bt_component_class_type { |
| 46 | BT_COMPONENT_CLASS_TYPE_UNKNOWN = -1, |
| 47 | |
| 48 | /** A source component is a notification generator. */ |
| 49 | BT_COMPONENT_CLASS_TYPE_SOURCE = 0, |
| 50 | |
| 51 | /** A sink component handles incoming notifications. */ |
| 52 | BT_COMPONENT_CLASS_TYPE_SINK = 1, |
| 53 | |
| 54 | /** A filter component implements both Source and Sink interfaces. */ |
| 55 | BT_COMPONENT_CLASS_TYPE_FILTER = 2, |
| 56 | }; |
| 57 | |
| 58 | typedef enum bt_component_status (*bt_component_class_init_method)( |
| 59 | struct bt_component *component, struct bt_value *params, |
| 60 | void *init_method_data); |
| 61 | |
| 62 | typedef void (*bt_component_class_destroy_method)(struct bt_component *component); |
| 63 | |
| 64 | typedef enum bt_notification_iterator_status |
| 65 | (*bt_component_class_notification_iterator_init_method)( |
| 66 | struct bt_component *component, |
| 67 | struct bt_notification_iterator *iterator, void *init_method_data); |
| 68 | |
| 69 | typedef void (*bt_component_class_notification_iterator_destroy_method)( |
| 70 | struct bt_notification_iterator *iterator); |
| 71 | |
| 72 | typedef struct bt_notification *(*bt_component_class_notification_iterator_get_method)( |
| 73 | struct bt_notification_iterator *iterator); |
| 74 | |
| 75 | typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method)( |
| 76 | struct bt_notification_iterator *iterator); |
| 77 | |
| 78 | typedef enum bt_notification_iterator_status |
| 79 | (*bt_component_class_notification_iterator_seek_time_method)( |
| 80 | struct bt_notification_iterator *iterator, int64_t time); |
| 81 | |
| 82 | typedef struct bt_value *(*bt_component_class_query_method)( |
| 83 | struct bt_component_class *component_class, |
| 84 | const char *object, struct bt_value *params); |
| 85 | |
| 86 | typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)( |
| 87 | struct bt_component *component, struct bt_port *port); |
| 88 | |
| 89 | typedef void (*bt_component_class_port_disconnected_method)( |
| 90 | struct bt_component *component, struct bt_port *port); |
| 91 | |
| 92 | extern int bt_component_class_set_init_method( |
| 93 | struct bt_component_class *component_class, |
| 94 | bt_component_class_init_method init_method); |
| 95 | |
| 96 | extern int bt_component_class_set_destroy_method( |
| 97 | struct bt_component_class *component_class, |
| 98 | bt_component_class_destroy_method destroy_method); |
| 99 | |
| 100 | extern int bt_component_class_set_accept_port_connection_method( |
| 101 | struct bt_component_class *component_class, |
| 102 | bt_component_class_accept_port_connection_method accept_port_connection_method); |
| 103 | |
| 104 | extern int bt_component_class_set_port_disconnected_method( |
| 105 | struct bt_component_class *component_class, |
| 106 | bt_component_class_port_disconnected_method port_disconnected_method); |
| 107 | |
| 108 | extern int bt_component_class_set_query_method( |
| 109 | struct bt_component_class *component_class, |
| 110 | bt_component_class_query_method query_method); |
| 111 | |
| 112 | extern int bt_component_class_set_description( |
| 113 | struct bt_component_class *component_class, |
| 114 | const char *description); |
| 115 | |
| 116 | extern int bt_component_class_set_help( |
| 117 | struct bt_component_class *component_class, |
| 118 | const char *help); |
| 119 | |
| 120 | extern int bt_component_class_freeze( |
| 121 | struct bt_component_class *component_class); |
| 122 | |
| 123 | /** |
| 124 | * Get a component class' name. |
| 125 | * |
| 126 | * @param component_class Component class of which to get the name |
| 127 | * @returns Name of the component class |
| 128 | */ |
| 129 | extern const char *bt_component_class_get_name( |
| 130 | struct bt_component_class *component_class); |
| 131 | |
| 132 | /** |
| 133 | * Get a component class' description. |
| 134 | * |
| 135 | * Component classes may provide an optional description. It may, however, |
| 136 | * opt not to. |
| 137 | * |
| 138 | * @param component_class Component class of which to get the description |
| 139 | * @returns Description of the component class, or NULL. |
| 140 | */ |
| 141 | extern const char *bt_component_class_get_description( |
| 142 | struct bt_component_class *component_class); |
| 143 | |
| 144 | extern const char *bt_component_class_get_help( |
| 145 | struct bt_component_class *component_class); |
| 146 | |
| 147 | extern struct bt_value *bt_component_class_query( |
| 148 | struct bt_component_class *component_class, |
| 149 | const char *object, struct bt_value *params); |
| 150 | |
| 151 | /** |
| 152 | * Get a component class' type. |
| 153 | * |
| 154 | * @param component_class Component class of which to get the type |
| 155 | * @returns One of #bt_component_type |
| 156 | */ |
| 157 | extern enum bt_component_class_type bt_component_class_get_type( |
| 158 | struct bt_component_class *component_class); |
| 159 | |
| 160 | #ifdef __cplusplus |
| 161 | } |
| 162 | #endif |
| 163 | |
| 164 | #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */ |