Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_NOTIFICATION_EVENT_H |
2 | #define BABELTRACE_GRAPH_NOTIFICATION_EVENT_H | |
90354d3a JG |
3 | |
4 | /* | |
9900dfa7 | 5 | * BabelTrace - Plug-in Event Notification |
90354d3a | 6 | * |
78586d8a | 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
90354d3a JG |
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 | ||
094ff7c0 PP |
30 | /* For bt_get() */ |
31 | #include <babeltrace/ref.h> | |
32 | ||
90354d3a JG |
33 | #ifdef __cplusplus |
34 | extern "C" { | |
35 | #endif | |
36 | ||
f7665a2e | 37 | struct bt_notification; |
50842bdc | 38 | struct bt_event; |
599faa1c | 39 | struct bt_clock_class_priority_map; |
90354d3a | 40 | |
9900dfa7 JG |
41 | /** |
42 | * Create an event notification. | |
43 | * | |
9900dfa7 JG |
44 | * @param event The event |
45 | * @returns An event notification instance | |
46 | * | |
f7665a2e | 47 | * @see #bt_notification_type |
9900dfa7 | 48 | */ |
f7665a2e | 49 | extern struct bt_notification *bt_notification_event_create( |
50842bdc | 50 | struct bt_event *event, |
599faa1c | 51 | struct bt_clock_class_priority_map *clock_class_priority_map); |
9900dfa7 | 52 | |
094ff7c0 PP |
53 | extern struct bt_event *bt_notification_event_borrow_event( |
54 | struct bt_notification *notification); | |
55 | ||
9900dfa7 JG |
56 | /** |
57 | * Get an event notification's event. | |
58 | * | |
59 | * @param notification Event notification instance | |
60 | * @returns An event instance | |
61 | * | |
50842bdc | 62 | * @see #bt_event |
9900dfa7 | 63 | */ |
094ff7c0 PP |
64 | static inline |
65 | struct bt_event *bt_notification_event_get_event( | |
66 | struct bt_notification *notification) | |
67 | { | |
68 | return bt_get(bt_notification_event_borrow_event(notification)); | |
69 | } | |
90354d3a | 70 | |
599faa1c | 71 | extern struct bt_clock_class_priority_map * |
094ff7c0 | 72 | bt_notification_event_borrow_clock_class_priority_map( |
599faa1c PP |
73 | struct bt_notification *notification); |
74 | ||
094ff7c0 PP |
75 | static inline |
76 | struct bt_clock_class_priority_map * | |
77 | bt_notification_event_get_clock_class_priority_map( | |
78 | struct bt_notification *notification) | |
79 | { | |
80 | return bt_get(bt_notification_event_borrow_clock_class_priority_map( | |
81 | notification)); | |
82 | } | |
83 | ||
90354d3a JG |
84 | #ifdef __cplusplus |
85 | } | |
86 | #endif | |
87 | ||
1ca80abd | 88 | #endif /* BABELTRACE_GRAPH_NOTIFICATION_EVENT_H */ |