port.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_GRAPH_PORT_H
#define BABELTRACE2_GRAPH_PORT_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
 
typedef enum bt_port_type {
    BT_PORT_TYPE_INPUT  = 1 << 0,
 
    BT_PORT_TYPE_OUTPUT = 1 << 1,
} bt_port_type;
 
extern bt_port_type bt_port_get_type(const bt_port *port) __BT_NOEXCEPT;
 
static inline
bt_bool bt_port_is_input(const bt_port *port) __BT_NOEXCEPT
{
    return bt_port_get_type(port) == BT_PORT_TYPE_INPUT;
}
 
static inline
bt_bool bt_port_is_output(const bt_port *port) __BT_NOEXCEPT
{
    return bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT;
}
 
extern const bt_connection *bt_port_borrow_connection_const(
        const bt_port *port) __BT_NOEXCEPT;
 
extern const bt_component *bt_port_borrow_component_const(
        const bt_port *port) __BT_NOEXCEPT;
 
extern const char *bt_port_get_name(const bt_port *port) __BT_NOEXCEPT;
 
extern bt_bool bt_port_is_connected(const bt_port *port) __BT_NOEXCEPT;
 
extern void bt_port_get_ref(const bt_port *port) __BT_NOEXCEPT;
 
extern void bt_port_put_ref(const bt_port *port) __BT_NOEXCEPT;
 
#define BT_PORT_PUT_REF_AND_RESET(_port)    \
    do {                    \
        bt_port_put_ref(_port);     \
        (_port) = NULL;         \
    } while (0)
 
#define BT_PORT_MOVE_REF(_dst, _src)    \
    do {                \
        bt_port_put_ref(_dst);  \
        (_dst) = (_src);    \
        (_src) = NULL;      \
    } while (0)
 
static inline
const bt_port *bt_port_input_as_port_const(
        const bt_port_input *port) __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_port, port);
}
 
extern void bt_port_input_get_ref(const bt_port_input *port) __BT_NOEXCEPT;
 
extern void bt_port_input_put_ref(const bt_port_input *port) __BT_NOEXCEPT;
 
#define BT_PORT_INPUT_PUT_REF_AND_RESET(_port)      \
    do {                        \
        bt_port_input_put_ref(_port);       \
        (_port) = NULL;             \
    } while (0)
 
#define BT_PORT_INPUT_MOVE_REF(_dst, _src)  \
    do {                    \
        bt_port_input_put_ref(_dst);    \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
static inline
const bt_port *bt_port_output_as_port_const(
        const bt_port_output *port) __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_port, port);
}
 
extern void bt_port_output_get_ref(const bt_port_output *port) __BT_NOEXCEPT;
 
extern void bt_port_output_put_ref(const bt_port_output *port) __BT_NOEXCEPT;
 
#define BT_PORT_OUTPUT_PUT_REF_AND_RESET(_port)     \
    do {                        \
        bt_port_output_put_ref(_port);      \
        (_port) = NULL;             \
    } while (0)
 
#define BT_PORT_OUTPUT_MOVE_REF(_dst, _src) \
    do {                    \
        bt_port_output_put_ref(_dst);   \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_GRAPH_PORT_H */