Rename to separate the plug-in and component notions
[babeltrace.git] / include / babeltrace / plugin / notification / notification.h
CommitLineData
90354d3a
JG
1#ifndef BABELTRACE_PLUGIN_NOTIFICATION_H
2#define BABELTRACE_PLUGIN_NOTIFICATION_H
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
JG
39enum bt_notification_type {
40 BT_NOTIFICATION_TYPE_UNKNOWN = -1,
611c29fb
JG
41
42 /** Event delivery notification, see event.h */
f7665a2e 43 BT_NOTIFICATION_TYPE_EVENT = 0,
611c29fb
JG
44
45 /** New stream packet notification, see packet.h */
f7665a2e
JG
46 BT_NOTIFICATION_TYPE_NEW_PACKET = 1,
47
48 /** End of stream packet notification, see packet.h */
49 BT_NOTIFICATION_TYPE_END_PACKET = 1,
611c29fb
JG
50
51 /** End of trace notification, see eot.h */
f7665a2e 52 BT_NOTIFICATION_TYPE_END_OF_TRACE = 2,
90354d3a
JG
53};
54
611c29fb
JG
55/**
56 * Get a notification's type.
57 *
58 * @param notification Notification instance
f7665a2e 59 * @returns One of #bt_notification_type
611c29fb 60 */
f7665a2e
JG
61extern enum bt_notification_type bt_notification_get_type(
62 struct bt_notification *notification);
90354d3a 63
611c29fb 64/**
f7665a2e 65 * Increments the reference count of \p notification.
611c29fb
JG
66 *
67 * @param notification Notification of which to increment the reference count
68 *
f7665a2e 69 * @see bt_notification_put()
611c29fb 70 */
f7665a2e 71extern void bt_notification_get(struct bt_notification *notification);
611c29fb
JG
72
73/**
74 * Decrements the reference count of \p notification, destroying it when this
75 * count reaches 0.
76 *
77 * @param notification Notification of which to decrement the reference count
78 *
f7665a2e 79 * @see bt_notification_get()
611c29fb 80 */
f7665a2e
JG
81extern void bt_notification_put(
82 struct bt_notification *notification);
90354d3a
JG
83
84#ifdef __cplusplus
85}
86#endif
87
88#endif /* BABELTRACE_PLUGIN_NOTIFICATION_H */
This page took 0.033686 seconds and 4 git commands to generate.