channel-descriptor.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_DESCRIPTOR_H
#define LTTNG_MAP_CHANNEL_DESCRIPTOR_H
 
#include <lttng/lttng-export.h>
#include <lttng/map/channel-type.h>
#include <lttng/map/channel-update-policy.h>
#include <lttng/map/value-type.h>
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct lttng_map_channel_descriptor;
 
enum lttng_map_channel_descriptor_status {
    LTTNG_MAP_CHANNEL_DESCRIPTOR_STATUS_OK = 0,
 
    LTTNG_MAP_CHANNEL_DESCRIPTOR_STATUS_UNSET = 1,
 
    LTTNG_MAP_CHANNEL_DESCRIPTOR_STATUS_INVALID_PARAMETER = -1,
};
 
LTTNG_EXPORT extern enum lttng_map_channel_descriptor_status
lttng_map_channel_descriptor_set_name(struct lttng_map_channel_descriptor *descriptor,
                      const char *name);
 
LTTNG_EXPORT extern enum lttng_map_channel_descriptor_status
lttng_map_channel_descriptor_get_name(const struct lttng_map_channel_descriptor *descriptor,
                      const char **name);
 
LTTNG_EXPORT extern enum lttng_map_channel_descriptor_status
lttng_map_channel_descriptor_get_type(const struct lttng_map_channel_descriptor *descriptor,
                      enum lttng_map_channel_type *type);
 
LTTNG_EXPORT extern enum lttng_map_channel_descriptor_status
lttng_map_channel_descriptor_get_value_type(const struct lttng_map_channel_descriptor *descriptor,
                        enum lttng_map_value_type *value_type);
 
LTTNG_EXPORT extern enum lttng_map_channel_descriptor_status
lttng_map_channel_descriptor_set_max_key_count(struct lttng_map_channel_descriptor *descriptor,
                           uint64_t max_key_count);
 
LTTNG_EXPORT extern enum lttng_map_channel_descriptor_status
lttng_map_channel_descriptor_get_max_key_count(
    const struct lttng_map_channel_descriptor *descriptor, uint64_t *max_key_count);
 
LTTNG_EXPORT extern enum lttng_map_channel_descriptor_status
lttng_map_channel_descriptor_set_update_policy(struct lttng_map_channel_descriptor *descriptor,
                           enum lttng_map_channel_update_policy policy);
 
LTTNG_EXPORT extern enum lttng_map_channel_descriptor_status
lttng_map_channel_descriptor_get_update_policy(const struct lttng_map_channel_descriptor *descriptor,
                           enum lttng_map_channel_update_policy *policy);
 
LTTNG_EXPORT extern void
lttng_map_channel_descriptor_destroy(struct lttng_map_channel_descriptor *descriptor);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* LTTNG_MAP_CHANNEL_DESCRIPTOR_H */