lib: add thread-safe error reporting API
[babeltrace.git] / include / babeltrace2 / error-cause-const.h
CommitLineData
553c4bab
PP
1#ifndef BABELTRACE_ERROR_CAUSE_CONST_H
2#define BABELTRACE_ERROR_CAUSE_CONST_H
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
26#include <stdint.h>
27#include <stddef.h>
28
29/* For bt_error, bt_error_cause */
30#include <babeltrace2/types.h>
31
32/* For bt_component_class_type */
33#include <babeltrace2/graph/component-class-const.h>
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39typedef enum bt_error_cause_actor_type {
40 BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN,
41 BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT,
42 BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS,
43 BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR,
44} bt_error_cause_actor_type;
45
46extern
47bt_error_cause_actor_type bt_error_cause_get_actor_type(
48 const bt_error_cause *cause);
49
50extern
51const char *bt_error_cause_get_message(const bt_error_cause *cause);
52
53extern
54const char *bt_error_cause_get_module_name(const bt_error_cause *cause);
55
56extern
57const char *bt_error_cause_get_file_name(const bt_error_cause *cause);
58
59extern
60uint64_t bt_error_cause_get_line_number(const bt_error_cause *cause);
61
62extern
63const char *bt_error_cause_component_actor_get_component_name(
64 const bt_error_cause *cause);
65
66extern
67bt_component_class_type bt_error_cause_component_actor_get_component_class_type(
68 const bt_error_cause *cause);
69
70extern
71const char *bt_error_cause_component_actor_get_component_class_name(
72 const bt_error_cause *cause);
73
74extern
75const char *bt_error_cause_component_actor_get_plugin_name(
76 const bt_error_cause *cause);
77
78extern
79bt_component_class_type
80bt_error_cause_component_class_actor_get_component_class_type(
81 const bt_error_cause *cause);
82
83extern
84const char *bt_error_cause_component_class_actor_get_component_class_name(
85 const bt_error_cause *cause);
86
87extern
88const char *bt_error_cause_component_class_actor_get_plugin_name(
89 const bt_error_cause *cause);
90
91extern
92const char *bt_error_cause_message_iterator_actor_get_component_name(
93 const bt_error_cause *cause);
94
95extern
96const char *bt_error_cause_message_iterator_actor_get_component_output_port_name(
97 const bt_error_cause *cause);
98
99extern
100bt_component_class_type
101bt_error_cause_message_iterator_actor_get_component_class_type(
102 const bt_error_cause *cause);
103
104extern
105const char *bt_error_cause_message_iterator_actor_get_component_class_name(
106 const bt_error_cause *cause);
107
108extern
109const char *bt_error_cause_message_iterator_actor_get_plugin_name(
110 const bt_error_cause *cause);
111
112#ifdef __cplusplus
113}
114#endif
115
116#endif /* BABELTRACE_ERROR_CAUSE_CONST_H */
This page took 0.028679 seconds and 4 git commands to generate.