Fix callback.h documentation
[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;
34
35/*
6cba487f 36 * bt_trace_handle_get_id: returns the id associated to the handle.
842c2b97 37 */
6cba487f
MD
38int bt_trace_handle_get_id(struct bt_trace_handle *th);
39
40/*
41 * bt_trace_handle_get_path : returns the path of a trace_handle.
42 */
43const char *bt_trace_handle_get_path(struct bt_trace_handle *th);
842c2b97
JD
44
45/*
46 * bt_trace_handle_get_timestamp_begin : returns the beginning timestamp
6cba487f 47 * of a trace.
842c2b97
JD
48 */
49uint64_t bt_trace_handle_get_timestamp_begin(struct bt_trace_handle *th);
50
51/*
6cba487f
MD
52 * bt_trace_handle_get_timestamp_end : returns the end timestamp of a
53 * trace.
842c2b97
JD
54 */
55uint64_t bt_trace_handle_get_timestamp_end(struct bt_trace_handle *th);
56
57#endif /* _BABELTRACE_TRACE_HANDLE_H */
This page took 0.025332 seconds and 4 git commands to generate.