include/babeltrace/component/component-port.h

   1 #ifndef BABELTRACE_COMPONENT_PORT_H
   2 #define BABELTRACE_COMPONENT_PORT_H
   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>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 struct bt_port;
  37 struct bt_connection;
  38
  39 enum bt_port_status {
  40         BT_PORT_STATUS_OK = 0,
  41         BT_PORT_STATUS_ERROR = -1,
  42         BT_PORT_STATUS_INVALID = -2,
  43 };
  44
  45 enum bt_port_type {
  46         BT_PORT_TYPE_INPUT = 0,
  47         BT_PORT_TYPE_OUTPUT = 1,
  48         BT_PORT_TYPE_UNKOWN = -1,
  49 };
  50
  51 extern const char *BT_DEFAULT_PORT_NAME;
  52
  53 extern const char *bt_port_get_name(struct bt_port *port);
  54 extern enum bt_port_type bt_port_get_type(struct bt_port *port);
  55
  56 extern enum bt_port_status bt_port_get_connection_count(struct bt_port *port,
  57                 uint64_t *count);
  58 extern struct bt_connection *bt_port_get_connection(struct bt_port *port,
  59                 int index);
  60
  61 extern struct bt_component *bt_port_get_component(struct bt_port *port);
  62
  63 /* Only valid before a connection is established. */
  64 extern enum bt_port_status bt_port_get_maximum_connection_count(
  65                 struct bt_port *port, uint64_t *count);
  66 extern enum bt_port_status bt_port_set_maximum_connection_count(
  67                 struct bt_port *port, uint64_t count);
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif /* BABELTRACE_COMPONENT_PORT_H */