lib: Add functions to borrow specialized component classes from specialized components
[babeltrace.git] / include / babeltrace / graph / component-sink-const.h
CommitLineData
0d72b8c3
PP
1#ifndef BABELTRACE_GRAPH_COMPONENT_SINK_CONST_H
2#define BABELTRACE_GRAPH_COMPONENT_SINK_CONST_H
584e4e78
JG
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
366e034f 6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
584e4e78 7 *
584e4e78
JG
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
9ac68eb1 27#include <stdint.h>
f3bc2010 28
005f1204
PP
29/*
30 * For bt_component, bt_component_filter, bt_port_input,
752d0e47 31 * __BT_UPCAST_CONST, bt_component_class_sink
005f1204 32 */
b19ff26f
PP
33#include <babeltrace/types.h>
34
584e4e78
JG
35#ifdef __cplusplus
36extern "C" {
37#endif
38
d94d92ac 39static inline
b19ff26f
PP
40const bt_component *bt_component_sink_as_component_const(
41 const bt_component_sink *component)
d94d92ac 42{
005f1204 43 return __BT_UPCAST_CONST(bt_component, component);
d94d92ac
PP
44}
45
752d0e47
SM
46extern const bt_component_class_sink *
47bt_component_sink_borrow_class_const(
48 const bt_component_sink *component);
49
d94d92ac 50extern uint64_t bt_component_sink_get_input_port_count(
b19ff26f 51 const bt_component_sink *component);
d94d92ac 52
b19ff26f 53extern const bt_port_input *
0d72b8c3 54bt_component_sink_borrow_input_port_by_name_const(
b19ff26f 55 const bt_component_sink *component, const char *name);
cc37910d 56
b19ff26f 57extern const bt_port_input *
0d72b8c3 58bt_component_sink_borrow_input_port_by_index_const(
b19ff26f 59 const bt_component_sink *component, uint64_t index);
d3e4dcd8 60
c5b9b441 61extern void bt_component_sink_get_ref(
b19ff26f 62 const bt_component_sink *component_sink);
c5b9b441
PP
63
64extern void bt_component_sink_put_ref(
b19ff26f 65 const bt_component_sink *component_sink);
c5b9b441
PP
66
67#define BT_COMPONENT_SINK_PUT_REF_AND_RESET(_var) \
68 do { \
69 bt_component_sink_put_ref(_var); \
70 (_var) = NULL; \
71 } while (0)
72
73#define BT_COMPONENT_SINK_MOVE_REF(_var_dst, _var_src) \
74 do { \
75 bt_component_sink_put_ref(_var_dst); \
76 (_var_dst) = (_var_src); \
77 (_var_src) = NULL; \
78 } while (0)
79
584e4e78
JG
80#ifdef __cplusplus
81}
82#endif
83
0d72b8c3 84#endif /* BABELTRACE_GRAPH_COMPONENT_SINK_CONST_H */
This page took 0.046147 seconds and 4 git commands to generate.