lib: rename inactivity msg to msg iterator inactivity msg
[babeltrace.git] / include / babeltrace / graph / message-const.h
CommitLineData
d6e69534
PP
1#ifndef BABELTRACE_GRAPH_MESSAGE_CONST_H
2#define BABELTRACE_GRAPH_MESSAGE_CONST_H
90354d3a
JG
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
90354d3a
JG
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
90354d3a
JG
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
d6e69534 27/* For bt_message */
b19ff26f
PP
28#include <babeltrace/types.h>
29
90354d3a
JG
30#ifdef __cplusplus
31extern "C" {
32#endif
33
611c29fb 34/**
d6e69534 35 * Message types. Unhandled message types should be ignored.
611c29fb 36 */
4cdfc5e8 37typedef enum bt_message_type {
5df26c89 38 BT_MESSAGE_TYPE_EVENT = 0,
b9fd9cbb 39 BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY = 1,
5df26c89
PP
40 BT_MESSAGE_TYPE_STREAM_BEGINNING = 2,
41 BT_MESSAGE_TYPE_STREAM_END = 3,
42 BT_MESSAGE_TYPE_PACKET_BEGINNING = 4,
43 BT_MESSAGE_TYPE_PACKET_END = 5,
44 BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING = 6,
45 BT_MESSAGE_TYPE_STREAM_ACTIVITY_END = 7,
4c833281 46 BT_MESSAGE_TYPE_DISCARDED_EVENTS = 8,
4237f1f2 47 BT_MESSAGE_TYPE_DISCARDED_PACKETS = 9,
4cdfc5e8 48} bt_message_type;
90354d3a 49
611c29fb 50/**
d6e69534 51 * Get a message's type.
611c29fb 52 *
d6e69534
PP
53 * @param message Message instance
54 * @returns One of #bt_message_type
611c29fb 55 */
4cdfc5e8 56extern bt_message_type bt_message_get_type(const bt_message *message);
90354d3a 57
d6e69534 58extern void bt_message_get_ref(const bt_message *message);
c5b9b441 59
d6e69534 60extern void bt_message_put_ref(const bt_message *message);
c5b9b441 61
d6e69534 62#define BT_MESSAGE_PUT_REF_AND_RESET(_var) \
c5b9b441 63 do { \
d6e69534 64 bt_message_put_ref(_var); \
c5b9b441
PP
65 (_var) = NULL; \
66 } while (0)
67
d6e69534 68#define BT_MESSAGE_MOVE_REF(_var_dst, _var_src) \
c5b9b441 69 do { \
d6e69534 70 bt_message_put_ref(_var_dst); \
c5b9b441
PP
71 (_var_dst) = (_var_src); \
72 (_var_src) = NULL; \
73 } while (0)
74
90354d3a
JG
75#ifdef __cplusplus
76}
77#endif
78
d6e69534 79#endif /* BABELTRACE_GRAPH_MESSAGE_CONST_H */
This page took 0.049941 seconds and 4 git commands to generate.