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

#ifndef BABELTRACE_COMPONENT_SINK_H
#define BABELTRACE_COMPONENT_SINK_H

/*
 * BabelTrace - Sink Component Interface
 *
 * Copyright 2017 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.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_component;
struct bt_notification;

extern enum bt_component_status bt_component_sink_get_input_port_count(
		struct bt_component *component, uint64_t *count);
extern struct bt_port *bt_component_sink_get_input_port(
		struct bt_component *component, const char *name);
extern struct bt_port *bt_component_sink_get_input_port_at_index(
		struct bt_component *component, int index);

/* Only allowed during the sink's initialization. */
extern struct bt_port *bt_component_sink_add_input_port(
		struct bt_component *component, const char *name);
/* Only allowed during the sink's initialization. */
extern struct bt_port *bt_component_sink_get_default_input_port(
		struct bt_component *component);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_COMPONENT_SINK_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_COMPONENT_SINK_H
	2	#define BABELTRACE_COMPONENT_SINK_H
	3
	4	/*
	5	* BabelTrace - Sink Component Interface
	6	*
	7	* Copyright 2017 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/component/component.h>
	31
	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
	36	struct bt_component;
	37	struct bt_notification;
	38
	39	extern enum bt_component_status bt_component_sink_get_input_port_count(
	40	struct bt_component component, uint64_t count);
	41	extern struct bt_port *bt_component_sink_get_input_port(
	42	struct bt_component component, const char name);
	43	extern struct bt_port *bt_component_sink_get_input_port_at_index(
	44	struct bt_component *component, int index);
	45
	46	/* Only allowed during the sink's initialization. */
	47	extern struct bt_port *bt_component_sink_add_input_port(
	48	struct bt_component component, const char name);
	49	/* Only allowed during the sink's initialization. */
	50	extern struct bt_port *bt_component_sink_get_default_input_port(
	51	struct bt_component *component);
	52
	53	#ifdef __cplusplus
	54	}
	55	#endif
	56
	57	#endif /* BABELTRACE_COMPONENT_SINK_H */