API : trace_handle

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

diff --git a/include/babeltrace/trace-handle.h b/include/babeltrace/trace-handle.h
new file mode 100644 (file)
index 0000000..5900cc1
--- /dev/null
+++ b/include/babeltrace/trace-handle.h
@@ -0,0 +1,53 @@
+#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 */