Add missing permission notice in each source file
[babeltrace.git] / include / babeltrace / trace-handle.h
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 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 * SOFTWARE.
31 */
32
33 #include <stdint.h>
34 #include <babeltrace/clock-types.h>
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 /*
41 * trace_handle : unique identifier of a trace
42 *
43 * The trace_handle allows the user to manipulate a trace file directly.
44 * It is a unique identifier representing a trace file.
45 */
46 struct bt_trace_handle;
47 struct bt_ctf_event;
48
49 /*
50 * bt_trace_handle_get_path : returns the path of a trace_handle or NULL
51 * on error.
52 */
53 const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id);
54
55 /*
56 * bt_trace_handle_get_timestamp_begin : returns the creation time (in
57 * nanoseconds or cycles depending on type) of the buffers of a trace
58 * or -1ULL on error.
59 */
60 uint64_t bt_trace_handle_get_timestamp_begin(struct bt_context *ctx,
61 int handle_id, enum bt_clock_type type);
62
63 /*
64 * bt_trace_handle_get_timestamp_end : returns the destruction timestamp
65 * (in nanoseconds or cycles depending on type) of the buffers of a trace
66 * or -1ULL on error.
67 */
68 uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx,
69 int handle_id, enum bt_clock_type type);
70
71 /*
72 * bt_ctf_event_get_handle_id : get the handle id associated with an event
73 *
74 * Returns -1 on error
75 */
76 int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event);
77
78 #ifdef __cplusplus
79 }
80 #endif
81
82 #endif /* _BABELTRACE_TRACE_HANDLE_H */
This page took 0.043438 seconds and 4 git commands to generate.