Rename: bt_put(), bt_get() -> bt_object_put_ref(), bt_object_get_ref()
[babeltrace.git] / include / babeltrace / ctf-writer / event-fields.h
CommitLineData
8c18d80b
PP
1#ifndef BABELTRACE_CTF_WRITER_EVENT_FIELDS_H
2#define BABELTRACE_CTF_WRITER_EVENT_FIELDS_H
3
46bd0f2b
JG
4/*
5 * BabelTrace - CTF Writer: Event Fields
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
8138bfe1 33#include <babeltrace/object.h>
8deee039
PP
34#include <babeltrace/ctf-writer/field-types.h>
35#include <babeltrace/ctf-writer/fields.h>
8c18d80b
PP
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/*
42 * bt_ctf_field_get and bt_ctf_field_put: increment and decrement the
43 * field's reference count.
44 *
8138bfe1 45 * You may also use bt_object_get_ref() and bt_object_put_ref() with field objects.
8c18d80b
PP
46 *
47 * These functions ensure that the field won't be destroyed when it
48 * is in use. The same number of get and put (plus one extra put to
49 * release the initial reference done at creation) have to be done to
50 * destroy a field.
51 *
52 * When the field's reference count is decremented to 0 by a bt_ctf_field_put,
53 * the field is freed.
54 *
55 * @param field Field instance.
56 */
8deee039
PP
57
58/* Pre-2.0 CTF writer compatibility */
59static inline
086dc475 60void bt_ctf_field_get(struct bt_ctf_field *field)
8deee039 61{
8138bfe1 62 bt_object_get_ref(field);
8deee039
PP
63}
64
65/* Pre-2.0 CTF writer compatibility */
66static inline
086dc475 67void bt_ctf_field_put(struct bt_ctf_field *field)
8deee039 68{
8138bfe1 69 bt_object_put_ref(field);
8deee039 70}
8c18d80b
PP
71
72#ifdef __cplusplus
73}
74#endif
75
76#endif /* BABELTRACE_CTF_WRITER_EVENT_FIELDS_H */
This page took 0.045671 seconds and 4 git commands to generate.