channel.h

/*
 * Copyright (C) 2023 Philippe Proulx <eepp@efficios.com>
 * Copyright (C) 2023 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */
 
#ifndef LTTNG_MAP_CHANNEL_H
#define LTTNG_MAP_CHANNEL_H
 
#include <lttng/lttng-export.h>
#include <lttng/map/channel-type.h>
#include <lttng/map/channel-update-policy.h>
#include <lttng/map/group-set.h>
#include <lttng/map/group.h>
#include <lttng/map/key-set.h>
#include <lttng/map/key-type.h>
#include <lttng/map/value-type.h>
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct lttng_map_channel;
 
enum lttng_map_channel_status {
    LTTNG_MAP_CHANNEL_STATUS_OK = 0,
 
    LTTNG_MAP_CHANNEL_STATUS_INVALID_PARAMETER = -1,
 
    LTTNG_MAP_CHANNEL_STATUS_NOT_FOUND = -2,
 
    LTTNG_MAP_CHANNEL_STATUS_ERROR = -3,
};
 
LTTNG_EXPORT extern enum lttng_map_channel_status
lttng_map_channel_get_name(const struct lttng_map_channel *channel, const char **name);
 
LTTNG_EXPORT extern enum lttng_map_channel_status
lttng_map_channel_get_type(const struct lttng_map_channel *channel,
               enum lttng_map_channel_type *type);
 
LTTNG_EXPORT extern enum lttng_map_channel_status
lttng_map_channel_get_value_type(const struct lttng_map_channel *channel,
                 enum lttng_map_value_type *value_type);
 
LTTNG_EXPORT extern enum lttng_map_channel_status
lttng_map_channel_get_max_key_count(const struct lttng_map_channel *channel,
                    uint64_t *max_key_count);
 
LTTNG_EXPORT extern enum lttng_map_channel_status
lttng_map_channel_get_update_policy(const struct lttng_map_channel *channel,
                    enum lttng_map_channel_update_policy *policy);
 
/* clang-format off */
 
LTTNG_EXPORT extern enum lttng_map_channel_status
lttng_map_channel_get_groups(const struct lttng_map_channel *channel,
                 struct lttng_map_group_set **groups);
 
/* clang-format on */
 
LTTNG_EXPORT extern enum lttng_map_channel_status
lttng_map_channel_get_shared_group(const struct lttng_map_channel *channel,
                   struct lttng_map_group **group);
 
LTTNG_EXPORT extern enum lttng_map_channel_status
lttng_map_channel_get_keys(const struct lttng_map_channel *channel,
               struct lttng_map_key_set **keys);
 
LTTNG_EXPORT extern void lttng_map_channel_destroy(struct lttng_map_channel *channel);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* LTTNG_MAP_CHANNEL_H */