include/lttng/notification/channel.h

   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_NOTIFICATION_CHANNEL_H
  19 #define LTTNG_NOTIFICATION_CHANNEL_H
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24
  25 struct lttng_endpoint;
  26 struct lttng_notification;
  27 struct lttng_notification_channel;
  28 struct lttng_notification_channel_endpoint;
  29
  30 /* LTTng Notification channel */
  31 enum lttng_notification_channel_status {
  32         LTTNG_NOTIFICATION_CHANNEL_STATUS_TIMEOUT = 2,
  33         LTTNG_NOTIFICATION_CHANNEL_STATUS_NOTIFICATIONS_DROPPED = 1,
  34         LTTNG_NOTIFICATION_CHANNEL_STATUS_OK = 0,
  35         LTTNG_NOTIFICATION_CHANNEL_STATUS_CLOSED = -1,
  36         LTTNG_NOTIFICATION_CHANNEL_STATUS_NOT_FOUND = -2,
  37         LTTNG_NOTIFICATION_CHANNEL_STATUS_UNSUPPORTED = -3,
  38 };
  39
  40 /* TODO Add target parameter (sessiond, relayd, etc.). */
  41 extern struct lttng_notification_channel *lttng_notification_channel_create(
  42                 struct lttng_endpoint *endpoint);
  43
  44 extern enum lttng_notification_channel_status
  45 lttng_notification_channel_get_next_notification(
  46                 struct lttng_notification_channel *channel,
  47                 struct lttng_notification **notification,
  48                 unsigned int timeout_ms);
  49
  50 extern enum lttng_notification_channel_status
  51 lttng_notification_channel_subscribe(
  52                 struct lttng_notification_channel *channel,
  53                 struct lttng_condition *condition);
  54
  55 extern enum lttng_notification_channel_status
  56 lttng_notification_channel_unsubscribe(
  57                 struct lttng_notification_channel *channel,
  58                 struct lttng_condition *condition);
  59
  60 extern void lttng_notification_channel_destroy(
  61                 struct lttng_notification_channel *channel);
  62
  63 #ifdef __cplusplus
  64 }
  65 #endif
  66
  67 #endif /* LTTNG_NOTIFICATION_CHANNEL_H */