Update notification iterator's "init" function signature

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

#ifndef BABELTRACE_COMPONENT_COMPONENT_H
#define BABELTRACE_COMPONENT_COMPONENT_H

/*
 * BabelTrace - Babeltrace Component Interface
 *
 * 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/component/component-class.h>
#include <babeltrace/component/notification/iterator.h>
#include <babeltrace/values.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_component_class;
struct bt_component_graph;
struct bt_component;
struct bt_value;
struct bt_port;

/**
 * Status code. Errors are always negative.
 */
enum bt_component_status {
	/** No error, okay. */
	BT_COMPONENT_STATUS_OK				= 0,
	/** No more work to be done by this component. **/
	BT_COMPONENT_STATUS_END				= 1,
	/**
	 * Component can't process a notification at this time
	 * (e.g. would block), try again later.
	 */
	BT_COMPONENT_STATUS_AGAIN			= 2,
	/** Refuse port connection. */
	BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION	= 3,
	/** General error. */
	BT_COMPONENT_STATUS_ERROR			= -1,
	/** Unsupported component feature. */
	BT_COMPONENT_STATUS_UNSUPPORTED			= -2,
	/** Invalid arguments. */
	BT_COMPONENT_STATUS_INVALID			= -3,
	/** Memory allocation failure. */
	BT_COMPONENT_STATUS_NOMEM			= -4,
	/** Element not found. */
	BT_COMPONENT_STATUS_NOT_FOUND			= -5,
};

/**
 * Create an instance of a component from a component class.
 *
 * @param component_class	Component class of which to create an instance
 * @param name			Name of the new component instance, optional
 * @param params		A dictionary of component parameters
 * @returns			Returns a pointer to a new component instance
 */
extern struct bt_component *bt_component_create(
		struct bt_component_class *component_class, const char *name,
		struct bt_value *params);

extern struct bt_component *bt_component_create_with_init_method_data(
		struct bt_component_class *component_class, const char *name,
		struct bt_value *params, void *init_method_data);

/**
 * Get component's name.
 *
 * @param component	Component instance of which to get the name
 * @returns		Returns a pointer to the component's name
 */
extern const char *bt_component_get_name(struct bt_component *component);

/**
 * Get component's class.
 *
 * @param component	Component instance of which to get the class
 * @returns		The component's class
 */
extern struct bt_component_class *bt_component_get_class(
		struct bt_component *component);

extern enum bt_component_class_type bt_component_get_class_type(
		struct bt_component *component);

extern struct bt_graph *bt_component_get_graph(struct bt_component *component);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_COMPONENT_COMPONENT_H */