Fix: update missing copyrights and ifdef protection mismatch

[babeltrace.git] / include / babeltrace / context.h

diff --git a/include/babeltrace/context.h b/include/babeltrace/context.h
index 99e034805160da3ccfcf6eaab2fea5276f273c0d..4ad1797134e890e82b66e531e165f696f61286b6 100644 (file)
--- a/include/babeltrace/context.h
+++ b/include/babeltrace/context.h
@@ -23,8 +23,12 @@
  * included in all copies or substantial portions of the Software.
  */
 
+#include <unistd.h>
+#include <babeltrace/format.h>
+
 /* struct bt_context is opaque to the user */
 struct bt_context;
+struct stream_pos;
 
 /*
  * bt_context_create : create a Babeltrace context
@@ -39,23 +43,29 @@ struct bt_context *bt_context_create(void);
 /*
  * bt_context_add_trace : Add a trace by path to the context
  *
- * Open a trace
+ * Open a trace.
  *
- * Return: 0 on success, nonzero on failure.
- */
-int bt_context_add_trace(struct bt_context *ctx, const char *path,
-               const char *format);
-
-/*
- * bt_context_add_traces_recursive: Open a trace recursively
+ * packet_seek can be NULL to use the default packet_seek handler
+ * provided by the trace format. If non-NULL, it is used as an override
+ * of the handler for seeks across packets. It takes as parameter a
+ * stream position, the packet index it needs to seek to (for SEEK_SET),
+ * and a "whence" parameter (either SEEK_CUR: seek to next packet, or
+ * SEEK_SET: seek to packet at packet index).
  *
- * Find each trace present in the subdirectory starting from the given
- * path, and add them to the context.
+ * If "path" is NULL, stream_list is used instread as a list of streams
+ * to open for the trace.
+
+ * The metadata parameter acts as a metadata override when not NULL.
  *
- * Return: 0 on success, nonzero on failure.
+ * Return: the trace handle id (>= 0) on success, a negative
+ * value on error.
  */
-int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path,
-               const char *format);
+int bt_context_add_trace(struct bt_context *ctx, const char *path,
+               const char *format,
+               void (*packet_seek)(struct stream_pos *pos,
+                       size_t index, int whence),
+               struct mmap_stream_list *stream_list,
+               FILE *metadata);
 
 /*
  * bt_context_remove_trace: Remove a trace from the context.