Print timestamps in text plug-in

[babeltrace.git] / include / babeltrace / ctf-ir / event.h

diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h
index 4b061d62f4eebb214a95c1f8c30befacee6f47c3..63926ba8c54849b8eab8aafb90b5cb5d8510bfcc 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -38,11 +38,14 @@
 extern "C" {
 #endif
 
+struct bt_ctf_clock;
+struct bt_ctf_clock_value;
 struct bt_ctf_event_class;
 struct bt_ctf_event;
 struct bt_ctf_field;
 struct bt_ctf_field_type;
 struct bt_ctf_stream_class;
+struct bt_ctf_packet;
 
 /*
  * bt_ctf_event_create: instanciate an event.
@@ -81,16 +84,6 @@ extern struct bt_ctf_event_class *bt_ctf_event_get_class(
 extern struct bt_ctf_stream *bt_ctf_event_get_stream(
                struct bt_ctf_event *event);
 
-/*
- * bt_ctf_event_get_clock: get an event's associated clock.
- *
- * @param event Event.
- *
- * Returns the event's clock, NULL on error.
- */
-extern struct bt_ctf_clock *bt_ctf_event_get_clock(
-               struct bt_ctf_event *event);
-
 /*
  * bt_ctf_event_get_payload_field: get an event's payload.
  *
@@ -115,7 +108,7 @@ extern int bt_ctf_event_set_payload_field(struct bt_ctf_event *event,
 /*
  * bt_ctf_event_get_payload: get an event's field.
  *
- * Returns the field matching "name". bt_ctf_field_put() must be called on the
+ * Returns the field matching "name". bt_put() must be called on the
  * returned value.
  *
  * @param event Event instance.
@@ -135,7 +128,7 @@ extern struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event,
  *
  * Set a manually allocated field as an event's payload. The event will share
  * the field's ownership by using its reference count.
- * bt_ctf_field_put() must be called on the returned value.
+ * bt_put() must be called on the returned value.
  *
  * @param event Event instance.
  * @param name Event field name, see notes.
@@ -154,7 +147,7 @@ extern int bt_ctf_event_set_payload(struct bt_ctf_event *event,
 /*
  * bt_ctf_event_get_payload_by_index: Get event's field by index.
  *
- * Returns the field associated with the provided index. bt_ctf_field_put()
+ * Returns the field associated with the provided index. bt_put()
  * must be called on the returned value. The indexes to be provided are
  * the same as can be retrieved from the event class.
  *
@@ -220,36 +213,39 @@ extern int bt_ctf_event_set_event_context(struct bt_ctf_event *event,
                struct bt_ctf_field *context);
 
 /*
- * bt_ctf_event_copy: Deep-copy an event.
- *
- * Get an event's deep copy.
- *
- * On success, the returned copy has its reference count set to 1.
+ * bt_ctf_event_get_stream_event_context: Get an event's stream event context
  *
- * @param event Event to copy.
+ * @param event_class Event class.
  *
- * Returns the deep-copied event on success, NULL on error.
+ * Returns a field on success (a structure), NULL on error.
  */
-extern struct bt_ctf_event *bt_ctf_event_copy(struct bt_ctf_event *event);
+extern struct bt_ctf_field *bt_ctf_event_get_stream_event_context(
+               struct bt_ctf_event *event);
 
 /*
- * bt_ctf_event_get and bt_ctf_event_put: increment and decrement
- * the event's reference count.
+ * bt_ctf_event_set_stream_event_context: Set an event's stream event context
  *
- * You may also use bt_ctf_get() and bt_ctf_put() with event objects.
- *
- * These functions ensure that the event won't be destroyed while it
- * is in use. The same number of get and put (plus one extra put to
- * release the initial reference done at creation) have to be done to
- * destroy an event.
- *
- * When the event's reference count is decremented to 0 by a
- * bt_ctf_event_put, the event is freed.
+ * @param event Event.
+ * @param context Event stream context field (must match the stream class'
+ *     stream event context type).
  *
- * @param event Event instance.
+ * Returns 0 on success, a negative value on error.
  */
-extern void bt_ctf_event_get(struct bt_ctf_event *event);
-extern void bt_ctf_event_put(struct bt_ctf_event *event);
+extern int bt_ctf_event_set_stream_event_context(struct bt_ctf_event *event,
+               struct bt_ctf_field *context);
+
+extern struct bt_ctf_packet *bt_ctf_event_get_packet(
+               struct bt_ctf_event *event);
+
+extern int bt_ctf_event_set_packet(struct bt_ctf_event *event,
+               struct bt_ctf_packet *packet);
+
+extern struct bt_ctf_clock_value *bt_ctf_event_get_clock_value(
+               struct bt_ctf_event *event, struct bt_ctf_clock *clock);
+
+extern int bt_ctf_event_set_clock_value(
+               struct bt_ctf_event *event, struct bt_ctf_clock *clock,
+               struct bt_ctf_clock_value *value);
 
 #ifdef __cplusplus
 }