Do not use `bool` type; use new `bt_bool` instead
[babeltrace.git] / include / babeltrace / graph / port.h
CommitLineData
1ca80abd
PP
1#ifndef BABELTRACE_GRAPH_PORT_H
2#define BABELTRACE_GRAPH_PORT_H
8b285017
JG
3
4/*
5 * BabelTrace - Babeltrace Component Connection Interface
6 *
7 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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
30#include <stdint.h>
c55a9f58 31#include <babeltrace/types.h>
8b285017
JG
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37struct bt_port;
38struct bt_connection;
39
40enum bt_port_status {
41 BT_PORT_STATUS_OK = 0,
42 BT_PORT_STATUS_ERROR = -1,
43 BT_PORT_STATUS_INVALID = -2,
44};
45
46enum bt_port_type {
47 BT_PORT_TYPE_INPUT = 0,
48 BT_PORT_TYPE_OUTPUT = 1,
49 BT_PORT_TYPE_UNKOWN = -1,
50};
51
8b285017
JG
52extern const char *bt_port_get_name(struct bt_port *port);
53extern enum bt_port_type bt_port_get_type(struct bt_port *port);
72b913fb 54extern struct bt_connection *bt_port_get_connection(struct bt_port *port);
8b285017 55extern struct bt_component *bt_port_get_component(struct bt_port *port);
72b913fb
PP
56extern int bt_port_remove_from_component(struct bt_port *port);
57extern int bt_port_disconnect(struct bt_port *port);
58extern int bt_port_is_connected(struct bt_port *port);
8b285017 59
e3655084 60static inline
c55a9f58 61bt_bool bt_port_is_input(struct bt_port *port)
e3655084
PP
62{
63 return bt_port_get_type(port) == BT_PORT_TYPE_INPUT;
64}
65
66static inline
c55a9f58 67bt_bool bt_port_is_output(struct bt_port *port)
e3655084
PP
68{
69 return bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT;
70}
71
8b285017
JG
72#ifdef __cplusplus
73}
74#endif
75
1ca80abd 76#endif /* BABELTRACE_GRAPH_PORT_H */
This page took 0.028039 seconds and 4 git commands to generate.