1 #ifndef BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H
2 #define BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
34 typedef enum bt_message_iterator_next_status
{
35 BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
= __BT_FUNC_STATUS_OK
,
36 BT_MESSAGE_ITERATOR_NEXT_STATUS_END
= __BT_FUNC_STATUS_END
,
37 BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
38 BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
39 BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
40 } bt_message_iterator_next_status
;
42 typedef enum bt_message_iterator_seek_beginning_status
{
43 BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK
= __BT_FUNC_STATUS_OK
,
44 BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
45 BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
46 BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
47 } bt_message_iterator_seek_beginning_status
;
49 typedef enum bt_message_iterator_seek_ns_from_origin_status
{
50 BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_OK
= __BT_FUNC_STATUS_OK
,
51 BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
52 BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
53 BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
54 } bt_message_iterator_seek_ns_from_origin_status
;
56 typedef enum bt_message_iterator_can_seek_beginning_status
{
57 BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_OK
= __BT_FUNC_STATUS_OK
,
58 BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
59 BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
60 BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
61 } bt_message_iterator_can_seek_beginning_status
;
63 typedef enum bt_message_iterator_can_seek_ns_from_origin_status
{
64 BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_OK
= __BT_FUNC_STATUS_OK
,
65 BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
66 BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
67 BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
68 } bt_message_iterator_can_seek_ns_from_origin_status
;
70 typedef enum bt_message_iterator_create_from_message_iterator_status
{
71 BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK
= __BT_FUNC_STATUS_OK
,
72 BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
73 BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
74 } bt_message_iterator_create_from_message_iterator_status
;
76 typedef enum bt_message_iterator_create_from_sink_component_status
{
77 BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK
= __BT_FUNC_STATUS_OK
,
78 BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
79 BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
80 } bt_message_iterator_create_from_sink_component_status
;
84 bt_message_iterator_as_message_iterator(
85 bt_message_iterator
*iterator
)
87 return __BT_UPCAST(bt_message_iterator
, iterator
);
90 extern bt_message_iterator_create_from_message_iterator_status
91 bt_message_iterator_create_from_message_iterator(
92 bt_self_message_iterator
*self_msg_iter
,
93 bt_self_component_port_input
*input_port
,
94 bt_message_iterator
**message_iterator
);
96 extern bt_message_iterator_create_from_sink_component_status
97 bt_message_iterator_create_from_sink_component(
98 bt_self_component_sink
*self_comp
,
99 bt_self_component_port_input
*input_port
,
100 bt_message_iterator
**message_iterator
);
102 extern bt_component
*
103 bt_message_iterator_borrow_component(
104 bt_message_iterator
*iterator
);
106 extern bt_message_iterator_next_status
107 bt_message_iterator_next(
108 bt_message_iterator
*iterator
,
109 bt_message_array_const
*msgs
, uint64_t *count
);
111 extern bt_message_iterator_can_seek_ns_from_origin_status
112 bt_message_iterator_can_seek_ns_from_origin(
113 bt_message_iterator
*iterator
,
114 int64_t ns_from_origin
, bt_bool
*can_seek
);
116 extern bt_message_iterator_can_seek_beginning_status
117 bt_message_iterator_can_seek_beginning(
118 bt_message_iterator
*iterator
,
121 extern bt_message_iterator_seek_ns_from_origin_status
122 bt_message_iterator_seek_ns_from_origin(
123 bt_message_iterator
*iterator
,
124 int64_t ns_from_origin
);
126 extern bt_message_iterator_seek_beginning_status
127 bt_message_iterator_seek_beginning(
128 bt_message_iterator
*iterator
);
131 bt_message_iterator_can_seek_forward(
132 bt_message_iterator
*iterator
);
134 extern void bt_message_iterator_get_ref(
135 const bt_message_iterator
*message_iterator
);
137 extern void bt_message_iterator_put_ref(
138 const bt_message_iterator
*message_iterator
);
140 #define BT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
142 bt_message_iterator_put_ref(_var); \
146 #define BT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
148 bt_message_iterator_put_ref(_var_dst); \
149 (_var_dst) = (_var_src); \
157 #endif /* BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H */