stream.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_TRACE_IR_STREAM_H
#define BABELTRACE2_TRACE_IR_STREAM_H
 
/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#include <stdint.h>
 
#include <babeltrace2/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern bt_stream *bt_stream_create(bt_stream_class *stream_class,
        bt_trace *trace) __BT_NOEXCEPT;
 
extern bt_stream *bt_stream_create_with_id(
        bt_stream_class *stream_class,
        bt_trace *trace, uint64_t id) __BT_NOEXCEPT;
 
extern bt_stream_class *bt_stream_borrow_class(bt_stream *stream) __BT_NOEXCEPT;
 
extern const bt_stream_class *bt_stream_borrow_class_const(
        const bt_stream *stream) __BT_NOEXCEPT;
 
extern bt_trace *bt_stream_borrow_trace(bt_stream *stream) __BT_NOEXCEPT;
 
extern const bt_trace *bt_stream_borrow_trace_const(
        const bt_stream *stream) __BT_NOEXCEPT;
 
extern uint64_t bt_stream_get_id(const bt_stream *stream) __BT_NOEXCEPT;
 
typedef enum bt_stream_set_name_status {
    BT_STREAM_SET_NAME_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_STREAM_SET_NAME_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_stream_set_name_status;
 
extern bt_stream_set_name_status bt_stream_set_name(bt_stream *stream,
        const char *name) __BT_NOEXCEPT;
 
extern const char *bt_stream_get_name(const bt_stream *stream) __BT_NOEXCEPT;
 
extern void bt_stream_set_user_attributes(
        bt_stream *stream, const bt_value *user_attributes)
        __BT_NOEXCEPT;
 
extern bt_value *bt_stream_borrow_user_attributes(bt_stream *stream)
        __BT_NOEXCEPT;
 
extern const bt_value *bt_stream_borrow_user_attributes_const(
        const bt_stream *stream) __BT_NOEXCEPT;
 
extern void bt_stream_get_ref(const bt_stream *stream) __BT_NOEXCEPT;
 
extern void bt_stream_put_ref(const bt_stream *stream) __BT_NOEXCEPT;
 
#define BT_STREAM_PUT_REF_AND_RESET(_stream)        \
    do {                        \
        bt_stream_put_ref(_stream);     \
        (_stream) = NULL;           \
    } while (0)
 
#define BT_STREAM_MOVE_REF(_dst, _src)      \
    do {                    \
        bt_stream_put_ref(_dst);    \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_TRACE_IR_STREAM_H */