lib: remove "For *" comments in public headers
[babeltrace.git] / include / babeltrace2 / graph / port-output-message-iterator.h
CommitLineData
924dc299
PP
1#ifndef BABELTRACE2_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H
2#define BABELTRACE2_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H
706a18f9
PP
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
706a18f9
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
d94d92ac
PP
30#include <stdint.h>
31
d24d5663 32#include <babeltrace2/graph/message-iterator.h>
3fadfbc0 33#include <babeltrace2/types.h>
d94d92ac 34
706a18f9
PP
35#ifdef __cplusplus
36extern "C" {
37#endif
38
d94d92ac 39static inline
d6e69534
PP
40bt_message_iterator *
41bt_port_output_message_iterator_as_message_iterator(
42 bt_port_output_message_iterator *iterator)
d94d92ac 43{
005f1204 44 return __BT_UPCAST(bt_message_iterator, iterator);
d94d92ac 45}
706a18f9 46
d6e69534
PP
47extern bt_port_output_message_iterator *
48bt_port_output_message_iterator_create(
b19ff26f
PP
49 bt_graph *graph,
50 const bt_port_output *output_port);
706a18f9 51
d24d5663 52extern bt_message_iterator_next_status
d6e69534
PP
53bt_port_output_message_iterator_next(
54 bt_port_output_message_iterator *iterator,
55 bt_message_array_const *msgs, uint64_t *count);
07245ac2 56
7474e7d3
PP
57extern 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
61extern bt_bool bt_port_output_message_iterator_can_seek_beginning(
62 bt_port_output_message_iterator *iterator);
63
d24d5663 64extern bt_message_iterator_seek_ns_from_origin_status
7474e7d3
PP
65bt_port_output_message_iterator_seek_ns_from_origin(
66 bt_port_output_message_iterator *iterator,
67 int64_t ns_from_origin);
68
d24d5663 69extern bt_message_iterator_seek_beginning_status
7474e7d3
PP
70bt_port_output_message_iterator_seek_beginning(
71 bt_port_output_message_iterator *iterator);
72
d6e69534
PP
73extern void bt_port_output_message_iterator_get_ref(
74 const bt_port_output_message_iterator *port_output_message_iterator);
c5b9b441 75
d6e69534
PP
76extern void bt_port_output_message_iterator_put_ref(
77 const bt_port_output_message_iterator *port_output_message_iterator);
c5b9b441 78
d6e69534 79#define BT_PORT_OUTPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
c5b9b441 80 do { \
d6e69534 81 bt_port_output_message_iterator_put_ref(_var); \
c5b9b441
PP
82 (_var) = NULL; \
83 } while (0)
84
d6e69534 85#define BT_PORT_OUTPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
c5b9b441 86 do { \
d6e69534 87 bt_port_output_message_iterator_put_ref(_var_dst); \
c5b9b441
PP
88 (_var_dst) = (_var_src); \
89 (_var_src) = NULL; \
90 } while (0)
91
706a18f9
PP
92#ifdef __cplusplus
93}
94#endif
95
924dc299 96#endif /* BABELTRACE2_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H */
This page took 0.043004 seconds and 4 git commands to generate.