lib: graph: add "self" and some "private" APIs

[babeltrace.git] / include / babeltrace / graph / self-component-port.h

diff --git a/include/babeltrace/graph/self-component-port.h b/include/babeltrace/graph/self-component-port.h
new file mode 100644 (file)
index 0000000..753cba5
--- /dev/null
+++ b/include/babeltrace/graph/self-component-port.h
@@ -0,0 +1,61 @@
+#ifndef BABELTRACE_GRAPH_SELF_COMPONENT_PORT_H
+#define BABELTRACE_GRAPH_SELF_COMPONENT_PORT_H
+
+/*
+ * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct bt_port;
+struct bt_self_component_port;
+struct bt_self_component;
+struct bt_connection;
+
+enum bt_self_component_port_status {
+       BT_SELF_PORT_STATUS_OK = 0,
+       BT_SELF_PORT_STATUS_ERROR = -1,
+};
+
+static inline
+struct bt_port *bt_self_component_port_borrow_port(
+               struct bt_self_component_port *self_port)
+{
+       return (void *) self_port;
+}
+
+extern struct bt_self_component *bt_self_component_port_borrow_component(
+               struct bt_self_component_port *self_port);
+
+extern enum bt_self_component_port_status
+bt_self_component_port_remove_from_component(
+               struct bt_self_component_port *self_port);
+
+extern void *bt_self_component_port_get_data(
+               struct bt_self_component_port *self_port);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* BABELTRACE_GRAPH_SELF_COMPONENT_PORT_H */