Cleanup (messages): Make the wording of the signedness warning clearer
[babeltrace.git] / include / babeltrace / trace-handle.h
CommitLineData
842c2b97
JD
1#ifndef _BABELTRACE_TRACE_HANDLE_H
2#define _BABELTRACE_TRACE_HANDLE_H
3
4/*
5 * BabelTrace
6 *
7 * trace_handle header
8 *
9 * Copyright 2012 EfficiOS Inc. and Linux Foundation
10 *
11 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 * Julien Desfossez <julien.desfossez@efficios.com>
13 *
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
20 *
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
23 */
24
25#include <stdint.h>
26
27/*
28 * trace_handle : unique identifier of a trace
29 *
30 * The trace_handle allows the user to manipulate a trace file directly.
31 * It is a unique identifier representing a trace file.
32 */
33struct bt_trace_handle;
c50d2a7a 34struct bt_ctf_event;
842c2b97 35
6cba487f 36/*
5d95b2db
JD
37 * bt_trace_handle_get_path : returns the path of a trace_handle or NULL
38 * on error.
6cba487f 39 */
e3d12cf9 40const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id);
842c2b97
JD
41
42/*
30c276af 43 * bt_trace_handle_get_timestamp_begin : returns the creation time of the buffers
5d95b2db 44 * of a trace or -1ULL on error.
842c2b97 45 */
e3d12cf9 46uint64_t bt_trace_handle_get_timestamp_begin(struct bt_context *ctx, int handle_id);
842c2b97
JD
47
48/*
30c276af 49 * bt_trace_handle_get_timestamp_end : returns the destruction timestamp of the
5d95b2db 50 * buffers of a trace or -1ULL on error.
842c2b97 51 */
e3d12cf9 52uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx, int handle_id);
842c2b97 53
98a04903
JD
54/*
55 * bt_ctf_event_get_handle_id : get the handle id associated with an event
56 *
57 * Returns -1 on error
58 */
c50d2a7a 59int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event);
98a04903 60
842c2b97 61#endif /* _BABELTRACE_TRACE_HANDLE_H */
This page took 0.035395 seconds and 4 git commands to generate.