include/babeltrace/graph/graph.h

   1 #ifndef BABELTRACE_GRAPH_GRAPH_H
   2 #define BABELTRACE_GRAPH_GRAPH_H
   3
   4 /*
   5  * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   6  *
   7  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  */
  27
  28 /* For bt_bool */
  29 #include <babeltrace/types.h>
  30
  31 /* For enum bt_component_status */
  32 #include <babeltrace/graph/component-status.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct bt_graph;
  39
  40 enum bt_graph_status {
  41         BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION = 111,
  42         /** Canceled. */
  43         BT_GRAPH_STATUS_CANCELED = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED,
  44         /** No sink can consume at the moment. */
  45         BT_GRAPH_STATUS_AGAIN = BT_COMPONENT_STATUS_AGAIN,
  46         /** Downstream component does not support multiple inputs. */
  47         BT_GRAPH_STATUS_END = BT_COMPONENT_STATUS_END,
  48         BT_GRAPH_STATUS_OK = BT_COMPONENT_STATUS_OK,
  49         /** Invalid arguments. */
  50         BT_GRAPH_STATUS_INVALID = BT_COMPONENT_STATUS_INVALID,
  51         /** No sink in graph. */
  52         BT_GRAPH_STATUS_NO_SINK = -6,
  53         /** General error. */
  54         BT_GRAPH_STATUS_ERROR = BT_COMPONENT_STATUS_ERROR,
  55         BT_GRAPH_STATUS_NOMEM = BT_COMPONENT_STATUS_NOMEM,
  56 };
  57
  58 extern bt_bool bt_graph_is_canceled(struct bt_graph *graph);
  59
  60 #ifdef __cplusplus
  61 }
  62 #endif
  63
  64 #endif /* BABELTRACE_GRAPH_GRAPH_H */