lib: strictly type function return status enumerations
[babeltrace.git] / include / babeltrace2 / trace-ir / clock-snapshot-const.h
CommitLineData
605e1019
PP
1#ifndef BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_CONST_H
2#define BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_CONST_H
c057dea0
PP
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
c057dea0 6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
c057dea0
PP
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 *
26 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
28 */
29
30#include <stdint.h>
c057dea0 31
605e1019 32/* For bt_clock_class, bt_clock_snapshot */
3fadfbc0 33#include <babeltrace2/types.h>
b19ff26f 34
d24d5663
PP
35/* For __BT_FUNC_STATUS_* */
36#define __BT_FUNC_STATUS_ENABLE
37#include <babeltrace2/func-status.h>
38#undef __BT_FUNC_STATUS_ENABLE
39
c057dea0
PP
40#ifdef __cplusplus
41extern "C" {
42#endif
43
605e1019
PP
44extern const bt_clock_class *bt_clock_snapshot_borrow_clock_class_const(
45 const bt_clock_snapshot *clock_snapshot);
094ff7c0 46
605e1019
PP
47extern uint64_t bt_clock_snapshot_get_value(
48 const bt_clock_snapshot *clock_snapshot);
094ff7c0 49
d24d5663
PP
50typedef enum bt_clock_snapshot_get_ns_from_origin_status {
51 BT_CLOCK_SNAPSHOT_GET_NS_FROM_ORIGIN_STATUS_OK = __BT_FUNC_STATUS_OK,
52 BT_CLOCK_SNAPSHOT_GET_NS_FROM_ORIGIN_STATUS_OVERFLOW = __BT_FUNC_STATUS_OVERFLOW,
53} bt_clock_snapshot_get_ns_from_origin_status;
54
55extern bt_clock_snapshot_get_ns_from_origin_status
56bt_clock_snapshot_get_ns_from_origin(
605e1019 57 const bt_clock_snapshot *clock_snapshot,
40f4ba76 58 int64_t *ns_from_origin);
c057dea0
PP
59
60#ifdef __cplusplus
61}
62#endif
63
d24d5663
PP
64#include <babeltrace2/undef-func-status.h>
65
605e1019 66#endif /* BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_CONST_H */
This page took 0.037794 seconds and 4 git commands to generate.