Automatically generate discarded packets/events notifications
[babeltrace.git] / include / babeltrace / graph / notification.h
CommitLineData
1ca80abd
PP
1#ifndef BABELTRACE_GRAPH_NOTIFICATION_H
2#define BABELTRACE_GRAPH_NOTIFICATION_H
90354d3a
JG
3
4/*
5 * BabelTrace - Plug-in Notification
6 *
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * SOFTWARE.
28 */
29
90354d3a
JG
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34struct bt_notification;
35
611c29fb
JG
36/**
37 * Notification types. Unhandled notification types should be ignored.
38 */
f7665a2e 39enum bt_notification_type {
2ec84d26
PP
40 BT_NOTIFICATION_TYPE_SENTINEL = -1000,
41 BT_NOTIFICATION_TYPE_UNKNOWN = -1,
42 BT_NOTIFICATION_TYPE_ALL = -2,
43 BT_NOTIFICATION_TYPE_EVENT = 0,
44 BT_NOTIFICATION_TYPE_INACTIVITY = 1,
45 BT_NOTIFICATION_TYPE_STREAM_BEGIN = 2,
46 BT_NOTIFICATION_TYPE_STREAM_END = 3,
47 BT_NOTIFICATION_TYPE_PACKET_BEGIN = 4,
48 BT_NOTIFICATION_TYPE_PACKET_END = 5,
49 BT_NOTIFICATION_TYPE_DISCARDED_EVENTS = 6,
50 BT_NOTIFICATION_TYPE_DISCARDED_PACKETS = 7,
6cdbfd7a 51 BT_NOTIFICATION_TYPE_NR, /* Not part of ABI. */
90354d3a
JG
52};
53
611c29fb
JG
54/**
55 * Get a notification's type.
56 *
57 * @param notification Notification instance
f7665a2e 58 * @returns One of #bt_notification_type
611c29fb 59 */
f7665a2e
JG
60extern enum bt_notification_type bt_notification_get_type(
61 struct bt_notification *notification);
90354d3a 62
90354d3a
JG
63#ifdef __cplusplus
64}
65#endif
66
1ca80abd 67#endif /* BABELTRACE_GRAPH_NOTIFICATION_H */
This page took 0.036577 seconds and 4 git commands to generate.