Plugin development API: use self enumeration and plugin types
[babeltrace.git] / include / babeltrace / graph / port-output-message-iterator.h
CommitLineData
d6e69534
PP
1#ifndef BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H
2#define BABELTRACE_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
d94d92ac
PP
26#include <stdint.h>
27
d6e69534
PP
28/* For enum bt_message_iterator_status */
29#include <babeltrace/graph/message-iterator.h>
9d408fca 30
b19ff26f 31/*
d6e69534
PP
32 * For bt_port, bt_message, bt_message_iterator,
33 * bt_port_output_message_iterator, bt_graph, bt_port_output,
34 * bt_message_array_const
b19ff26f
PP
35 */
36#include <babeltrace/types.h>
d94d92ac 37
706a18f9
PP
38#ifdef __cplusplus
39extern "C" {
40#endif
41
d94d92ac 42static inline
d6e69534
PP
43bt_message_iterator *
44bt_port_output_message_iterator_as_message_iterator(
45 bt_port_output_message_iterator *iterator)
d94d92ac
PP
46{
47 return (void *) iterator;
48}
706a18f9 49
d6e69534
PP
50extern bt_port_output_message_iterator *
51bt_port_output_message_iterator_create(
b19ff26f
PP
52 bt_graph *graph,
53 const bt_port_output *output_port);
706a18f9 54
d6e69534
PP
55extern enum bt_message_iterator_status
56bt_port_output_message_iterator_next(
57 bt_port_output_message_iterator *iterator,
58 bt_message_array_const *msgs, uint64_t *count);
07245ac2 59
d6e69534
PP
60extern void bt_port_output_message_iterator_get_ref(
61 const bt_port_output_message_iterator *port_output_message_iterator);
c5b9b441 62
d6e69534
PP
63extern void bt_port_output_message_iterator_put_ref(
64 const bt_port_output_message_iterator *port_output_message_iterator);
c5b9b441 65
d6e69534 66#define BT_PORT_OUTPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
c5b9b441 67 do { \
d6e69534 68 bt_port_output_message_iterator_put_ref(_var); \
c5b9b441
PP
69 (_var) = NULL; \
70 } while (0)
71
d6e69534 72#define BT_PORT_OUTPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
c5b9b441 73 do { \
d6e69534 74 bt_port_output_message_iterator_put_ref(_var_dst); \
c5b9b441
PP
75 (_var_dst) = (_var_src); \
76 (_var_src) = NULL; \
77 } while (0)
78
706a18f9
PP
79#ifdef __cplusplus
80}
81#endif
82
d6e69534 83#endif /* BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H */
This page took 0.033457 seconds and 4 git commands to generate.