projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 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 |
| 31 | extern "C" { | |
| 32 | #endif | |
| 33 | ||
| 34 | struct bt_notification; | |
| 35 | ||
| 611c29fb JG |
36 | /** |
| 37 | * Notification types. Unhandled notification types should be ignored. | |
| 38 | */ | |
| f7665a2e JG |
39 | enum bt_notification_type { |
| 40 | BT_NOTIFICATION_TYPE_UNKNOWN = -1, | |
| 611c29fb | 41 | |
| 30d619df JG |
42 | /** |
| 43 | * All types of notifications (used to register to notification | |
| 44 | * delivery). | |
| 45 | */ | |
| 46 | BT_NOTIFICATION_TYPE_ALL = 0, | |
| 47 | ||
| 611c29fb | 48 | /** Event delivery notification, see event.h */ |
| 30d619df | 49 | BT_NOTIFICATION_TYPE_EVENT = 1, |
| 611c29fb | 50 | |
| ea0e619e JG |
51 | /** Beginning of stream packet notification, see packet.h */ |
| 52 | BT_NOTIFICATION_TYPE_PACKET_BEGIN = 2, | |
| f7665a2e JG |
53 | |
| 54 | /** End of stream packet notification, see packet.h */ | |
| 78586d8a | 55 | BT_NOTIFICATION_TYPE_PACKET_END = 3, |
| 611c29fb | 56 | |
| 043e2020 JG |
57 | /** End of stream packet notification, see stream.h */ |
| 58 | BT_NOTIFICATION_TYPE_STREAM_END = 4, | |
| 59 | ||
| 8bf65fbd | 60 | /** New trace notification, see model.h */ |
| 043e2020 | 61 | BT_NOTIFICATION_TYPE_NEW_TRACE = 5, |
| 8bf65fbd JG |
62 | |
| 63 | /** New stream class notification, see model.h */ | |
| 043e2020 | 64 | BT_NOTIFICATION_TYPE_NEW_STREAM_CLASS = 6, |
| 8bf65fbd JG |
65 | |
| 66 | /** New event class notification, see model.h */ | |
| 043e2020 | 67 | BT_NOTIFICATION_TYPE_NEW_EVENT_CLASS = 7, |
| 8bf65fbd | 68 | |
| 611c29fb | 69 | /** End of trace notification, see eot.h */ |
| 043e2020 | 70 | BT_NOTIFICATION_TYPE_END_OF_TRACE = 8, |
| 30d619df | 71 | |
| 6cdbfd7a | 72 | BT_NOTIFICATION_TYPE_NR, /* Not part of ABI. */ |
| 90354d3a JG |
73 | }; |
| 74 | ||
| 611c29fb JG |
75 | /** |
| 76 | * Get a notification's type. | |
| 77 | * | |
| 78 | * @param notification Notification instance | |
| f7665a2e | 79 | * @returns One of #bt_notification_type |
| 611c29fb | 80 | */ |
| f7665a2e JG |
81 | extern enum bt_notification_type bt_notification_get_type( |
| 82 | struct bt_notification *notification); | |
| 90354d3a | 83 | |
| 90354d3a JG |
84 | #ifdef __cplusplus |
| 85 | } | |
| 86 | #endif | |
| 87 | ||
| 88 | #endif /* BABELTRACE_PLUGIN_NOTIFICATION_H */ |