lib: strictly type function return status enumerations
[babeltrace.git] / include / babeltrace2 / trace-ir / stream.h
CommitLineData
56e18c4c
PP
1#ifndef BABELTRACE_TRACE_IR_STREAM_H
2#define BABELTRACE_TRACE_IR_STREAM_H
c057dea0
PP
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
c057dea0 6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
c057dea0 7 *
c057dea0
PP
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
d24d5663
PP
30#include <stdint.h>
31
b19ff26f 32/* For bt_trace, bt_stream, bt_stream_class */
3fadfbc0 33#include <babeltrace2/types.h>
b19ff26f 34
d24d5663
PP
35/* For __BT_FUNC_STATUS_* */
36#define __BT_FUNC_STATUS_ENABLE
37#include <babeltrace2/func-status.h>
38#undef __BT_FUNC_STATUS_ENABLE
c057dea0
PP
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
b19ff26f
PP
44extern bt_stream *bt_stream_create(bt_stream_class *stream_class,
45 bt_trace *trace);
40f4ba76 46
b19ff26f
PP
47extern bt_stream *bt_stream_create_with_id(
48 bt_stream_class *stream_class,
49 bt_trace *trace, uint64_t id);
862ca4ed 50
b19ff26f 51extern bt_trace *bt_stream_borrow_trace(bt_stream *stream);
44c440bc 52
b19ff26f 53extern bt_stream_class *bt_stream_borrow_class(bt_stream *stream);
094ff7c0 54
d24d5663
PP
55typedef enum bt_stream_set_name_status {
56 BT_STREAM_SET_NAME_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
57 BT_STREAM_SET_NAME_STATUS_OK = __BT_FUNC_STATUS_OK,
58} bt_stream_set_name_status;
59
60extern bt_stream_set_name_status bt_stream_set_name(bt_stream *stream,
3dcff82b 61 const char *name);
c057dea0
PP
62
63#ifdef __cplusplus
64}
65#endif
66
d24d5663
PP
67#include <babeltrace2/undef-func-status.h>
68
56e18c4c 69#endif /* BABELTRACE_TRACE_IR_STREAM_H */
This page took 0.059204 seconds and 4 git commands to generate.