include/babeltrace/ctf-writer/stream-class.h

   1 #ifndef BABELTRACE_CTF_WRITER_STREAM_CLASS_H
   2 #define BABELTRACE_CTF_WRITER_STREAM_CLASS_H
   3
   4 /*
   5  * Copyright 2014 EfficiOS Inc.
   6  *
   7  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  *
  27  * The Common Trace Format (CTF) Specification is available at
  28  * http://www.efficios.com/ctf
  29  */
  30
  31 #include <babeltrace/ctf-writer/object.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct bt_ctf_stream_class;
  38 struct bt_ctf_trace;
  39 struct bt_ctf_event_class;
  40 struct bt_ctf_field_type;
  41 struct bt_ctf_clock;
  42
  43 extern struct bt_ctf_stream_class *bt_ctf_stream_class_create(
  44                 const char *name);
  45
  46 extern struct bt_ctf_trace *bt_ctf_stream_class_get_trace(
  47                 struct bt_ctf_stream_class *stream_class);
  48
  49 extern const char *bt_ctf_stream_class_get_name(
  50                 struct bt_ctf_stream_class *stream_class);
  51
  52 extern int bt_ctf_stream_class_set_name(
  53                 struct bt_ctf_stream_class *stream_class, const char *name);
  54
  55 extern int64_t bt_ctf_stream_class_get_id(
  56                 struct bt_ctf_stream_class *stream_class);
  57
  58 extern int bt_ctf_stream_class_set_id(
  59                 struct bt_ctf_stream_class *stream_class, uint64_t id);
  60
  61 extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
  62                 struct bt_ctf_stream_class *stream_class);
  63
  64 extern int bt_ctf_stream_class_set_packet_context_type(
  65                 struct bt_ctf_stream_class *stream_class,
  66                 struct bt_ctf_field_type *packet_context_type);
  67
  68 extern struct bt_ctf_field_type *
  69 bt_ctf_stream_class_get_event_header_type(
  70                 struct bt_ctf_stream_class *stream_class);
  71
  72 extern int bt_ctf_stream_class_set_event_header_type(
  73                 struct bt_ctf_stream_class *stream_class,
  74                 struct bt_ctf_field_type *event_header_type);
  75
  76 extern struct bt_ctf_field_type *
  77 bt_ctf_stream_class_get_event_context_type(
  78                 struct bt_ctf_stream_class *stream_class);
  79
  80 extern int bt_ctf_stream_class_set_event_context_type(
  81                 struct bt_ctf_stream_class *stream_class,
  82                 struct bt_ctf_field_type *event_context_type);
  83
  84 extern int64_t bt_ctf_stream_class_get_event_class_count(
  85                 struct bt_ctf_stream_class *stream_class);
  86
  87 extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_index(
  88                 struct bt_ctf_stream_class *stream_class, uint64_t index);
  89
  90 extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_id(
  91                 struct bt_ctf_stream_class *stream_class, uint64_t id);
  92
  93 extern int bt_ctf_stream_class_add_event_class(
  94                 struct bt_ctf_stream_class *stream_class,
  95                 struct bt_ctf_event_class *event_class);
  96
  97 extern int bt_ctf_stream_class_set_clock(
  98                 struct bt_ctf_stream_class *ctf_stream_class,
  99                 struct bt_ctf_clock *clock);
 100
 101 extern struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
 102         struct bt_ctf_stream_class *stream_class);
 103
 104 /* Pre-2.0 CTF writer compatibility */
 105 static inline
 106 void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class)
 107 {
 108         bt_ctf_object_get_ref(stream_class);
 109 }
 110
 111 /* Pre-2.0 CTF writer compatibility */
 112 static inline
 113 void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class)
 114 {
 115         bt_ctf_object_put_ref(stream_class);
 116 }
 117
 118 #ifdef __cplusplus
 119 }
 120 #endif
 121
 122 #endif /* BABELTRACE_CTF_WRITER_STREAM_CLASS_H */