projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H |
| 2 | #define BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H | |
| d3e4dcd8 PP |
3 | |
| 4 | /* | |
| f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
| d3e4dcd8 PP |
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 | ||
| 7b53201c PP |
27 | #include <stdint.h> |
| 28 | ||
| ee78f405 | 29 | /* For bt_self_component_status */ |
| 71c5da58 | 30 | #include <babeltrace2/graph/self-component.h> |
| 7b53201c | 31 | |
| ee78f405 | 32 | /* For bt_query_status */ |
| 71c5da58 | 33 | #include <babeltrace2/graph/component-class.h> |
| 7b53201c | 34 | |
| 4d2e0cb5 | 35 | /* For bt_component_class_status */ |
| 71c5da58 | 36 | #include <babeltrace2/graph/component-class-const.h> |
| 4d2e0cb5 | 37 | |
| 8eee8ea2 PP |
38 | /* |
| 39 | * For bt_component_class, bt_component_class_sink, bt_port_output, | |
| 40 | * bt_query_executor, bt_self_component_class_sink, | |
| 8470daa9 PP |
41 | * bt_self_component_sink, bt_self_component_port_input, bt_value, |
| 42 | * __BT_UPCAST | |
| 8eee8ea2 | 43 | */ |
| 71c5da58 | 44 | #include <babeltrace2/types.h> |
| 8eee8ea2 | 45 | |
| 83da519a PP |
46 | /* For bt_logging_level */ |
| 47 | #include <babeltrace2/logging.h> | |
| 48 | ||
| d3e4dcd8 PP |
49 | #ifdef __cplusplus |
| 50 | extern "C" { | |
| 51 | #endif | |
| 52 | ||
| ee78f405 | 53 | typedef bt_self_component_status (*bt_component_class_sink_init_method)( |
| 8eee8ea2 PP |
54 | bt_self_component_sink *self_component, |
| 55 | const bt_value *params, void *init_method_data); | |
| 7b53201c PP |
56 | |
| 57 | typedef void (*bt_component_class_sink_finalize_method)( | |
| 8eee8ea2 | 58 | bt_self_component_sink *self_component); |
| 7b53201c | 59 | |
| ee78f405 | 60 | typedef bt_query_status |
| 7b53201c | 61 | (*bt_component_class_sink_query_method)( |
| 8eee8ea2 PP |
62 | bt_self_component_class_sink *comp_class, |
| 63 | const bt_query_executor *query_executor, | |
| 64 | const char *object, const bt_value *params, | |
| 83da519a | 65 | bt_logging_level logging_level, |
| 8eee8ea2 | 66 | const bt_value **result); |
| 7b53201c | 67 | |
| ee78f405 | 68 | typedef bt_self_component_status |
| 7b53201c | 69 | (*bt_component_class_sink_input_port_connected_method)( |
| 8eee8ea2 PP |
70 | bt_self_component_sink *self_component, |
| 71 | bt_self_component_port_input *self_port, | |
| 72 | const bt_port_output *other_port); | |
| 7b53201c | 73 | |
| 1043fdea PP |
74 | typedef bt_self_component_status |
| 75 | (*bt_component_class_sink_graph_is_configured_method)( | |
| 76 | bt_self_component_sink *self_component); | |
| 77 | ||
| ee78f405 | 78 | typedef bt_self_component_status (*bt_component_class_sink_consume_method)( |
| 8eee8ea2 | 79 | bt_self_component_sink *self_component); |
| 834e9996 PP |
80 | |
| 81 | static inline | |
| 8eee8ea2 PP |
82 | bt_component_class *bt_component_class_sink_as_component_class( |
| 83 | bt_component_class_sink *comp_cls_sink) | |
| 834e9996 | 84 | { |
| 8470daa9 | 85 | return __BT_UPCAST(bt_component_class, comp_cls_sink); |
| 834e9996 | 86 | } |
| d3e4dcd8 | 87 | |
| 7b53201c | 88 | extern |
| 8eee8ea2 | 89 | bt_component_class_sink *bt_component_class_sink_create( |
| 7b53201c PP |
90 | const char *name, |
| 91 | bt_component_class_sink_consume_method method); | |
| 92 | ||
| 4d2e0cb5 | 93 | extern bt_component_class_status bt_component_class_sink_set_init_method( |
| 8eee8ea2 | 94 | bt_component_class_sink *comp_class, |
| 7b53201c PP |
95 | bt_component_class_sink_init_method method); |
| 96 | ||
| 4d2e0cb5 | 97 | extern bt_component_class_status bt_component_class_sink_set_finalize_method( |
| 8eee8ea2 | 98 | bt_component_class_sink *comp_class, |
| 7b53201c PP |
99 | bt_component_class_sink_finalize_method method); |
| 100 | ||
| 4d2e0cb5 PP |
101 | extern bt_component_class_status |
| 102 | bt_component_class_sink_set_input_port_connected_method( | |
| 8eee8ea2 | 103 | bt_component_class_sink *comp_class, |
| 7b53201c PP |
104 | bt_component_class_sink_input_port_connected_method method); |
| 105 | ||
| 1043fdea PP |
106 | extern bt_component_class_status |
| 107 | bt_component_class_sink_set_graph_is_configured_method( | |
| 108 | bt_component_class_sink *comp_class, | |
| 109 | bt_component_class_sink_graph_is_configured_method method); | |
| 110 | ||
| 4d2e0cb5 | 111 | extern bt_component_class_status bt_component_class_sink_set_query_method( |
| 8eee8ea2 | 112 | bt_component_class_sink *comp_class, |
| 7b53201c PP |
113 | bt_component_class_sink_query_method method); |
| 114 | ||
| d3e4dcd8 PP |
115 | #ifdef __cplusplus |
| 116 | } | |
| 117 | #endif | |
| 118 | ||
| 1ca80abd | 119 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H */ |