ir: add bt_ctf_event_freeze()
[babeltrace.git] / include / babeltrace / ctf-ir / event-internal.h
CommitLineData
adc315b8
JG
1#ifndef BABELTRACE_CTF_IR_EVENT_INTERNAL_H
2#define BABELTRACE_CTF_IR_EVENT_INTERNAL_H
273b65be
JG
3
4/*
272df73e 5 * Babeltrace - CTF IR: Event internal
273b65be 6 *
de9dd397 7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be
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
273b65be
JG
30#include <babeltrace/ctf-writer/event-types.h>
31#include <babeltrace/ctf-writer/event-fields.h>
32#include <babeltrace/babeltrace-internal.h>
dac5c838 33#include <babeltrace/values.h>
273b65be 34#include <babeltrace/ctf/types.h>
123fbdec
JG
35#include <babeltrace/ctf-ir/stream-class.h>
36#include <babeltrace/ctf-ir/stream.h>
5c3b707d 37#include <babeltrace/ctf-ir/packet.h>
83509119 38#include <babeltrace/object-internal.h>
273b65be
JG
39#include <glib.h>
40
273b65be 41struct bt_ctf_event {
83509119 42 struct bt_object base;
273b65be 43 struct bt_ctf_event_class *event_class;
5c3b707d 44 struct bt_ctf_packet *packet;
662e778c 45 struct bt_ctf_field *event_header;
5fd2e9fd 46 struct bt_ctf_field *stream_event_context;
273b65be
JG
47 struct bt_ctf_field *context_payload;
48 struct bt_ctf_field *fields_payload;
4ce9f9d0 49 int frozen;
273b65be
JG
50};
51
273b65be
JG
52BT_HIDDEN
53int bt_ctf_event_validate(struct bt_ctf_event *event);
54
55BT_HIDDEN
56int bt_ctf_event_serialize(struct bt_ctf_event *event,
57 struct ctf_stream_pos *pos);
58
662e778c
JG
59/*
60 * Attempt to populate the "id" and "timestamp" fields of the event header if
61 * they are present, unset and their types are integers.
62 *
63 * Not finding these fields or encountering unexpected types is not an error
64 * since the user may have defined a different event header layout. In this
65 * case, it is expected that the fields be manually populated before appending
66 * an event to a stream.
67 */
68BT_HIDDEN
69int bt_ctf_event_populate_event_header(struct bt_ctf_event *event);
70
4ce9f9d0
PP
71BT_HIDDEN
72void bt_ctf_event_freeze(struct bt_ctf_event *event);
73
adc315b8 74#endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */
This page took 0.031866 seconds and 4 git commands to generate.