event-field-value.h

/*
 * SPDX-FileCopyrightText: 2020 Philippe Proulx <pproulx@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */
 
#ifndef LTTNG_EVENT_FIELD_VALUE_H
#define LTTNG_EVENT_FIELD_VALUE_H
 
#include <lttng/lttng-export.h>
 
#include <stdint.h>
 
struct lttng_event_field_value;
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum lttng_event_field_value_type {
    LTTNG_EVENT_FIELD_VALUE_TYPE_UNSIGNED_INT = 0,
 
    LTTNG_EVENT_FIELD_VALUE_TYPE_SIGNED_INT = 1,
 
    LTTNG_EVENT_FIELD_VALUE_TYPE_UNSIGNED_ENUM = 2,
 
    LTTNG_EVENT_FIELD_VALUE_TYPE_SIGNED_ENUM = 3,
 
    LTTNG_EVENT_FIELD_VALUE_TYPE_REAL = 4,
 
    LTTNG_EVENT_FIELD_VALUE_TYPE_STRING = 5,
 
    LTTNG_EVENT_FIELD_VALUE_TYPE_ARRAY = 6,
 
    LTTNG_EVENT_FIELD_VALUE_TYPE_BLOB = 7,
 
    LTTNG_EVENT_FIELD_VALUE_TYPE_INVALID = -1,
 
    LTTNG_EVENT_FIELD_VALUE_TYPE_UNKNOWN = -2,
};
 
enum lttng_event_field_value_status {
    LTTNG_EVENT_FIELD_VALUE_STATUS_OK = 0,
 
    LTTNG_EVENT_FIELD_VALUE_STATUS_INVALID = -1,
 
    LTTNG_EVENT_FIELD_VALUE_STATUS_UNAVAILABLE = -2,
};
 
LTTNG_EXPORT extern enum lttng_event_field_value_type
lttng_event_field_value_get_type(const struct lttng_event_field_value *field_val);
 
LTTNG_EXPORT extern enum lttng_event_field_value_status
lttng_event_field_value_unsigned_int_get_value(const struct lttng_event_field_value *field_val,
                           uint64_t *val);
 
LTTNG_EXPORT extern enum lttng_event_field_value_status
lttng_event_field_value_signed_int_get_value(const struct lttng_event_field_value *field_val,
                         int64_t *val);
 
LTTNG_EXPORT extern enum lttng_event_field_value_status
lttng_event_field_value_real_get_value(const struct lttng_event_field_value *field_val,
                       double *val);
 
LTTNG_EXPORT extern enum lttng_event_field_value_status
lttng_event_field_value_string_get_value(const struct lttng_event_field_value *field_val,
                     const char **val);
 
LTTNG_EXPORT extern enum lttng_event_field_value_status
lttng_event_field_value_array_get_length(const struct lttng_event_field_value *field_val,
                     unsigned int *length);
 
LTTNG_EXPORT extern enum lttng_event_field_value_status
lttng_event_field_value_array_get_element_at_index(
    const struct lttng_event_field_value *field_val,
    unsigned int index,
    const struct lttng_event_field_value **elem_field_val);
 
LTTNG_EXPORT extern enum lttng_event_field_value_status
lttng_event_field_value_blob_get_media_type(const struct lttng_event_field_value *field_val,
                        const char **media_type);
 
LTTNG_EXPORT extern enum lttng_event_field_value_status
lttng_event_field_value_blob_get_length(const struct lttng_event_field_value *field_val,
                    size_t *length);
 
LTTNG_EXPORT extern enum lttng_event_field_value_status
lttng_event_field_value_blob_get_data(const struct lttng_event_field_value *field_val,
                      const uint8_t **data);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* LTTNG_EVENT_FIELD_VALUE_H */