Update version to 1.0.0-rc5
[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>
03798a93 26#include <babeltrace/clock-types.h>
842c2b97
JD
27
28/*
29 * trace_handle : unique identifier of a trace
30 *
31 * The trace_handle allows the user to manipulate a trace file directly.
32 * It is a unique identifier representing a trace file.
33 */
34struct bt_trace_handle;
c50d2a7a 35struct bt_ctf_event;
842c2b97 36
6cba487f 37/*
5d95b2db
JD
38 * bt_trace_handle_get_path : returns the path of a trace_handle or NULL
39 * on error.
6cba487f 40 */
e3d12cf9 41const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id);
842c2b97
JD
42
43/*
03798a93
JD
44 * bt_trace_handle_get_timestamp_begin : returns the creation time (in
45 * nanoseconds or cycles depending on type) of the buffers of a trace
46 * or -1ULL on error.
842c2b97 47 */
03798a93
JD
48uint64_t bt_trace_handle_get_timestamp_begin(struct bt_context *ctx,
49 int handle_id, enum bt_clock_type type);
842c2b97
JD
50
51/*
03798a93
JD
52 * bt_trace_handle_get_timestamp_end : returns the destruction timestamp
53 * (in anoseconds or cycles depending on type) of the buffers of a trace
54 * or -1ULL on error.
842c2b97 55 */
03798a93
JD
56uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx,
57 int handle_id, enum bt_clock_type type);
842c2b97 58
98a04903
JD
59/*
60 * bt_ctf_event_get_handle_id : get the handle id associated with an event
61 *
62 * Returns -1 on error
63 */
c50d2a7a 64int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event);
98a04903 65
842c2b97 66#endif /* _BABELTRACE_TRACE_HANDLE_H */
This page took 0.03914 seconds and 4 git commands to generate.