Babeltrace 2 C API  2.0.3
Open-source trace manipulation framework
 All Functions Variables Typedefs Enumerations Enumerator Modules Pages
component-descriptor-set.h
1 #ifndef BABELTRACE2_GRAPH_COMPONENT_DESCRIPTOR_SET_H
2 #define BABELTRACE2_GRAPH_COMPONENT_DESCRIPTOR_SET_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 #include <babeltrace2/logging.h>
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
114 
127 
134 
150  bt_component_descriptor_set *component_descriptor_set,
151  const bt_component_class *component_class,
152  const bt_value *params);
153 
196  bt_component_descriptor_set *component_descriptor_set,
197  const bt_component_class *component_class,
198  const bt_value *params, void *initialize_method_data);
199 
223  const bt_component_descriptor_set *component_descriptor_set);
224 
241  const bt_component_descriptor_set *component_descriptor_set);
242 
258 #define BT_COMPONENT_DESCRIPTOR_SET_PUT_REF_AND_RESET(_component_descriptor_set) \
259  do { \
260  bt_component_descriptor_set_put_ref(_component_descriptor_set); \
261  (_component_descriptor_set) = NULL; \
262  } while (0)
263 
290 #define BT_COMPONENT_DESCRIPTOR_SET_MOVE_REF(_dst, _src) \
291  do { \
292  bt_component_descriptor_set_put_ref(_dst); \
293  (_dst) = (_src); \
294  (_src) = NULL; \
295  } while (0)
296 
301 #ifdef __cplusplus
302 }
303 #endif
304 
305 #endif /* BABELTRACE2_GRAPH_COMPONENT_DESCRIPTOR_SET_H */
bt_component_descriptor_set_add_descriptor_status bt_component_descriptor_set_add_descriptor_with_initialize_method_data(bt_component_descriptor_set *component_descriptor_set, const bt_component_class *component_class, const bt_value *params, void *initialize_method_data)
Adds a descriptor of a component which would be an instance of the component class component_class...
struct bt_component_descriptor_set bt_component_descriptor_set
Component descriptor set.
Definition: types.h:43
bt_component_descriptor_set_add_descriptor_status
Status codes for bt_component_descriptor_set_add_descriptor() and bt_component_descriptor_set_add_des...
Definition: component-descriptor-set.h:121
struct bt_component_class bt_component_class
Component class.
Definition: types.h:39
Out of memory.
Definition: component-descriptor-set.h:132
struct bt_value bt_value
Value.
Definition: types.h:107
bt_component_descriptor_set_add_descriptor_status bt_component_descriptor_set_add_descriptor(bt_component_descriptor_set *component_descriptor_set, const bt_component_class *component_class, const bt_value *params)
Alias of bt_component_descriptor_set_add_descriptor_with_initialize_method_data() with the initialize...
bt_component_descriptor_set * bt_component_descriptor_set_create(void)
Creates an empty component descriptor set.
void bt_component_descriptor_set_get_ref(const bt_component_descriptor_set *component_descriptor_set)
Increments the reference count of the component descriptor set component_descriptor_set.
Success.
Definition: component-descriptor-set.h:126
void bt_component_descriptor_set_put_ref(const bt_component_descriptor_set *component_descriptor_set)
Decrements the reference count of the component descriptor set component_descriptor_set.