/*
* BabelTrace - CTF Writer: Writer
*
- * Copyright 2013 EfficiOS Inc.
+ * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
*/
#include <babeltrace/ctf-ir/event-types.h>
+#include <babeltrace/ctf-ir/trace.h>
#ifdef __cplusplus
extern "C" {
*/
extern struct bt_ctf_writer *bt_ctf_writer_create(const char *path);
+/*
+ * bt_ctf_writer_get_trace: Get a writer's associated trace.
+ *
+ * @param writer Writer instance.
+ *
+ * Return the writer's associated instance, NULL on error.
+ */
+extern struct bt_ctf_trace *bt_ctf_writer_get_trace(
+ struct bt_ctf_writer *writer);
+
/*
* bt_ctf_writer_create_stream: create a stream instance.
*
* @param writer Writer instance.
* @param stream_class Stream class to instantiate.
*
- * Returns an allocated writer on success, NULL on error.
+ * Returns an allocated stream on success, NULL on error.
*/
extern struct bt_ctf_stream *bt_ctf_writer_create_stream(
struct bt_ctf_writer *writer,
/*
* bt_ctf_writer_set_byte_order: set a field type's byte order.
*
- * Set the trace's byte order. Defaults to BT_CTF_BYTE_ORDER_NATIVE,
- * the host machine's endianness.
+ * Set the trace's byte order. Defaults to the host machine's endianness.
*
* @param writer Writer instance.
* @param byte_order Trace's byte order.
*
* Returns 0 on success, a negative value on error.
+ *
+ * Note: byte_order must not be BT_CTF_BYTE_ORDER_NATIVE since, according
+ * to the CTF specification, is defined as "the byte order described in the
+ * trace description".
*/
extern int bt_ctf_writer_set_byte_order(struct bt_ctf_writer *writer,
enum bt_ctf_byte_order byte_order);