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