include/lttng/action/notify.h

   1 /*
   2  * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #ifndef LTTNG_ACTION_NOTIFY_H
   9 #define LTTNG_ACTION_NOTIFY_H
  10
  11 struct lttng_action;
  12
  13 #ifdef __cplusplus
  14 extern "C" {
  15 #endif
  16
  17 /*
  18  * Create a newly allocated notification action object.
  19  *
  20  * A "notify" action will emit a notification to all clients which have an
  21  * open notification channel. In order to receive this notification, clients
  22  * must have subscribed to a condition equivalent to the one paired to this
  23  * notify action in a trigger.
  24  *
  25  * Returns a new action on success, NULL on failure. This action must be
  26  * destroyed using lttng_action_destroy().
  27  */
  28 extern struct lttng_action *lttng_action_notify_create(void);
  29
  30 #ifdef __cplusplus
  31 }
  32 #endif
  33
  34 #endif /* LTTNG_ACTION_NOTIFY_H */