projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 924dc299 PP |
1 | #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_H |
| 2 | #define BABELTRACE2_GRAPH_COMPONENT_CLASS_H | |
| fc11e32c JG |
3 | |
| 4 | /* | |
| e2f7325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
| fc11e32c JG |
6 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 7 | * | |
| 8 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 9 | * of this software and associated documentation files (the "Software"), to deal | |
| 10 | * in the Software without restriction, including without limitation the rights | |
| 11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 12 | * copies of the Software, and to permit persons to whom the Software is | |
| 13 | * furnished to do so, subject to the following conditions: | |
| 14 | * | |
| 15 | * The above copyright notice and this permission notice shall be included in | |
| 16 | * all copies or substantial portions of the Software. | |
| 17 | * | |
| 18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
| 24 | * SOFTWARE. | |
| 25 | */ | |
| 26 | ||
| 4fa90f32 PP |
27 | #ifndef __BT_IN_BABELTRACE_H |
| 28 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
| 29 | #endif | |
| 30 | ||
| b19ff26f | 31 | /* For bt_component_class */ |
| 3fadfbc0 | 32 | #include <babeltrace2/types.h> |
| b19ff26f | 33 | |
| fc11e32c JG |
34 | #ifdef __cplusplus |
| 35 | extern "C" { | |
| 36 | #endif | |
| 37 | ||
| d24d5663 PP |
38 | typedef enum bt_component_class_init_method_status { |
| 39 | BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 40 | BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
| 41 | BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
| 42 | } bt_component_class_init_method_status; | |
| d3e4dcd8 | 43 | |
| d24d5663 PP |
44 | typedef enum bt_component_class_port_connected_method_status { |
| 45 | BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 46 | BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
| 47 | BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
| 48 | } bt_component_class_port_connected_method_status; | |
| 49 | ||
| 50 | typedef enum bt_component_class_query_method_status { | |
| 51 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 52 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN, | |
| 53 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
| 54 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
| 55 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_INVALID_OBJECT = __BT_FUNC_STATUS_INVALID_OBJECT, | |
| 56 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_INVALID_PARAMS = __BT_FUNC_STATUS_INVALID_PARAMS, | |
| 57 | } bt_component_class_query_method_status; | |
| 58 | ||
| 59 | typedef enum bt_component_class_message_iterator_init_method_status { | |
| 60 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 61 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
| 62 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
| 63 | } bt_component_class_message_iterator_init_method_status; | |
| 64 | ||
| 65 | typedef enum bt_component_class_message_iterator_next_method_status { | |
| 66 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 67 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN, | |
| 68 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
| 69 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
| 70 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END = __BT_FUNC_STATUS_END, | |
| 71 | } bt_component_class_message_iterator_next_method_status; | |
| 72 | ||
| 73 | typedef enum bt_component_class_message_iterator_seek_beginning_method_status { | |
| 74 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 75 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN, | |
| 76 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
| 77 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
| 78 | } bt_component_class_message_iterator_seek_beginning_method_status; | |
| 79 | ||
| 80 | typedef enum bt_component_class_message_iterator_seek_ns_from_origin_method_status { | |
| 81 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 82 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN, | |
| 83 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
| 84 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
| 85 | } bt_component_class_message_iterator_seek_ns_from_origin_method_status; | |
| 86 | ||
| 87 | typedef enum bt_component_class_set_method_status { | |
| 88 | BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 89 | } bt_component_class_set_method_status; | |
| 90 | ||
| 91 | typedef enum bt_component_class_set_description_status { | |
| 92 | BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 93 | BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
| 94 | } bt_component_class_set_description_status; | |
| 95 | ||
| 96 | extern bt_component_class_set_description_status | |
| 97 | bt_component_class_set_description(bt_component_class *component_class, | |
| 0d72b8c3 | 98 | const char *description); |
| 38b48196 | 99 | |
| d24d5663 PP |
100 | typedef enum bt_component_class_set_help_status { |
| 101 | BT_COMPONENT_CLASS_SET_HELP_STATUS_OK = __BT_FUNC_STATUS_OK, | |
| 102 | BT_COMPONENT_CLASS_SET_HELP_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
| 103 | } bt_component_class_set_help_status; | |
| 104 | ||
| 105 | extern bt_component_class_set_help_status bt_component_class_set_help( | |
| b19ff26f | 106 | bt_component_class *component_class, |
| 0d72b8c3 | 107 | const char *help); |
| 2154eb7d | 108 | |
| d3e4dcd8 PP |
109 | #ifdef __cplusplus |
| 110 | } | |
| 111 | #endif | |
| 112 | ||
| 924dc299 | 113 | #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_H */ |