bindings/python/bt2/bt2/native_bt_stream_class.i

   1 /*
   2  * The MIT License (MIT)
   3  *
   4  * Copyright (c) 2016 Philippe Proulx <pproulx@efficios.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 /* From stream-class-const.h */
  26
  27 typedef enum bt_stream_class_status {
  28         BT_STREAM_CLASS_STATUS_OK = 0,
  29         BT_STREAM_CLASS_STATUS_NOMEM = -12,
  30 } bt_stream_class_status;
  31
  32 extern const bt_trace_class *bt_stream_class_borrow_trace_class_const(
  33                 const bt_stream_class *stream_class);
  34
  35 extern const char *bt_stream_class_get_name(
  36                 const bt_stream_class *stream_class);
  37
  38 extern bt_bool bt_stream_class_assigns_automatic_event_class_id(
  39                 const bt_stream_class *stream_class);
  40
  41 extern bt_bool bt_stream_class_assigns_automatic_stream_id(
  42                 const bt_stream_class *stream_class);
  43
  44 extern bt_bool bt_stream_class_packets_have_default_beginning_clock_snapshot(
  45                 const bt_stream_class *stream_class);
  46
  47 extern bt_bool bt_stream_class_packets_have_default_end_clock_snapshot(
  48                 const bt_stream_class *stream_class);
  49
  50 extern uint64_t bt_stream_class_get_id(
  51                 const bt_stream_class *stream_class);
  52
  53 extern const bt_field_class *
  54 bt_stream_class_borrow_packet_context_field_class_const(
  55                 const bt_stream_class *stream_class);
  56
  57 extern const bt_field_class *
  58 bt_stream_class_borrow_event_common_context_field_class_const(
  59                 const bt_stream_class *stream_class);
  60
  61 extern uint64_t bt_stream_class_get_event_class_count(
  62                 const bt_stream_class *stream_class);
  63
  64 extern const bt_event_class *
  65 bt_stream_class_borrow_event_class_by_index_const(
  66                 const bt_stream_class *stream_class, uint64_t index);
  67
  68 extern const bt_event_class *
  69 bt_stream_class_borrow_event_class_by_id_const(
  70                 const bt_stream_class *stream_class, uint64_t id);
  71
  72 extern const bt_clock_class *
  73 bt_stream_class_borrow_default_clock_class_const(
  74                 const bt_stream_class *stream_class);
  75
  76 extern void bt_stream_class_get_ref(const bt_stream_class *stream_class);
  77
  78 extern void bt_stream_class_put_ref(const bt_stream_class *stream_class);
  79
  80 /* From stream-class-const.h */
  81
  82 extern bt_stream_class *bt_stream_class_create(
  83                 bt_trace_class *trace_class);
  84
  85 extern bt_stream_class *bt_stream_class_create_with_id(
  86                 bt_trace_class *trace_class, uint64_t id);
  87
  88 extern bt_trace_class *bt_stream_class_borrow_trace_class(
  89                 bt_stream_class *stream_class);
  90
  91 extern bt_stream_class_status bt_stream_class_set_name(
  92                 bt_stream_class *stream_class, const char *name);
  93
  94 extern void bt_stream_class_set_assigns_automatic_event_class_id(
  95                 bt_stream_class *stream_class, bt_bool value);
  96
  97 extern void bt_stream_class_set_assigns_automatic_stream_id(
  98                 bt_stream_class *stream_class, bt_bool value);
  99
 100 extern void bt_stream_class_set_packets_have_default_beginning_clock_snapshot(
 101                 bt_stream_class *stream_class, bt_bool value);
 102
 103 extern void bt_stream_class_set_packets_have_default_end_clock_snapshot(
 104                 bt_stream_class *stream_class, bt_bool value);
 105
 106 extern bt_stream_class_status
 107 bt_stream_class_set_packet_context_field_class(
 108                 bt_stream_class *stream_class,
 109                 bt_field_class *field_class);
 110
 111 extern bt_field_class *
 112 bt_stream_class_borrow_packet_context_field_class(
 113                 bt_stream_class *stream_class);
 114
 115 extern bt_stream_class_status
 116 bt_stream_class_set_event_common_context_field_class(
 117                 bt_stream_class *stream_class,
 118                 bt_field_class *field_class);
 119
 120 extern bt_field_class *
 121 bt_stream_class_borrow_event_common_context_field_class(
 122                 bt_stream_class *stream_class);
 123
 124 extern bt_event_class *
 125 bt_stream_class_borrow_event_class_by_index(
 126                 bt_stream_class *stream_class, uint64_t index);
 127
 128 extern bt_event_class *
 129 bt_stream_class_borrow_event_class_by_id(
 130                 bt_stream_class *stream_class, uint64_t id);
 131
 132 extern bt_clock_class *bt_stream_class_borrow_default_clock_class(
 133                 bt_stream_class *stream_class);
 134
 135 extern bt_stream_class_status bt_stream_class_set_default_clock_class(
 136                 bt_stream_class *stream_class,
 137                 bt_clock_class *clock_class);