include/babeltrace/trace-ir/stream-class.h

   1 #ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_H
   2 #define BABELTRACE_TRACE_IR_STREAM_CLASS_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  *
  26  * The Common Trace Format (CTF) Specification is available at
  27  * http://www.efficios.com/ctf
  28  */
  29
  30 #include <stdint.h>
  31
  32 /*
  33  * For bt_bool, bt_trace_class, bt_stream_class, bt_event_class,
  34  * bt_clock_class
  35  */
  36 #include <babeltrace/types.h>
  37
  38 /* For bt_stream_class_status */
  39 #include <babeltrace/trace-ir/stream-class-const.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 extern bt_stream_class *bt_stream_class_create(
  46                 bt_trace_class *trace_class);
  47
  48 extern bt_stream_class *bt_stream_class_create_with_id(
  49                 bt_trace_class *trace_class, uint64_t id);
  50
  51 extern bt_trace_class *bt_stream_class_borrow_trace_class(
  52                 bt_stream_class *stream_class);
  53
  54 extern bt_stream_class_status bt_stream_class_set_name(
  55                 bt_stream_class *stream_class, const char *name);
  56
  57 extern void bt_stream_class_set_assigns_automatic_event_class_id(
  58                 bt_stream_class *stream_class, bt_bool value);
  59
  60 extern void bt_stream_class_set_assigns_automatic_stream_id(
  61                 bt_stream_class *stream_class, bt_bool value);
  62
  63 extern void bt_stream_class_set_packets_have_default_beginning_clock_snapshot(
  64                 bt_stream_class *stream_class, bt_bool value);
  65
  66 extern void bt_stream_class_set_packets_have_default_end_clock_snapshot(
  67                 bt_stream_class *stream_class, bt_bool value);
  68
  69 extern bt_stream_class_status
  70 bt_stream_class_set_packet_context_field_class(
  71                 bt_stream_class *stream_class,
  72                 bt_field_class *field_class);
  73
  74 extern bt_field_class *
  75 bt_stream_class_borrow_packet_context_field_class(
  76                 bt_stream_class *stream_class);
  77
  78 extern bt_stream_class_status
  79 bt_stream_class_set_event_common_context_field_class(
  80                 bt_stream_class *stream_class,
  81                 bt_field_class *field_class);
  82
  83 extern bt_field_class *
  84 bt_stream_class_borrow_event_common_context_field_class(
  85                 bt_stream_class *stream_class);
  86
  87 extern bt_event_class *
  88 bt_stream_class_borrow_event_class_by_index(
  89                 bt_stream_class *stream_class, uint64_t index);
  90
  91 extern bt_event_class *
  92 bt_stream_class_borrow_event_class_by_id(
  93                 bt_stream_class *stream_class, uint64_t id);
  94
  95 extern bt_clock_class *bt_stream_class_borrow_default_clock_class(
  96                 bt_stream_class *stream_class);
  97
  98 extern bt_stream_class_status bt_stream_class_set_default_clock_class(
  99                 bt_stream_class *stream_class,
 100                 bt_clock_class *clock_class);
 101
 102 #ifdef __cplusplus
 103 }
 104 #endif
 105
 106 #endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_H */