lib: rename "notification" -> "message"
[babeltrace.git] / include / babeltrace / graph / component-class-source.h
1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H
2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
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:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
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
24 * SOFTWARE.
25 */
26
27 #include <stdint.h>
28
29 /* For enum bt_self_component_status */
30 #include <babeltrace/graph/self-component.h>
31
32 /* For enum bt_self_message_iterator_status */
33 #include <babeltrace/graph/self-message-iterator.h>
34
35 /* For enum bt_query_status */
36 #include <babeltrace/graph/component-class.h>
37
38 /*
39 * For bt_component_class, bt_component_class_source, bt_port_input,
40 * bt_query_executor, bt_self_component_class_source,
41 * bt_self_component_source, bt_self_component_port_output, bt_value,
42 * bt_message_array_const
43 */
44 #include <babeltrace/types.h>
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 typedef enum bt_self_component_status
51 (*bt_component_class_source_init_method)(
52 bt_self_component_source *self_component,
53 const bt_value *params, void *init_method_data);
54
55 typedef void (*bt_component_class_source_finalize_method)(
56 bt_self_component_source *self_component);
57
58 typedef enum bt_self_message_iterator_status
59 (*bt_component_class_source_message_iterator_init_method)(
60 bt_self_message_iterator *message_iterator,
61 bt_self_component_source *self_component,
62 bt_self_component_port_output *port);
63
64 typedef void
65 (*bt_component_class_source_message_iterator_finalize_method)(
66 bt_self_message_iterator *message_iterator);
67
68 typedef enum bt_self_message_iterator_status
69 (*bt_component_class_source_message_iterator_next_method)(
70 bt_self_message_iterator *message_iterator,
71 bt_message_array_const msgs, uint64_t capacity,
72 uint64_t *count);
73
74 typedef enum bt_query_status
75 (*bt_component_class_source_query_method)(
76 bt_self_component_class_source *comp_class,
77 const bt_query_executor *query_executor,
78 const char *object, const bt_value *params,
79 const bt_value **result);
80
81 typedef enum bt_self_component_status
82 (*bt_component_class_source_accept_output_port_connection_method)(
83 bt_self_component_source *self_component,
84 bt_self_component_port_output *self_port,
85 const bt_port_input *other_port);
86
87 typedef enum bt_self_component_status
88 (*bt_component_class_source_output_port_connected_method)(
89 bt_self_component_source *self_component,
90 bt_self_component_port_output *self_port,
91 const bt_port_input *other_port);
92
93 typedef void
94 (*bt_component_class_source_output_port_disconnected_method)(
95 bt_self_component_source *self_component,
96 bt_self_component_port_output *self_port);
97
98 static inline
99 bt_component_class *bt_component_class_source_as_component_class(
100 bt_component_class_source *comp_cls_source)
101 {
102 return (void *) comp_cls_source;
103 }
104
105 extern
106 bt_component_class_source *bt_component_class_source_create(
107 const char *name,
108 bt_component_class_source_message_iterator_next_method method);
109
110 extern int bt_component_class_source_set_init_method(
111 bt_component_class_source *comp_class,
112 bt_component_class_source_init_method method);
113
114 extern int bt_component_class_source_set_finalize_method(
115 bt_component_class_source *comp_class,
116 bt_component_class_source_finalize_method method);
117
118 extern int bt_component_class_source_set_accept_output_port_connection_method(
119 bt_component_class_source *comp_class,
120 bt_component_class_source_accept_output_port_connection_method method);
121
122 extern int bt_component_class_source_set_output_port_connected_method(
123 bt_component_class_source *comp_class,
124 bt_component_class_source_output_port_connected_method method);
125
126 extern int bt_component_class_source_set_output_port_disconnected_method(
127 bt_component_class_source *comp_class,
128 bt_component_class_source_output_port_disconnected_method method);
129
130 extern int bt_component_class_source_set_query_method(
131 bt_component_class_source *comp_class,
132 bt_component_class_source_query_method method);
133
134 extern int bt_component_class_source_set_message_iterator_init_method(
135 bt_component_class_source *comp_class,
136 bt_component_class_source_message_iterator_init_method method);
137
138 extern int bt_component_class_source_set_message_iterator_finalize_method(
139 bt_component_class_source *comp_class,
140 bt_component_class_source_message_iterator_finalize_method method);
141
142 #ifdef __cplusplus
143 }
144 #endif
145
146 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H */
This page took 0.035375 seconds and 4 git commands to generate.