lib: make discarded events/packets support and clock snapshots optional

[babeltrace.git] / include / babeltrace / trace-ir / stream-class.h

diff --git a/include/babeltrace/trace-ir/stream-class.h b/include/babeltrace/trace-ir/stream-class.h
index 6764147703ee7176c111d05e86367f0ecb487e7c..c7e1fb7f150c181cc6eab145fb9bd364f27162df 100644 (file)
--- a/include/babeltrace/trace-ir/stream-class.h
+++ b/include/babeltrace/trace-ir/stream-class.h
@@ -2,10 +2,9 @@
 #define BABELTRACE_TRACE_IR_STREAM_CLASS_H
 
 /*
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
@@ -30,79 +29,85 @@
 
 #include <stdint.h>
 
-/* For bt_bool */
+/*
+ * For bt_bool, bt_trace_class, bt_stream_class, bt_event_class,
+ * bt_clock_class
+ */
 #include <babeltrace/types.h>
 
+/* For bt_stream_class_status */
+#include <babeltrace/trace-ir/stream-class-const.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-struct bt_trace_class;
-struct bt_stream_class;
-struct bt_event_class;
-struct bt_clock_class;
-
-extern struct bt_stream_class *bt_stream_class_create(
-               struct bt_trace_class *trace_class);
+extern bt_stream_class *bt_stream_class_create(
+               bt_trace_class *trace_class);
 
-extern struct bt_stream_class *bt_stream_class_create_with_id(
-               struct bt_trace_class *trace_class, uint64_t id);
+extern bt_stream_class *bt_stream_class_create_with_id(
+               bt_trace_class *trace_class, uint64_t id);
 
-extern struct bt_trace_class *bt_stream_class_borrow_trace_class(
-               struct bt_stream_class *stream_class);
+extern bt_trace_class *bt_stream_class_borrow_trace_class(
+               bt_stream_class *stream_class);
 
-extern int bt_stream_class_set_name(struct bt_stream_class *stream_class,
-               const char *name);
+extern bt_stream_class_status bt_stream_class_set_name(
+               bt_stream_class *stream_class, const char *name);
 
 extern void bt_stream_class_set_assigns_automatic_event_class_id(
-               struct bt_stream_class *stream_class, bt_bool value);
+               bt_stream_class *stream_class, bt_bool value);
 
 extern void bt_stream_class_set_assigns_automatic_stream_id(
-               struct bt_stream_class *stream_class, bt_bool value);
+               bt_stream_class *stream_class, bt_bool value);
 
-extern int bt_stream_class_set_packet_context_field_class(
-               struct bt_stream_class *stream_class,
-               struct bt_field_class *field_class);
+extern void bt_stream_class_set_packets_have_default_beginning_clock_snapshot(
+               bt_stream_class *stream_class, bt_bool value);
 
-extern int bt_stream_class_set_event_header_field_class(
-               struct bt_stream_class *stream_class,
-               struct bt_field_class *field_class);
+extern void bt_stream_class_set_packets_have_default_end_clock_snapshot(
+               bt_stream_class *stream_class, bt_bool value);
 
-extern int
-bt_stream_class_set_event_common_context_field_class(
-               struct bt_stream_class *stream_class,
-               struct bt_field_class *field_class);
+extern void bt_stream_class_set_supports_discarded_events(
+               bt_stream_class *stream_class,
+               bt_bool supports_discarded_events,
+               bt_bool with_default_clock_snapshots);
 
-extern struct bt_event_class *
-bt_stream_class_borrow_event_class_by_index(
-               struct bt_stream_class *stream_class, uint64_t index);
+extern void bt_stream_class_set_supports_discarded_packets(
+               bt_stream_class *stream_class,
+               bt_bool supports_discarded_packets,
+               bt_bool with_default_clock_snapshots);
 
-extern struct bt_event_class *
-bt_stream_class_borrow_event_class_by_id(
-               struct bt_stream_class *stream_class, uint64_t id);
+extern bt_stream_class_status
+bt_stream_class_set_packet_context_field_class(
+               bt_stream_class *stream_class,
+               bt_field_class *field_class);
+
+extern bt_field_class *
+bt_stream_class_borrow_packet_context_field_class(
+               bt_stream_class *stream_class);
 
-extern struct bt_clock_class *bt_stream_class_borrow_default_clock_class(
-               struct bt_stream_class *stream_class);
+extern bt_stream_class_status
+bt_stream_class_set_event_common_context_field_class(
+               bt_stream_class *stream_class,
+               bt_field_class *field_class);
 
-extern int bt_stream_class_set_default_clock_class(
-               struct bt_stream_class *stream_class,
-               struct bt_clock_class *clock_class);
+extern bt_field_class *
+bt_stream_class_borrow_event_common_context_field_class(
+               bt_stream_class *stream_class);
 
-extern void
-bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
-               struct bt_stream_class *stream_class, bt_bool value);
+extern bt_event_class *
+bt_stream_class_borrow_event_class_by_index(
+               bt_stream_class *stream_class, uint64_t index);
 
-extern void
-bt_stream_class_set_packets_have_packet_counter_snapshot(
-               struct bt_stream_class *stream_class, bt_bool value);
+extern bt_event_class *
+bt_stream_class_borrow_event_class_by_id(
+               bt_stream_class *stream_class, uint64_t id);
 
-extern void
-bt_stream_class_set_packets_have_default_beginning_clock_value(
-               struct bt_stream_class *stream_class, bt_bool value);
+extern bt_clock_class *bt_stream_class_borrow_default_clock_class(
+               bt_stream_class *stream_class);
 
-extern void
-bt_stream_class_set_packets_have_default_end_clock_value(
-               struct bt_stream_class *stream_class, bt_bool value);
+extern bt_stream_class_status bt_stream_class_set_default_clock_class(
+               bt_stream_class *stream_class,
+               bt_clock_class *clock_class);
 
 #ifdef __cplusplus
 }