include/babeltrace2/error-cause-const.h

   1 #ifndef BABELTRACE2_ERROR_CAUSE_CONST_H
   2 #define BABELTRACE2_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 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  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
  40 extern "C" {
  41 #endif
  42
  43 typedef 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
  50 extern
  51 bt_error_cause_actor_type bt_error_cause_get_actor_type(
  52                 const bt_error_cause *cause);
  53
  54 extern
  55 const char *bt_error_cause_get_message(const bt_error_cause *cause);
  56
  57 extern
  58 const char *bt_error_cause_get_module_name(const bt_error_cause *cause);
  59
  60 extern
  61 const char *bt_error_cause_get_file_name(const bt_error_cause *cause);
  62
  63 extern
  64 uint64_t bt_error_cause_get_line_number(const bt_error_cause *cause);
  65
  66 extern
  67 const char *bt_error_cause_component_actor_get_component_name(
  68                 const bt_error_cause *cause);
  69
  70 extern
  71 bt_component_class_type bt_error_cause_component_actor_get_component_class_type(
  72                 const bt_error_cause *cause);
  73
  74 extern
  75 const char *bt_error_cause_component_actor_get_component_class_name(
  76                 const bt_error_cause *cause);
  77
  78 extern
  79 const char *bt_error_cause_component_actor_get_plugin_name(
  80                 const bt_error_cause *cause);
  81
  82 extern
  83 bt_component_class_type
  84 bt_error_cause_component_class_actor_get_component_class_type(
  85                 const bt_error_cause *cause);
  86
  87 extern
  88 const char *bt_error_cause_component_class_actor_get_component_class_name(
  89                 const bt_error_cause *cause);
  90
  91 extern
  92 const char *bt_error_cause_component_class_actor_get_plugin_name(
  93                 const bt_error_cause *cause);
  94
  95 extern
  96 const char *bt_error_cause_message_iterator_actor_get_component_name(
  97                 const bt_error_cause *cause);
  98
  99 extern
 100 const char *bt_error_cause_message_iterator_actor_get_component_output_port_name(
 101                 const bt_error_cause *cause);
 102
 103 extern
 104 bt_component_class_type
 105 bt_error_cause_message_iterator_actor_get_component_class_type(
 106                 const bt_error_cause *cause);
 107
 108 extern
 109 const char *bt_error_cause_message_iterator_actor_get_component_class_name(
 110                 const bt_error_cause *cause);
 111
 112 extern
 113 const char *bt_error_cause_message_iterator_actor_get_plugin_name(
 114                 const bt_error_cause *cause);
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif
 119
 120 #endif /* BABELTRACE2_ERROR_CAUSE_CONST_H */