1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_H
2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #ifndef __BT_IN_BABELTRACE_H
28 # error "Please include <babeltrace2/babeltrace.h> instead."
31 #include <babeltrace2/types.h>
37 typedef enum bt_component_class_init_method_status
{
38 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK
= __BT_FUNC_STATUS_OK
,
39 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
40 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
41 } bt_component_class_init_method_status
;
43 typedef enum bt_component_class_port_connected_method_status
{
44 BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_OK
= __BT_FUNC_STATUS_OK
,
45 BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
46 BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
47 } bt_component_class_port_connected_method_status
;
49 typedef enum bt_component_class_query_method_status
{
50 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
= __BT_FUNC_STATUS_OK
,
51 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
52 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
53 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
54 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_INVALID_OBJECT
= __BT_FUNC_STATUS_INVALID_OBJECT
,
55 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_INVALID_PARAMS
= __BT_FUNC_STATUS_INVALID_PARAMS
,
56 } bt_component_class_query_method_status
;
58 typedef enum bt_component_class_message_iterator_init_method_status
{
59 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK
= __BT_FUNC_STATUS_OK
,
60 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
61 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
62 } bt_component_class_message_iterator_init_method_status
;
64 typedef enum bt_component_class_message_iterator_next_method_status
{
65 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
= __BT_FUNC_STATUS_OK
,
66 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
67 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
68 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
69 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
= __BT_FUNC_STATUS_END
,
70 } bt_component_class_message_iterator_next_method_status
;
72 typedef enum bt_component_class_message_iterator_seek_beginning_method_status
{
73 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
= __BT_FUNC_STATUS_OK
,
74 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
75 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
76 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
77 } bt_component_class_message_iterator_seek_beginning_method_status
;
79 typedef enum bt_component_class_message_iterator_seek_ns_from_origin_method_status
{
80 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK
= __BT_FUNC_STATUS_OK
,
81 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
82 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
83 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
84 } bt_component_class_message_iterator_seek_ns_from_origin_method_status
;
86 typedef enum bt_component_class_set_method_status
{
87 BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK
= __BT_FUNC_STATUS_OK
,
88 } bt_component_class_set_method_status
;
90 typedef enum bt_component_class_set_description_status
{
91 BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_OK
= __BT_FUNC_STATUS_OK
,
92 BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
93 } bt_component_class_set_description_status
;
95 extern bt_component_class_set_description_status
96 bt_component_class_set_description(bt_component_class
*component_class
,
97 const char *description
);
99 typedef enum bt_component_class_set_help_status
{
100 BT_COMPONENT_CLASS_SET_HELP_STATUS_OK
= __BT_FUNC_STATUS_OK
,
101 BT_COMPONENT_CLASS_SET_HELP_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
102 } bt_component_class_set_help_status
;
104 extern bt_component_class_set_help_status
bt_component_class_set_help(
105 bt_component_class
*component_class
,
112 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_H */