| 1 | #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H |
| 2 | #define BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H |
| 3 | |
| 4 | /* |
| 5 | * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation |
| 6 | * |
| 7 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 8 | * of this software and associated documentation files (the "Software"), to deal |
| 9 | * in the Software without restriction, including without limitation the rights |
| 10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 11 | * copies of the Software, and to permit persons to whom the Software is |
| 12 | * furnished to do so, subject to the following conditions: |
| 13 | * |
| 14 | * The above copyright notice and this permission notice shall be included in |
| 15 | * all copies or substantial portions of the Software. |
| 16 | * |
| 17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 23 | * SOFTWARE. |
| 24 | */ |
| 25 | |
| 26 | #ifndef __BT_IN_BABELTRACE_H |
| 27 | # error "Please include <babeltrace2/babeltrace.h> instead." |
| 28 | #endif |
| 29 | |
| 30 | #include <stdint.h> |
| 31 | |
| 32 | #include <babeltrace2/graph/component-class.h> |
| 33 | #include <babeltrace2/types.h> |
| 34 | #include <babeltrace2/logging.h> |
| 35 | |
| 36 | #ifdef __cplusplus |
| 37 | extern "C" { |
| 38 | #endif |
| 39 | |
| 40 | typedef bt_component_class_get_supported_mip_versions_method_status |
| 41 | (*bt_component_class_sink_get_supported_mip_versions_method)( |
| 42 | bt_self_component_class_sink *comp_class, |
| 43 | const bt_value *params, void *init_method_data, |
| 44 | bt_logging_level log_level, |
| 45 | bt_integer_range_set_unsigned *supported_versions); |
| 46 | |
| 47 | typedef bt_component_class_init_method_status |
| 48 | (*bt_component_class_sink_init_method)( |
| 49 | bt_self_component_sink *self_component, |
| 50 | const bt_value *params, void *init_method_data); |
| 51 | |
| 52 | typedef void (*bt_component_class_sink_finalize_method)( |
| 53 | bt_self_component_sink *self_component); |
| 54 | |
| 55 | typedef bt_component_class_query_method_status |
| 56 | (*bt_component_class_sink_query_method)( |
| 57 | bt_self_component_class_sink *comp_class, |
| 58 | bt_private_query_executor *query_executor, |
| 59 | const char *object, const bt_value *params, |
| 60 | void *method_data, const bt_value **result); |
| 61 | |
| 62 | typedef bt_component_class_port_connected_method_status |
| 63 | (*bt_component_class_sink_input_port_connected_method)( |
| 64 | bt_self_component_sink *self_component, |
| 65 | bt_self_component_port_input *self_port, |
| 66 | const bt_port_output *other_port); |
| 67 | |
| 68 | typedef enum bt_component_class_sink_graph_is_configured_method_status { |
| 69 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, |
| 70 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, |
| 71 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, |
| 72 | } bt_component_class_sink_graph_is_configured_method_status; |
| 73 | |
| 74 | typedef bt_component_class_sink_graph_is_configured_method_status |
| 75 | (*bt_component_class_sink_graph_is_configured_method)( |
| 76 | bt_self_component_sink *self_component); |
| 77 | |
| 78 | typedef enum bt_component_class_sink_consume_method_status { |
| 79 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK = __BT_FUNC_STATUS_OK, |
| 80 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, |
| 81 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, |
| 82 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN, |
| 83 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END = __BT_FUNC_STATUS_END, |
| 84 | } bt_component_class_sink_consume_method_status; |
| 85 | |
| 86 | typedef bt_component_class_sink_consume_method_status |
| 87 | (*bt_component_class_sink_consume_method)( |
| 88 | bt_self_component_sink *self_component); |
| 89 | |
| 90 | static inline |
| 91 | bt_component_class *bt_component_class_sink_as_component_class( |
| 92 | bt_component_class_sink *comp_cls_sink) |
| 93 | { |
| 94 | return __BT_UPCAST(bt_component_class, comp_cls_sink); |
| 95 | } |
| 96 | |
| 97 | extern bt_component_class_set_method_status |
| 98 | bt_component_class_sink_set_get_supported_mip_versions_method( |
| 99 | bt_component_class_sink *comp_class, |
| 100 | bt_component_class_sink_get_supported_mip_versions_method method); |
| 101 | |
| 102 | extern |
| 103 | bt_component_class_sink *bt_component_class_sink_create( |
| 104 | const char *name, |
| 105 | bt_component_class_sink_consume_method method); |
| 106 | |
| 107 | extern |
| 108 | bt_component_class_set_method_status |
| 109 | bt_component_class_sink_set_init_method( |
| 110 | bt_component_class_sink *comp_class, |
| 111 | bt_component_class_sink_init_method method); |
| 112 | |
| 113 | extern |
| 114 | bt_component_class_set_method_status |
| 115 | bt_component_class_sink_set_finalize_method( |
| 116 | bt_component_class_sink *comp_class, |
| 117 | bt_component_class_sink_finalize_method method); |
| 118 | |
| 119 | extern |
| 120 | bt_component_class_set_method_status |
| 121 | bt_component_class_sink_set_input_port_connected_method( |
| 122 | bt_component_class_sink *comp_class, |
| 123 | bt_component_class_sink_input_port_connected_method method); |
| 124 | |
| 125 | extern |
| 126 | bt_component_class_set_method_status |
| 127 | bt_component_class_sink_set_graph_is_configured_method( |
| 128 | bt_component_class_sink *comp_class, |
| 129 | bt_component_class_sink_graph_is_configured_method method); |
| 130 | |
| 131 | extern |
| 132 | bt_component_class_set_method_status |
| 133 | bt_component_class_sink_set_query_method( |
| 134 | bt_component_class_sink *comp_class, |
| 135 | bt_component_class_sink_query_method method); |
| 136 | |
| 137 | #ifdef __cplusplus |
| 138 | } |
| 139 | #endif |
| 140 | |
| 141 | #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H */ |