lib: force user to include `<babeltrace2/babeltrace.h>`
[babeltrace.git] / include / babeltrace2 / error-cause-const.h
CommitLineData
924dc299
PP
1#ifndef BABELTRACE2_ERROR_CAUSE_CONST_H
2#define BABELTRACE2_ERROR_CAUSE_CONST_H
553c4bab
PP
3
4/*
5 * Copyright (c) 2019 Philippe Proulx <pproulx@efficios.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
4fa90f32
PP
26#ifndef __BT_IN_BABELTRACE_H
27# error "Please include <babeltrace2/babeltrace.h> instead."
28#endif
29
553c4bab
PP
30#include <stdint.h>
31#include <stddef.h>
32
33/* For bt_error, bt_error_cause */
34#include <babeltrace2/types.h>
35
36/* For bt_component_class_type */
37#include <babeltrace2/graph/component-class-const.h>
38
39#ifdef __cplusplus
40extern "C" {
41#endif
42
43typedef enum bt_error_cause_actor_type {
44 BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN,
45 BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT,
46 BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS,
47 BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR,
48} bt_error_cause_actor_type;
49
50extern
51bt_error_cause_actor_type bt_error_cause_get_actor_type(
52 const bt_error_cause *cause);
53
54extern
55const char *bt_error_cause_get_message(const bt_error_cause *cause);
56
57extern
58const char *bt_error_cause_get_module_name(const bt_error_cause *cause);
59
60extern
61const char *bt_error_cause_get_file_name(const bt_error_cause *cause);
62
63extern
64uint64_t bt_error_cause_get_line_number(const bt_error_cause *cause);
65
66extern
67const char *bt_error_cause_component_actor_get_component_name(
68 const bt_error_cause *cause);
69
70extern
71bt_component_class_type bt_error_cause_component_actor_get_component_class_type(
72 const bt_error_cause *cause);
73
74extern
75const char *bt_error_cause_component_actor_get_component_class_name(
76 const bt_error_cause *cause);
77
78extern
79const char *bt_error_cause_component_actor_get_plugin_name(
80 const bt_error_cause *cause);
81
82extern
83bt_component_class_type
84bt_error_cause_component_class_actor_get_component_class_type(
85 const bt_error_cause *cause);
86
87extern
88const char *bt_error_cause_component_class_actor_get_component_class_name(
89 const bt_error_cause *cause);
90
91extern
92const char *bt_error_cause_component_class_actor_get_plugin_name(
93 const bt_error_cause *cause);
94
95extern
96const char *bt_error_cause_message_iterator_actor_get_component_name(
97 const bt_error_cause *cause);
98
99extern
100const char *bt_error_cause_message_iterator_actor_get_component_output_port_name(
101 const bt_error_cause *cause);
102
103extern
104bt_component_class_type
105bt_error_cause_message_iterator_actor_get_component_class_type(
106 const bt_error_cause *cause);
107
108extern
109const char *bt_error_cause_message_iterator_actor_get_component_class_name(
110 const bt_error_cause *cause);
111
112extern
113const char *bt_error_cause_message_iterator_actor_get_plugin_name(
114 const bt_error_cause *cause);
115
116#ifdef __cplusplus
117}
118#endif
119
924dc299 120#endif /* BABELTRACE2_ERROR_CAUSE_CONST_H */
This page took 0.026526 seconds and 4 git commands to generate.