Commit | Line | Data |
---|---|---|
90354d3a JG |
1 | #ifndef BABELTRACE_PLUGIN_NOTIFICATION_EVENT_H |
2 | #define BABELTRACE_PLUGIN_NOTIFICATION_EVENT_H | |
3 | ||
4 | /* | |
9900dfa7 | 5 | * BabelTrace - Plug-in Event Notification |
90354d3a JG |
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 | ||
f7665a2e | 34 | struct bt_notification; |
9900dfa7 JG |
35 | struct bt_ctf_trace; |
36 | struct bt_ctf_stream; | |
90354d3a JG |
37 | struct bt_ctf_event; |
38 | ||
9900dfa7 JG |
39 | /** |
40 | * Create an event notification. | |
41 | * | |
42 | * @param trace The event's trace | |
43 | * @param stream The event's stream | |
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( |
9900dfa7 JG |
50 | struct bt_ctf_trace *trace, struct bt_ctf_stream *stream, |
51 | struct bt_ctf_event *event); | |
52 | ||
53 | /** | |
54 | * Get an event notification's associated trace. | |
55 | * | |
56 | * @param notification Event notification instance | |
57 | * @returns A trace instance | |
58 | * | |
59 | * @see #bt_ctf_trace | |
60 | */ | |
f7665a2e JG |
61 | extern struct bt_ctf_trace *bt_notification_event_get_trace( |
62 | struct bt_notification *notification); | |
9900dfa7 JG |
63 | |
64 | /** | |
65 | * Get an event notification's associated stream. | |
66 | * | |
67 | * @param notification Event notification instance | |
68 | * @returns A stream instance | |
69 | * | |
70 | * @see #bt_ctf_stream | |
71 | */ | |
f7665a2e JG |
72 | extern struct bt_ctf_stream *bt_notification_event_get_stream( |
73 | struct bt_notification *notification); | |
9900dfa7 JG |
74 | |
75 | /** | |
76 | * Get an event notification's event. | |
77 | * | |
78 | * @param notification Event notification instance | |
79 | * @returns An event instance | |
80 | * | |
81 | * @see #bt_ctf_event | |
82 | */ | |
f7665a2e JG |
83 | extern struct bt_ctf_event *bt_notification_event_get_event( |
84 | struct bt_notification *notification); | |
90354d3a JG |
85 | |
86 | #ifdef __cplusplus | |
87 | } | |
88 | #endif | |
89 | ||
90 | #endif /* BABELTRACE_PLUGIN_NOTIFICATION_EVENT_H */ |