From a109f1c6acc90b8ca847ebe2d68b67601e250541 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Mon, 31 Jul 2017 14:08:19 -0400 Subject: [PATCH] Docs: document the lttng_action_notify action type MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- include/lttng/action/notify.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/include/lttng/action/notify.h b/include/lttng/action/notify.h index 6c0d0ca25..04f468561 100644 --- a/include/lttng/action/notify.h +++ b/include/lttng/action/notify.h @@ -24,6 +24,17 @@ struct lttng_action; extern "C" { #endif +/* + * Create a newly allocated notification action object. + * + * A "notify" action will emit a notification to all clients which have an + * open notification channel. In order to receive this notification, clients + * must have subscribed to a condition equivalent to the one paired to this + * notify action in a trigger. + * + * Returns a new action on success, NULL on failure. This action must be + * destroyed using lttng_action_destroy(). + */ extern struct lttng_action *lttng_action_notify_create(void); #ifdef __cplusplus -- 2.34.1