include/babeltrace2/graph/component-class.h

   1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_H
   2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_H
   3
   4 /*
   5  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   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 <babeltrace2/types.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef enum bt_component_class_init_method_status {
  37         BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK                = __BT_FUNC_STATUS_OK,
  38         BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR             = __BT_FUNC_STATUS_ERROR,
  39         BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  40 } bt_component_class_init_method_status;
  41
  42 typedef enum bt_component_class_port_connected_method_status {
  43         BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_OK              = __BT_FUNC_STATUS_OK,
  44         BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR           = __BT_FUNC_STATUS_ERROR,
  45         BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
  46 } bt_component_class_port_connected_method_status;
  47
  48 typedef enum bt_component_class_query_method_status {
  49         BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK               = __BT_FUNC_STATUS_OK,
  50         BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN            = __BT_FUNC_STATUS_AGAIN,
  51         BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR            = __BT_FUNC_STATUS_ERROR,
  52         BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  53         BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_INVALID_OBJECT   = __BT_FUNC_STATUS_INVALID_OBJECT,
  54 } bt_component_class_query_method_status;
  55
  56 typedef enum bt_component_class_message_iterator_init_method_status {
  57         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK               = __BT_FUNC_STATUS_OK,
  58         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR            = __BT_FUNC_STATUS_ERROR,
  59         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  60 } bt_component_class_message_iterator_init_method_status;
  61
  62 typedef enum bt_component_class_message_iterator_next_method_status {
  63         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK               = __BT_FUNC_STATUS_OK,
  64         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_AGAIN            = __BT_FUNC_STATUS_AGAIN,
  65         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR            = __BT_FUNC_STATUS_ERROR,
  66         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  67         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END              = __BT_FUNC_STATUS_END,
  68 } bt_component_class_message_iterator_next_method_status;
  69
  70 typedef enum bt_component_class_message_iterator_seek_beginning_method_status {
  71         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK             = __BT_FUNC_STATUS_OK,
  72         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_AGAIN          = __BT_FUNC_STATUS_AGAIN,
  73         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR          = __BT_FUNC_STATUS_ERROR,
  74         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
  75 } bt_component_class_message_iterator_seek_beginning_method_status;
  76
  77 typedef enum bt_component_class_message_iterator_seek_ns_from_origin_method_status {
  78         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK                = __BT_FUNC_STATUS_OK,
  79         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_AGAIN             = __BT_FUNC_STATUS_AGAIN,
  80         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_ERROR             = __BT_FUNC_STATUS_ERROR,
  81         BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  82 } bt_component_class_message_iterator_seek_ns_from_origin_method_status;
  83
  84 typedef enum bt_component_class_set_method_status {
  85         BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK =       __BT_FUNC_STATUS_OK,
  86 } bt_component_class_set_method_status;
  87
  88 typedef enum bt_component_class_set_description_status {
  89         BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_OK            = __BT_FUNC_STATUS_OK,
  90         BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
  91 } bt_component_class_set_description_status;
  92
  93 extern bt_component_class_set_description_status
  94 bt_component_class_set_description(bt_component_class *component_class,
  95                 const char *description);
  96
  97 typedef enum bt_component_class_set_help_status {
  98         BT_COMPONENT_CLASS_SET_HELP_STATUS_OK           = __BT_FUNC_STATUS_OK,
  99         BT_COMPONENT_CLASS_SET_HELP_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
 100 } bt_component_class_set_help_status;
 101
 102 extern bt_component_class_set_help_status bt_component_class_set_help(
 103                 bt_component_class *component_class,
 104                 const char *help);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_H */