lib: remove "For *" comments in public headers
[babeltrace.git] / include / babeltrace2 / trace-ir / packet-const.h
1 #ifndef BABELTRACE2_TRACE_IR_PACKET_CONST_H
2 #define BABELTRACE2_TRACE_IR_PACKET_CONST_H
3
4 /*
5 * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 *
25 * The Common Trace Format (CTF) Specification is available at
26 * http://www.efficios.com/ctf
27 */
28
29 #ifndef __BT_IN_BABELTRACE_H
30 # error "Please include <babeltrace2/babeltrace.h> instead."
31 #endif
32
33 #include <stdint.h>
34
35 #include <babeltrace2/property.h>
36 #include <babeltrace2/types.h>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 extern const bt_stream *bt_packet_borrow_stream_const(
43 const bt_packet *packet);
44
45 extern
46 const bt_field *bt_packet_borrow_context_field_const(
47 const bt_packet *packet);
48
49 extern void bt_packet_get_ref(const bt_packet *packet);
50
51 extern void bt_packet_put_ref(const bt_packet *packet);
52
53 #define BT_PACKET_PUT_REF_AND_RESET(_var) \
54 do { \
55 bt_packet_put_ref(_var); \
56 (_var) = NULL; \
57 } while (0)
58
59 #define BT_PACKET_MOVE_REF(_var_dst, _var_src) \
60 do { \
61 bt_packet_put_ref(_var_dst); \
62 (_var_dst) = (_var_src); \
63 (_var_src) = NULL; \
64 } while (0)
65
66 #ifdef __cplusplus
67 }
68 #endif
69
70 #endif /* BABELTRACE2_TRACE_IR_PACKET_CONST_H */
This page took 0.031033 seconds and 4 git commands to generate.