[babeltrace.git] / include / babeltrace / trace-handle.h

#ifndef _BABELTRACE_TRACE_HANDLE_H
#define _BABELTRACE_TRACE_HANDLE_H

/*
 * BabelTrace
 *
 * trace_handle header
 *
 * Copyright 2012 EfficiOS Inc. and Linux Foundation
 *
 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *         Julien Desfossez <julien.desfossez@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 */

#include <stdint.h>

/*
 * trace_handle : unique identifier of a trace
 *
 * The trace_handle allows the user to manipulate a trace file directly.
 * It is a unique identifier representing a trace file.
 */
struct bt_trace_handle;

/*
 * bt_trace_handle_get_path : returns the path of a trace_handle or
 * NULL on error
 */
char *bt_trace_handle_get_path(struct bt_trace_handle *th);

/*
 * bt_trace_handle_get_timestamp_begin : returns the beginning timestamp
 * of a trace or -1ULL on error
 */
uint64_t bt_trace_handle_get_timestamp_begin(struct bt_trace_handle *th);

/*
 * bt_trace_handle_get_timestamp_end : returns the end timestamp of a trace
 * or -1ULL on error
 */
uint64_t bt_trace_handle_get_timestamp_end(struct bt_trace_handle *th);

#endif /* _BABELTRACE_TRACE_HANDLE_H */
Commit	Line	Data
	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	*/
	33	struct bt_trace_handle;
	34
	35	/*
	36	* bt_trace_handle_get_path : returns the path of a trace_handle or
	37	* NULL on error
	38	*/
	39	char bt_trace_handle_get_path(struct bt_trace_handle th);
	40
	41	/*
	42	* bt_trace_handle_get_timestamp_begin : returns the beginning timestamp
	43	* of a trace or -1ULL on error
	44	*/
	45	uint64_t bt_trace_handle_get_timestamp_begin(struct bt_trace_handle *th);
	46
	47	/*
	48	* bt_trace_handle_get_timestamp_end : returns the end timestamp of a trace
	49	* or -1ULL on error
	50	*/
	51	uint64_t bt_trace_handle_get_timestamp_end(struct bt_trace_handle *th);
	52
	53	#endif /* _BABELTRACE_TRACE_HANDLE_H */