Docs: document the lttng_action_notify action type
[lttng-tools.git] / include / lttng / action / notify.h
CommitLineData
a58c490f
JG
1/*
2 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * This library is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU Lesser General Public License, version 2.1 only,
6 * as published by the Free Software Foundation.
7 *
8 * This library is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
11 * for more details.
12 *
13 * You should have received a copy of the GNU Lesser General Public License
14 * along with this library; if not, write to the Free Software Foundation,
15 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16 */
17
18#ifndef LTTNG_ACTION_NOTIFY_H
19#define LTTNG_ACTION_NOTIFY_H
20
21struct lttng_action;
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
a109f1c6
JG
27/*
28 * Create a newly allocated notification action object.
29 *
30 * A "notify" action will emit a notification to all clients which have an
31 * open notification channel. In order to receive this notification, clients
32 * must have subscribed to a condition equivalent to the one paired to this
33 * notify action in a trigger.
34 *
35 * Returns a new action on success, NULL on failure. This action must be
36 * destroyed using lttng_action_destroy().
37 */
a58c490f
JG
38extern struct lttng_action *lttng_action_notify_create(void);
39
40#ifdef __cplusplus
41}
42#endif
43
44#endif /* LTTNG_ACTION_NOTIFY_H */
This page took 0.03311 seconds and 4 git commands to generate.