lib: make message iterator creation functions return a status
[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/*
bbb7b5f0 5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
553c4bab
PP
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
553c4bab 33#include <babeltrace2/types.h>
553c4bab
PP
34#include <babeltrace2/graph/component-class-const.h>
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40typedef enum bt_error_cause_actor_type {
7b6afccb
PP
41 BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN = 0,
42 BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT = 1,
43 BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS = 2,
44 BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR = 3,
553c4bab
PP
45} bt_error_cause_actor_type;
46
47extern
48bt_error_cause_actor_type bt_error_cause_get_actor_type(
49 const bt_error_cause *cause);
50
51extern
52const char *bt_error_cause_get_message(const bt_error_cause *cause);
53
54extern
55const char *bt_error_cause_get_module_name(const bt_error_cause *cause);
56
57extern
58const char *bt_error_cause_get_file_name(const bt_error_cause *cause);
59
60extern
61uint64_t bt_error_cause_get_line_number(const bt_error_cause *cause);
62
63extern
64const char *bt_error_cause_component_actor_get_component_name(
65 const bt_error_cause *cause);
66
67extern
68bt_component_class_type bt_error_cause_component_actor_get_component_class_type(
69 const bt_error_cause *cause);
70
71extern
72const char *bt_error_cause_component_actor_get_component_class_name(
73 const bt_error_cause *cause);
74
75extern
76const char *bt_error_cause_component_actor_get_plugin_name(
77 const bt_error_cause *cause);
78
79extern
80bt_component_class_type
81bt_error_cause_component_class_actor_get_component_class_type(
82 const bt_error_cause *cause);
83
84extern
85const char *bt_error_cause_component_class_actor_get_component_class_name(
86 const bt_error_cause *cause);
87
88extern
89const char *bt_error_cause_component_class_actor_get_plugin_name(
90 const bt_error_cause *cause);
91
92extern
93const char *bt_error_cause_message_iterator_actor_get_component_name(
94 const bt_error_cause *cause);
95
96extern
97const char *bt_error_cause_message_iterator_actor_get_component_output_port_name(
98 const bt_error_cause *cause);
99
100extern
101bt_component_class_type
102bt_error_cause_message_iterator_actor_get_component_class_type(
103 const bt_error_cause *cause);
104
105extern
106const char *bt_error_cause_message_iterator_actor_get_component_class_name(
107 const bt_error_cause *cause);
108
109extern
110const char *bt_error_cause_message_iterator_actor_get_plugin_name(
111 const bt_error_cause *cause);
112
113#ifdef __cplusplus
114}
115#endif
116
924dc299 117#endif /* BABELTRACE2_ERROR_CAUSE_CONST_H */
This page took 0.03215 seconds and 4 git commands to generate.