projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 8c18d80b PP |
1 | #ifndef BABELTRACE_CTF_WRITER_STREAM_CLASS_H |
| 2 | #define BABELTRACE_CTF_WRITER_STREAM_CLASS_H | |
| 3 | ||
| cf6f1e34 JG |
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 | ||
| adc315b8 | 33 | #include <babeltrace/ctf-ir/stream-class.h> |
| 8c18d80b PP |
34 | |
| 35 | #ifdef __cplusplus | |
| 36 | extern "C" { | |
| 37 | #endif | |
| 38 | ||
| 72bd645e PP |
39 | /* |
| 40 | * bt_ctf_stream_class_set_clock: assign a clock to a stream class. | |
| 41 | * | |
| 42 | * Assign a clock to a stream class. This clock will be sampled each time an | |
| 43 | * event is appended to an instance of this stream class. | |
| 44 | * | |
| 45 | * @param stream_class Stream class. | |
| 46 | * @param clock Clock to assign to the provided stream class. | |
| 47 | * | |
| 48 | * Returns 0 on success, a negative value on error. | |
| 49 | */ | |
| 50 | extern int bt_ctf_stream_class_set_clock( | |
| 51 | struct bt_ctf_stream_class *stream_class, | |
| 52 | struct bt_ctf_clock *clock); | |
| 53 | ||
| ac0c6bdd PP |
54 | extern struct bt_ctf_clock *bt_ctf_stream_class_get_clock( |
| 55 | struct bt_ctf_stream_class *stream_class); | |
| 56 | ||
| 8c18d80b PP |
57 | /* |
| 58 | * bt_ctf_stream_class_get and bt_ctf_stream_class_put: increment and | |
| 59 | * decrement the stream class' reference count. | |
| 60 | * | |
| 61 | * You may also use bt_ctf_get() and bt_ctf_put() with stream class objects. | |
| 62 | * | |
| 63 | * These functions ensure that the stream class won't be destroyed while it | |
| 64 | * is in use. The same number of get and put (plus one extra put to | |
| 65 | * release the initial reference done at creation) have to be done to | |
| 66 | * destroy a stream class. | |
| 67 | * | |
| 68 | * When the stream class' reference count is decremented to 0 by a | |
| 69 | * bt_ctf_stream_class_put, the stream class is freed. | |
| 70 | * | |
| 71 | * @param stream_class Stream class. | |
| 72 | */ | |
| 73 | extern void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class); | |
| 74 | extern void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class); | |
| 75 | ||
| 76 | #ifdef __cplusplus | |
| 77 | } | |
| 78 | #endif | |
| 79 | ||
| 80 | #endif /* BABELTRACE_CTF_WRITER_STREAM_CLASS_H */ |