lib: move plugin set API declarations to `babeltrace/plugin/plugin-set.h`
[babeltrace.git] / include / babeltrace / ctf-writer / event-types.h
CommitLineData
8c18d80b
PP
1#ifndef BABELTRACE_CTF_WRITER_EVENT_TYPES_H
2#define BABELTRACE_CTF_WRITER_EVENT_TYPES_H
3
46bd0f2b 4/*
de9dd397 5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
46bd0f2b
JG
6 *
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 * SOFTWARE.
26 *
27 * The Common Trace Format (CTF) Specification is available at
28 * http://www.efficios.com/ctf
29 */
30
65300d60 31#include <babeltrace/object.h>
16ca5ff0 32#include <babeltrace/ctf-writer/field-types.h>
8c18d80b
PP
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38/*
39 * bt_ctf_field_type_get and bt_ctf_field_type_put: increment and decrement
40 * the field type's reference count.
41 *
65300d60 42 * You may also use bt_object_get_ref() and bt_object_put_ref() with field type objects.
8c18d80b
PP
43 *
44 * These functions ensure that the field type won't be destroyed while it
45 * is in use. The same number of get and put (plus one extra put to
46 * release the initial reference done at creation) have to be done to
47 * destroy a field type.
48 *
49 * When the field type's reference count is decremented to 0 by a
50 * bt_ctf_field_type_put, the field type is freed.
51 *
52 * @param type Field type.
53 */
3dca2276
PP
54
55/* Pre-2.0 CTF writer compatibility */
56static inline
16ca5ff0 57void bt_ctf_field_type_get(struct bt_ctf_field_type *type)
3dca2276 58{
65300d60 59 bt_object_get_ref(type);
3dca2276
PP
60}
61
62/* Pre-2.0 CTF writer compatibility */
63static inline
16ca5ff0 64void bt_ctf_field_type_put(struct bt_ctf_field_type *type)
3dca2276 65{
65300d60 66 bt_object_put_ref(type);
3dca2276 67}
8c18d80b
PP
68
69#ifdef __cplusplus
70}
71#endif
72
73#endif /* BABELTRACE_CTF_WRITER_EVENT_TYPES_H */
This page took 0.046292 seconds and 4 git commands to generate.