From f3509d2a0f1bbe1521316554aab6fec6cb48d84e Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Thu, 11 Feb 2021 11:37:33 -0500 Subject: [PATCH] sessiond: docs: document action_executor_enqueue() parameter ownership MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau Change-Id: Iab668825a7b529e4212aa39080e152628c07a363 --- src/bin/lttng-sessiond/action-executor.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/bin/lttng-sessiond/action-executor.h b/src/bin/lttng-sessiond/action-executor.h index e01a37773..945b9b325 100644 --- a/src/bin/lttng-sessiond/action-executor.h +++ b/src/bin/lttng-sessiond/action-executor.h @@ -27,6 +27,16 @@ struct action_executor *action_executor_create( void action_executor_destroy(struct action_executor *executor); +/* + * Enqueue a job on an action executor's work queue to perform the actions + * associated with a trigger. + * + * A reference to `trigger` is acquired. + * A reference to `list` is acquired. + * + * This function assumes the ownership of the `evaluation` both on success and + * failure: the caller should no longer access it once the function returns. + */ enum action_executor_status action_executor_enqueue( struct action_executor *executor, struct lttng_trigger *trigger, -- 2.34.1