Commit | Line | Data |
---|---|---|
8c18d80b PP |
1 | #ifndef BABELTRACE_CTF_WRITER_EVENT_H |
2 | #define BABELTRACE_CTF_WRITER_EVENT_H | |
3 | ||
46bd0f2b JG |
4 | /* |
5 | * BabelTrace - CTF Writer: Event | |
6 | * | |
de9dd397 | 7 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
46bd0f2b 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 | * The Common Trace Format (CTF) Specification is available at | |
30 | * http://www.efficios.com/ctf | |
31 | */ | |
32 | ||
272df73e | 33 | #include <babeltrace/ctf-ir/event-class.h> |
adc315b8 | 34 | #include <babeltrace/ctf-ir/event.h> |
8c18d80b PP |
35 | |
36 | #ifdef __cplusplus | |
37 | extern "C" { | |
38 | #endif | |
39 | ||
40 | /* | |
41 | * bt_ctf_event_get and bt_ctf_event_put: increment and decrement | |
42 | * the event's reference count. | |
43 | * | |
839d52a5 | 44 | * You may also use bt_get() and bt_put() with event objects. |
8c18d80b PP |
45 | * |
46 | * These functions ensure that the event won't be destroyed while it | |
47 | * is in use. The same number of get and put (plus one extra put to | |
48 | * release the initial reference done at creation) have to be done to | |
49 | * destroy an event. | |
50 | * | |
51 | * When the event's reference count is decremented to 0 by a | |
52 | * bt_ctf_event_put, the event is freed. | |
53 | * | |
54 | * @param event Event instance. | |
55 | */ | |
839d52a5 PP |
56 | extern void bt_ctf_event_get(struct bt_event *event); |
57 | extern void bt_ctf_event_put(struct bt_event *event); | |
8c18d80b PP |
58 | |
59 | /* | |
60 | * bt_ctf_event_class_get and bt_ctf_event_class_put: increment and decrement | |
61 | * the event class' reference count. | |
62 | * | |
839d52a5 | 63 | * You may also use bt_get() and bt_put() with event class objects. |
8c18d80b PP |
64 | * |
65 | * These functions ensure that the event class won't be destroyed while it | |
66 | * is in use. The same number of get and put (plus one extra put to | |
67 | * release the initial reference done at creation) have to be done to | |
68 | * destroy an event class. | |
69 | * | |
70 | * When the event class' reference count is decremented to 0 by a | |
71 | * bt_ctf_event_class_put, the event class is freed. | |
72 | * | |
73 | * @param event_class Event class. | |
74 | */ | |
839d52a5 PP |
75 | extern void bt_ctf_event_class_get(struct bt_event_class *event_class); |
76 | extern void bt_ctf_event_class_put(struct bt_event_class *event_class); | |
8c18d80b PP |
77 | |
78 | #ifdef __cplusplus | |
79 | } | |
80 | #endif | |
81 | ||
82 | #endif /* BABELTRACE_CTF_WRITER_EVENT_H */ |