Fix comment in context.h

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

diff --git a/include/babeltrace/context.h b/include/babeltrace/context.h
index 4ad1797134e890e82b66e531e165f696f61286b6..f29ccf083f034c5e73a36132b42103668a3dfa19 100644 (file)
--- a/include/babeltrace/context.h
+++ b/include/babeltrace/context.h
@@ -21,14 +21,27 @@
  *
  * The above copyright notice and this permission notice shall be
  * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
 #include <unistd.h>
 #include <babeltrace/format.h>
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /* struct bt_context is opaque to the user */
 struct bt_context;
 struct stream_pos;
+struct bt_ctf_event;
 
 /*
  * bt_context_create : create a Babeltrace context
@@ -45,17 +58,24 @@ struct bt_context *bt_context_create(void);
  *
  * 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).
+ * path is the path to the trace, it is not recursive. If "path" is NULL,
+ * stream_list is used instead as a list of mmap streams to open for the trace.
  *
- * 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.
+ * format is a string containing the format name in which the trace was
+ * produced.
+ *
+ * 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).
+ *
+ * stream_list is a linked list of streams, it is used to open a trace where
+ * the trace data is located in memory mapped areas instead of trace files,
+ * this argument should be non-NULL when path is NULL.
+ *
+ * The metadata parameter acts as a metadata override when not NULL, otherwise
+ * the format handles the metadata opening.
  *
  * Return: the trace handle id (>= 0) on success, a negative
  * value on error.
@@ -70,9 +90,10 @@ int bt_context_add_trace(struct bt_context *ctx, const char *path,
 /*
  * bt_context_remove_trace: Remove a trace from the context.
  *
- * Effectively closing the trace.
+ * Effectively closing the trace. Return negative error value if trace
+ * is not in context.
  */
-void bt_context_remove_trace(struct bt_context *ctx, int trace_id);
+int bt_context_remove_trace(struct bt_context *ctx, int trace_id);
 
 /*
  * bt_context_get and bt_context_put : increments and decrement the
@@ -89,4 +110,15 @@ void bt_context_remove_trace(struct bt_context *ctx, int trace_id);
 void bt_context_get(struct bt_context *ctx);
 void bt_context_put(struct bt_context *ctx);
 
+/*
+ * bt_ctf_get_context : get the context associated with an event
+ *
+ * Returns NULL on error
+ */
+struct bt_context *bt_ctf_event_get_context(const struct bt_ctf_event *event);
+
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* _BABELTRACE_CONTEXT_H */