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 6190d37bdbf643518a6c2bba432e643ae560023d..4ad1797134e890e82b66e531e165f696f61286b6 100644 (file)
--- a/include/babeltrace/context.h
+++ b/include/babeltrace/context.h
@@ -24,6 +24,7 @@
  */
 
 #include <unistd.h>
+#include <babeltrace/format.h>
 
 /* struct bt_context is opaque to the user */
 struct bt_context;
@@ -42,8 +43,19 @@ struct bt_context *bt_context_create(void);
 /*
  * bt_context_add_trace : Add a trace by path to the context
  *
- * Open a trace. Parameter packet_seek can be NULL to use the default
- * packet_seek handle of the format.
+ * Open a trace.
+ *
+ * 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).
+ *
+ * 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: the trace handle id (>= 0) on success, a negative
  * value on error.
@@ -51,7 +63,9 @@ struct bt_context *bt_context_create(void);
 int bt_context_add_trace(struct bt_context *ctx, const char *path,
                const char *format,
                void (*packet_seek)(struct stream_pos *pos,
-                       size_t offset, int whence));
+                       size_t index, int whence),
+               struct mmap_stream_list *stream_list,
+               FILE *metadata);
 
 /*
  * bt_context_remove_trace: Remove a trace from the context.