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_condition;
  27 struct lttng_notification;
  28 struct lttng_notification_channel;
  29
  30 /* LTTng Notification channel */
  31 enum lttng_notification_channel_status {
  32         LTTNG_NOTIFICATION_CHANNEL_STATUS_NOTIFICATIONS_DROPPED = 1,
  33         LTTNG_NOTIFICATION_CHANNEL_STATUS_OK = 0,
  34         LTTNG_NOTIFICATION_CHANNEL_STATUS_ERROR = -1,
  35         LTTNG_NOTIFICATION_CHANNEL_STATUS_CLOSED = -2,
  36         LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED = -3,
  37         /* Condition unknown. */
  38         LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION = -4,
  39         LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID = -5,
  40         LTTNG_NOTIFICATION_CHANNEL_STATUS_UNSUPPORTED_VERSION = -6,
  41 };
  42
  43 extern struct lttng_notification_channel *lttng_notification_channel_create(
  44                 struct lttng_endpoint *endpoint);
  45
  46 extern enum lttng_notification_channel_status
  47 lttng_notification_channel_get_next_notification(
  48                 struct lttng_notification_channel *channel,
  49                 struct lttng_notification **notification);
  50
  51 extern enum lttng_notification_channel_status
  52 lttng_notification_channel_subscribe(
  53                 struct lttng_notification_channel *channel,
  54                 const struct lttng_condition *condition);
  55
  56 extern enum lttng_notification_channel_status
  57 lttng_notification_channel_unsubscribe(
  58                 struct lttng_notification_channel *channel,
  59                 const struct lttng_condition *condition);
  60
  61 extern void lttng_notification_channel_destroy(
  62                 struct lttng_notification_channel *channel);
  63
  64 #ifdef __cplusplus
  65 }
  66 #endif
  67
  68 #endif /* LTTNG_NOTIFICATION_CHANNEL_H */