channel.h

/*
 * SPDX-FileCopyrightText: 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */
 
#ifndef LTTNG_NOTIFICATION_CHANNEL_H
#define LTTNG_NOTIFICATION_CHANNEL_H
 
#include <lttng/lttng-export.h>
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct lttng_endpoint;
struct lttng_condition;
struct lttng_notification;
 
struct lttng_notification_channel;
 
enum lttng_notification_channel_status {
    LTTNG_NOTIFICATION_CHANNEL_STATUS_OK = 0,
 
    LTTNG_NOTIFICATION_CHANNEL_STATUS_NOTIFICATIONS_DROPPED = 1,
 
    LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED = 2,
 
    LTTNG_NOTIFICATION_CHANNEL_STATUS_ERROR = -1,
 
    LTTNG_NOTIFICATION_CHANNEL_STATUS_CLOSED = -2,
 
    LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED = -3,
 
    LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION = -4,
 
    LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID = -5,
 
    /* Unused for the moment */
    LTTNG_NOTIFICATION_CHANNEL_STATUS_UNSUPPORTED_VERSION = -6,
};
 
LTTNG_EXPORT extern struct lttng_notification_channel *
lttng_notification_channel_create(struct lttng_endpoint *endpoint);
 
LTTNG_EXPORT extern enum lttng_notification_channel_status
lttng_notification_channel_get_next_notification(struct lttng_notification_channel *channel,
                         struct lttng_notification **notification);
 
LTTNG_EXPORT extern enum lttng_notification_channel_status
lttng_notification_channel_has_pending_notification(struct lttng_notification_channel *channel,
                            bool *notification_avail);
 
LTTNG_EXPORT extern enum lttng_notification_channel_status
lttng_notification_channel_subscribe(struct lttng_notification_channel *channel,
                     const struct lttng_condition *condition);
 
LTTNG_EXPORT extern enum lttng_notification_channel_status
lttng_notification_channel_unsubscribe(struct lttng_notification_channel *channel,
                       const struct lttng_condition *condition);
 
LTTNG_EXPORT extern void
lttng_notification_channel_destroy(struct lttng_notification_channel *channel);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* LTTNG_NOTIFICATION_CHANNEL_H */