[lttng-tools.git] / include / lttng / action / group.h

/*
 * Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef LTTNG_ACTION_GROUP_H
#define LTTNG_ACTION_GROUP_H

struct lttng_action;
struct lttng_action_group;

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Create a newly allocated action group object.
 *
 * Returns a new action group on success, NULL on failure. This action group
 * must be destroyed using lttng_action_group_destroy().
 */
extern struct lttng_action *lttng_action_group_create(void);

/*
 * Add an action to an lttng_action object of type LTTNG_ACTION_GROUP.
 *
 * The action group acquires a reference to the action. The action can be
 * safely destroyed after calling this function. An action must not be
 * modified after adding it to a group.
 *
 * Adding an action group to an action group is not supported.
 */
extern enum lttng_action_status lttng_action_group_add_action(
		struct lttng_action *group, struct lttng_action *action);

/*
 * Get the number of actions in an action group.
 */
extern enum lttng_action_status lttng_action_group_get_count(
		const struct lttng_action *group, unsigned int *count);

/*
 * Get an action from the action group at a given index.
 *
 * Note that the group maintains the ownership of the returned action.
 * It must not be destroyed by the user, nor should it be held beyond
 * the lifetime of the action group.
 *
 * Returns an action, or NULL on error.
 */
extern const struct lttng_action *lttng_action_group_get_at_index(
		const struct lttng_action *group,
		unsigned int index);

#ifdef __cplusplus
}
#endif

#endif /* LTTNG_ACTION_GROUP_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
	8	#ifndef LTTNG_ACTION_GROUP_H
	9	#define LTTNG_ACTION_GROUP_H
	10
	11	struct lttng_action;
	12	struct lttng_action_group;
	13
	14	#ifdef __cplusplus
	15	extern "C" {
	16	#endif
	17
	18	/*
	19	* Create a newly allocated action group object.
	20	*
	21	* Returns a new action group on success, NULL on failure. This action group
	22	* must be destroyed using lttng_action_group_destroy().
	23	*/
	24	extern struct lttng_action *lttng_action_group_create(void);
	25
	26	/*
	27	* Add an action to an lttng_action object of type LTTNG_ACTION_GROUP.
	28	*
	29	* The action group acquires a reference to the action. The action can be
	30	* safely destroyed after calling this function. An action must not be
	31	* modified after adding it to a group.
	32	*
	33	* Adding an action group to an action group is not supported.
	34	*/
	35	extern enum lttng_action_status lttng_action_group_add_action(
	36	struct lttng_action group, struct lttng_action action);
	37
	38	/*
	39	* Get the number of actions in an action group.
	40	*/
	41	extern enum lttng_action_status lttng_action_group_get_count(
	42	const struct lttng_action group, unsigned int count);
	43
	44	/*
	45	* Get an action from the action group at a given index.
	46	*
	47	* Note that the group maintains the ownership of the returned action.
	48	* It must not be destroyed by the user, nor should it be held beyond
	49	* the lifetime of the action group.
	50	*
	51	* Returns an action, or NULL on error.
	52	*/
	53	extern const struct lttng_action *lttng_action_group_get_at_index(
	54	const struct lttng_action *group,
	55	unsigned int index);
	56
	57	#ifdef __cplusplus
	58	}
	59	#endif
	60
	61	#endif /* LTTNG_ACTION_GROUP_H */