Graph API: split into private and public APIs
[babeltrace.git] / include / babeltrace / graph / graph.h
CommitLineData
1ca80abd
PP
1#ifndef BABELTRACE_GRAPH_GRAPH_H
2#define BABELTRACE_GRAPH_GRAPH_H
c0418dd9
JG
3
4/*
f60c8b34 5 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
c0418dd9
JG
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
9d408fca 28/* For bt_bool */
202a3a13 29#include <babeltrace/types.h>
c0418dd9 30
ad847455
PP
31/* For enum bt_component_status */
32#include <babeltrace/graph/component-status.h>
33
c0418dd9
JG
34#ifdef __cplusplus
35extern "C" {
36#endif
37
a2d06fd5 38struct bt_graph;
c0418dd9 39
f60c8b34 40enum bt_graph_status {
a256a42d 41 BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION = 111,
4a6b963e 42 /** Canceled. */
ad847455 43 BT_GRAPH_STATUS_CANCELED = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED,
72b913fb 44 /** No sink can consume at the moment. */
ad847455 45 BT_GRAPH_STATUS_AGAIN = BT_COMPONENT_STATUS_AGAIN,
f60c8b34 46 /** Downstream component does not support multiple inputs. */
ad847455
PP
47 BT_GRAPH_STATUS_END = BT_COMPONENT_STATUS_END,
48 BT_GRAPH_STATUS_OK = BT_COMPONENT_STATUS_OK,
f60c8b34 49 /** Invalid arguments. */
ad847455 50 BT_GRAPH_STATUS_INVALID = BT_COMPONENT_STATUS_INVALID,
f60c8b34 51 /** No sink in graph. */
fe8ad2b6 52 BT_GRAPH_STATUS_NO_SINK = -6,
f60c8b34 53 /** General error. */
ad847455
PP
54 BT_GRAPH_STATUS_ERROR = BT_COMPONENT_STATUS_ERROR,
55 BT_GRAPH_STATUS_NOMEM = BT_COMPONENT_STATUS_NOMEM,
f60c8b34 56};
c0418dd9 57
202a3a13
PP
58extern bt_bool bt_graph_is_canceled(struct bt_graph *graph);
59
c0418dd9
JG
60#ifdef __cplusplus
61}
62#endif
63
1ca80abd 64#endif /* BABELTRACE_GRAPH_GRAPH_H */
This page took 0.0403 seconds and 4 git commands to generate.