lib: rename "begin" to "beginning" when used as a noun
[babeltrace.git] / include / babeltrace / trace-ir / packet.h
1 #ifndef BABELTRACE_TRACE_IR_PACKET_H
2 #define BABELTRACE_TRACE_IR_PACKET_H
3
4 /*
5 * Copyright 2016 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 #include <stdint.h>
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 struct bt_packet;
36 struct bt_packet_header_field;
37 struct bt_packet_context_field;
38 struct bt_stream;
39
40 extern struct bt_packet *bt_packet_create(struct bt_stream *stream);
41
42 extern struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet);
43
44 extern
45 struct bt_field *bt_packet_borrow_header_field(struct bt_packet *packet);
46
47 extern
48 int bt_packet_move_header_field(struct bt_packet *packet,
49 struct bt_packet_header_field *header);
50
51 extern
52 struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet);
53
54 extern
55 int bt_packet_move_context_field(struct bt_packet *packet,
56 struct bt_packet_context_field *context);
57
58 extern
59 void bt_packet_set_default_beginning_clock_value(struct bt_packet *packet,
60 uint64_t value_cycles);
61
62 extern
63 void bt_packet_set_default_end_clock_value(struct bt_packet *packet,
64 uint64_t value_cycles);
65
66 extern
67 void bt_packet_set_discarded_event_counter_snapshot(struct bt_packet *packet,
68 uint64_t value);
69
70 extern
71 void bt_packet_set_packet_counter_snapshot(struct bt_packet *packet,
72 uint64_t value);
73
74 #ifdef __cplusplus
75 }
76 #endif
77
78 #endif /* BABELTRACE_TRACE_IR_PACKET_H */
This page took 0.03076 seconds and 4 git commands to generate.