lib: create input port msg iterator from self {msg iterator, sink comp.}
[babeltrace.git] / include / babeltrace2 / graph / self-component-port-input-message-iterator.h
CommitLineData
924dc299
PP
1#ifndef BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
2#define BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
d6e69534
PP
3
4/*
bbb7b5f0 5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
d6e69534
PP
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
4fa90f32
PP
26#ifndef __BT_IN_BABELTRACE_H
27# error "Please include <babeltrace2/babeltrace.h> instead."
28#endif
29
d6e69534
PP
30#include <stdint.h>
31
d24d5663 32#include <babeltrace2/graph/message-iterator.h>
3fadfbc0 33#include <babeltrace2/types.h>
d6e69534
PP
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39static inline
40bt_message_iterator *
41bt_self_component_port_input_message_iterator_as_message_iterator(
42 bt_self_component_port_input_message_iterator *iterator)
43{
005f1204 44 return __BT_UPCAST(bt_message_iterator, iterator);
d6e69534
PP
45}
46
47extern bt_self_component_port_input_message_iterator *
ca02df0a
PP
48bt_self_component_port_input_message_iterator_create_from_message_iterator(
49 bt_self_message_iterator *self_msg_iter,
50 bt_self_component_port_input *input_port);
51
52extern bt_self_component_port_input_message_iterator *
53bt_self_component_port_input_message_iterator_create_from_sink_component(
54 bt_self_component_sink *self_comp,
d6e69534
PP
55 bt_self_component_port_input *input_port);
56
57extern bt_component *
58bt_self_component_port_input_message_iterator_borrow_component(
59 bt_self_component_port_input_message_iterator *iterator);
60
d24d5663 61extern bt_message_iterator_next_status
d6e69534
PP
62bt_self_component_port_input_message_iterator_next(
63 bt_self_component_port_input_message_iterator *iterator,
64 bt_message_array_const *msgs, uint64_t *count);
65
7474e7d3
PP
66extern bt_bool
67bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
68 bt_self_component_port_input_message_iterator *iterator,
69 int64_t ns_from_origin);
70
71extern bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning(
72 bt_self_component_port_input_message_iterator *iterator);
73
d24d5663 74extern bt_message_iterator_seek_ns_from_origin_status
7474e7d3
PP
75bt_self_component_port_input_message_iterator_seek_ns_from_origin(
76 bt_self_component_port_input_message_iterator *iterator,
77 int64_t ns_from_origin);
78
d24d5663 79extern bt_message_iterator_seek_beginning_status
7474e7d3
PP
80bt_self_component_port_input_message_iterator_seek_beginning(
81 bt_self_component_port_input_message_iterator *iterator);
82
d6e69534
PP
83extern void bt_self_component_port_input_message_iterator_get_ref(
84 const bt_self_component_port_input_message_iterator *self_component_port_input_message_iterator);
85
86extern void bt_self_component_port_input_message_iterator_put_ref(
87 const bt_self_component_port_input_message_iterator *self_component_port_input_message_iterator);
88
89#define BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
90 do { \
91 bt_self_component_port_input_message_iterator_put_ref(_var); \
92 (_var) = NULL; \
93 } while (0)
94
95#define BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
96 do { \
97 bt_self_component_port_input_message_iterator_put_ref(_var_dst); \
98 (_var_dst) = (_var_src); \
99 (_var_src) = NULL; \
100 } while (0)
101
102#ifdef __cplusplus
103}
104#endif
105
924dc299 106#endif /* BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H */
This page took 0.041907 seconds and 4 git commands to generate.