[babeltrace.git] / include / babeltrace / component / component-internal.h

#ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
#define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H

/*
 * BabelTrace - Component internal
 *
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/component/component.h>
#include <babeltrace/component/component-class-internal.h>
#include <babeltrace/object-internal.h>
#include <glib.h>
#include <stdio.h>

struct bt_component {
	struct bt_object base;
	struct bt_component_class *class;
	GString *name;

	/**
	 * Internal destroy function specific to a source, filter, or
	 * sink component object.
	 */
	bt_component_class_destroy_method destroy;

	/** User-defined data */
	void *user_data;

	/**
	 * Used to protect operations which may only be used during
	 * a component's initialization.
	 */
	bool initializing;
};

BT_HIDDEN
enum bt_component_status bt_component_init(struct bt_component *component,
		bt_component_class_destroy_method destroy);

BT_HIDDEN
struct bt_notification_iterator *bt_component_create_iterator(
		struct bt_component *component);

#endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
	2	#define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
	3
	4	/*
	5	* BabelTrace - Component internal
	6	*
	7	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
	30	#include <babeltrace/babeltrace-internal.h>
	31	#include <babeltrace/component/component.h>
	32	#include <babeltrace/component/component-class-internal.h>
	33	#include <babeltrace/object-internal.h>
	34	#include <glib.h>
	35	#include <stdio.h>
	36
	37	struct bt_component {
	38	struct bt_object base;
	39	struct bt_component_class *class;
	40	GString *name;
	41
	42	/**
	43	* Internal destroy function specific to a source, filter, or
	44	* sink component object.
	45	*/
	46	bt_component_class_destroy_method destroy;
	47
	48	/** User-defined data */
	49	void *user_data;
	50
	51	/**
	52	* Used to protect operations which may only be used during
	53	* a component's initialization.
	54	*/
	55	bool initializing;
	56	};
	57
	58	BT_HIDDEN
	59	enum bt_component_status bt_component_init(struct bt_component *component,
	60	bt_component_class_destroy_method destroy);
	61
	62	BT_HIDDEN
	63	struct bt_notification_iterator *bt_component_create_iterator(
	64	struct bt_component *component);
	65
	66	#endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */