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 | */ | |
| 90354d3a JG |
39 | enum bt_plugin_notification_type { |
| 40 | BT_PLUGIN_NOTIFICATION_TYPE_UNKNOWN = -1, | |
| 611c29fb JG |
41 | |
| 42 | /** Event delivery notification, see event.h */ | |
| 43 | BT_PLUGIN_NOTIFICATION_TYPE_EVENT = 0, | |
| 44 | ||
| 45 | /** New stream packet notification, see packet.h */ | |
| 46 | BT_PLUGIN_NOTIFICATION_TYPE_NEW_PACKET = 1, | |
| 47 | ||
| 48 | /** End of trace notification, see eot.h */ | |
| 49 | BT_PLUGIN_NOTIFICATION_TYPE_EOT = 2, | |
| 90354d3a JG |
50 | }; |
| 51 | ||
| 611c29fb JG |
52 | /** |
| 53 | * Get a notification's type. | |
| 54 | * | |
| 55 | * @param notification Notification instance | |
| 56 | * @returns One of #bt_plugin_notification_type | |
| 57 | */ | |
| 9900dfa7 | 58 | extern enum bt_plugin_notification_type bt_plugin_notification_get_type( |
| 90354d3a JG |
59 | struct bt_plugin_notification *notification); |
| 60 | ||
| 611c29fb JG |
61 | /** |
| 62 | * Increments the reference count of \p notifiaction. | |
| 63 | * | |
| 64 | * @param notification Notification of which to increment the reference count | |
| 65 | * | |
| 66 | * @see bt_plugin_notification_put() | |
| 67 | */ | |
| 9900dfa7 JG |
68 | extern void bt_plugin_notification_get( |
| 69 | struct bt_plugin_notification *notification); | |
| 611c29fb JG |
70 | |
| 71 | /** | |
| 72 | * Decrements the reference count of \p notification, destroying it when this | |
| 73 | * count reaches 0. | |
| 74 | * | |
| 75 | * @param notification Notification of which to decrement the reference count | |
| 76 | * | |
| 77 | * @see bt_plugin_notification_get() | |
| 78 | */ | |
| 9900dfa7 JG |
79 | extern void bt_plugin_notification_put( |
| 80 | struct bt_plugin_notification *notification); | |
| 90354d3a JG |
81 | |
| 82 | #ifdef __cplusplus | |
| 83 | } | |
| 84 | #endif | |
| 85 | ||
| 86 | #endif /* BABELTRACE_PLUGIN_NOTIFICATION_H */ |