lib: standardize public header copyright notice
[babeltrace.git] / include / babeltrace2 / graph / port-output-message-iterator.h
1 #ifndef BABELTRACE2_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H
2 #define BABELTRACE2_GRAPH_PORT_OUTPUT_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 static inline
40 bt_message_iterator *
41 bt_port_output_message_iterator_as_message_iterator(
42 bt_port_output_message_iterator *iterator)
43 {
44 return __BT_UPCAST(bt_message_iterator, iterator);
45 }
46
47 extern bt_port_output_message_iterator *
48 bt_port_output_message_iterator_create(
49 bt_graph *graph,
50 const bt_port_output *output_port);
51
52 extern bt_message_iterator_next_status
53 bt_port_output_message_iterator_next(
54 bt_port_output_message_iterator *iterator,
55 bt_message_array_const *msgs, uint64_t *count);
56
57 extern bt_bool bt_port_output_message_iterator_can_seek_ns_from_origin(
58 bt_port_output_message_iterator *iterator,
59 int64_t ns_from_origin);
60
61 extern bt_bool bt_port_output_message_iterator_can_seek_beginning(
62 bt_port_output_message_iterator *iterator);
63
64 extern bt_message_iterator_seek_ns_from_origin_status
65 bt_port_output_message_iterator_seek_ns_from_origin(
66 bt_port_output_message_iterator *iterator,
67 int64_t ns_from_origin);
68
69 extern bt_message_iterator_seek_beginning_status
70 bt_port_output_message_iterator_seek_beginning(
71 bt_port_output_message_iterator *iterator);
72
73 extern void bt_port_output_message_iterator_get_ref(
74 const bt_port_output_message_iterator *port_output_message_iterator);
75
76 extern void bt_port_output_message_iterator_put_ref(
77 const bt_port_output_message_iterator *port_output_message_iterator);
78
79 #define BT_PORT_OUTPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
80 do { \
81 bt_port_output_message_iterator_put_ref(_var); \
82 (_var) = NULL; \
83 } while (0)
84
85 #define BT_PORT_OUTPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
86 do { \
87 bt_port_output_message_iterator_put_ref(_var_dst); \
88 (_var_dst) = (_var_src); \
89 (_var_src) = NULL; \
90 } while (0)
91
92 #ifdef __cplusplus
93 }
94 #endif
95
96 #endif /* BABELTRACE2_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H */
This page took 0.040512 seconds and 4 git commands to generate.