c83bd8db60cfd42d560f4649619486cc7b917ce9
[babeltrace.git] / include / babeltrace2 / graph / self-component-port-input-message-iterator.h
1 #ifndef BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
2 #define BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_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/message-iterator.h>
33 #include <babeltrace2/types.h>
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 typedef enum bt_self_component_port_input_message_iterator_create_from_message_iterator_status {
40 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK = __BT_FUNC_STATUS_OK,
41 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
42 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
43 } bt_self_component_port_input_message_iterator_create_from_message_iterator_status;
44
45 typedef enum bt_self_component_port_input_message_iterator_create_from_sink_component_status {
46 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK = __BT_FUNC_STATUS_OK,
47 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
48 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
49 } bt_self_component_port_input_message_iterator_create_from_sink_component_status;
50
51 static inline
52 bt_message_iterator *
53 bt_self_component_port_input_message_iterator_as_message_iterator(
54 bt_self_component_port_input_message_iterator *iterator)
55 {
56 return __BT_UPCAST(bt_message_iterator, iterator);
57 }
58
59 extern bt_self_component_port_input_message_iterator_create_from_message_iterator_status
60 bt_self_component_port_input_message_iterator_create_from_message_iterator(
61 bt_self_message_iterator *self_msg_iter,
62 bt_self_component_port_input *input_port,
63 bt_self_component_port_input_message_iterator **message_iterator);
64
65 extern bt_self_component_port_input_message_iterator_create_from_sink_component_status
66 bt_self_component_port_input_message_iterator_create_from_sink_component(
67 bt_self_component_sink *self_comp,
68 bt_self_component_port_input *input_port,
69 bt_self_component_port_input_message_iterator **message_iterator);
70
71 extern bt_component *
72 bt_self_component_port_input_message_iterator_borrow_component(
73 bt_self_component_port_input_message_iterator *iterator);
74
75 extern bt_message_iterator_next_status
76 bt_self_component_port_input_message_iterator_next(
77 bt_self_component_port_input_message_iterator *iterator,
78 bt_message_array_const *msgs, uint64_t *count);
79
80 extern bt_message_iterator_can_seek_ns_from_origin_status
81 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
82 bt_self_component_port_input_message_iterator *iterator,
83 int64_t ns_from_origin, bt_bool *can_seek);
84
85 extern bt_message_iterator_can_seek_beginning_status
86 bt_self_component_port_input_message_iterator_can_seek_beginning(
87 bt_self_component_port_input_message_iterator *iterator,
88 bt_bool *can_seek);
89
90 extern bt_message_iterator_seek_ns_from_origin_status
91 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
92 bt_self_component_port_input_message_iterator *iterator,
93 int64_t ns_from_origin);
94
95 extern bt_message_iterator_seek_beginning_status
96 bt_self_component_port_input_message_iterator_seek_beginning(
97 bt_self_component_port_input_message_iterator *iterator);
98
99 extern void bt_self_component_port_input_message_iterator_get_ref(
100 const bt_self_component_port_input_message_iterator *self_component_port_input_message_iterator);
101
102 extern void bt_self_component_port_input_message_iterator_put_ref(
103 const bt_self_component_port_input_message_iterator *self_component_port_input_message_iterator);
104
105 #define BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
106 do { \
107 bt_self_component_port_input_message_iterator_put_ref(_var); \
108 (_var) = NULL; \
109 } while (0)
110
111 #define BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
112 do { \
113 bt_self_component_port_input_message_iterator_put_ref(_var_dst); \
114 (_var_dst) = (_var_src); \
115 (_var_src) = NULL; \
116 } while (0)
117
118 #ifdef __cplusplus
119 }
120 #endif
121
122 #endif /* BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H */
This page took 0.034977 seconds and 3 git commands to generate.