| 1 | #ifndef BABELTRACE_GRAPH_COMPONENT_SINK_INTERNAL_H |
| 2 | #define BABELTRACE_GRAPH_COMPONENT_SINK_INTERNAL_H |
| 3 | |
| 4 | /* |
| 5 | * BabelTrace - Sink Component internal |
| 6 | * |
| 7 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 8 | * |
| 9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 10 | * |
| 11 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 12 | * of this software and associated documentation files (the "Software"), to deal |
| 13 | * in the Software without restriction, including without limitation the rights |
| 14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 15 | * copies of the Software, and to permit persons to whom the Software is |
| 16 | * furnished to do so, subject to the following conditions: |
| 17 | * |
| 18 | * The above copyright notice and this permission notice shall be included in |
| 19 | * all copies or substantial portions of the Software. |
| 20 | * |
| 21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 27 | * SOFTWARE. |
| 28 | */ |
| 29 | |
| 30 | #include <babeltrace/babeltrace-internal.h> |
| 31 | #include <babeltrace/compiler-internal.h> |
| 32 | #include <babeltrace/graph/component-sink.h> |
| 33 | #include <babeltrace/graph/component-internal.h> |
| 34 | #include <babeltrace/graph/component-class-internal.h> |
| 35 | |
| 36 | struct bt_value; |
| 37 | |
| 38 | //typedef uint32_t notification_mask_t; |
| 39 | |
| 40 | struct bt_component_sink { |
| 41 | struct bt_component parent; |
| 42 | }; |
| 43 | |
| 44 | /** |
| 45 | * Allocate a sink component. |
| 46 | * |
| 47 | * @param class Component class |
| 48 | * @param params A dictionary of component parameters |
| 49 | * @returns A sink component instance |
| 50 | */ |
| 51 | BT_HIDDEN |
| 52 | struct bt_component *bt_component_sink_create( |
| 53 | struct bt_component_class *class); |
| 54 | |
| 55 | BT_HIDDEN |
| 56 | void bt_component_sink_destroy(struct bt_component *component); |
| 57 | |
| 58 | static inline |
| 59 | enum bt_component_status bt_component_sink_consume( |
| 60 | struct bt_component *component) |
| 61 | { |
| 62 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
| 63 | struct bt_component_class_sink *sink_class = NULL; |
| 64 | |
| 65 | BT_ASSERT(component); |
| 66 | BT_ASSERT(bt_component_get_class_type(component) == |
| 67 | BT_COMPONENT_CLASS_TYPE_SINK); |
| 68 | sink_class = container_of(component->class, |
| 69 | struct bt_component_class_sink, parent); |
| 70 | BT_ASSERT(sink_class->methods.consume); |
| 71 | BT_LOGD("Calling user's consume method: " |
| 72 | "comp-addr=%p, comp-name=\"%s\"", |
| 73 | component, bt_component_get_name(component)); |
| 74 | ret = sink_class->methods.consume( |
| 75 | bt_private_component_from_component(component)); |
| 76 | BT_LOGD("User method returned: status=%s", |
| 77 | bt_component_status_string(ret)); |
| 78 | if (ret < 0) { |
| 79 | BT_LOGW_STR("Consume method failed."); |
| 80 | } |
| 81 | |
| 82 | return ret; |
| 83 | } |
| 84 | |
| 85 | #endif /* BABELTRACE_GRAPH_COMPONENT_SINK_INTERNAL_H */ |