golioth_settings.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Golioth, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include "golioth_status.h"
#include "golioth_client.h"
#include "golioth_config.h"
#include <stdint.h>
#include <stdbool.h>
 
 
typedef enum {
    GOLIOTH_SETTINGS_SUCCESS = 0,
    GOLIOTH_SETTINGS_KEY_NOT_RECOGNIZED = 1,
    GOLIOTH_SETTINGS_KEY_NOT_VALID = 2,
    GOLIOTH_SETTINGS_VALUE_FORMAT_NOT_VALID = 3,
    GOLIOTH_SETTINGS_VALUE_OUTSIDE_RANGE = 4,
    GOLIOTH_SETTINGS_VALUE_STRING_TOO_LONG = 5,
    GOLIOTH_SETTINGS_GENERAL_ERROR = 6,
} golioth_settings_status_t;
 
typedef enum {
    GOLIOTH_SETTINGS_VALUE_TYPE_UNKNOWN,
    GOLIOTH_SETTINGS_VALUE_TYPE_INT,
    GOLIOTH_SETTINGS_VALUE_TYPE_BOOL,
    GOLIOTH_SETTINGS_VALUE_TYPE_FLOAT,
    GOLIOTH_SETTINGS_VALUE_TYPE_STRING,
} golioth_settings_value_type_t;
 
typedef golioth_settings_status_t (*golioth_int_setting_cb)(int32_t new_value, void* arg);
typedef golioth_settings_status_t (*golioth_bool_setting_cb)(bool new_value, void* arg);
typedef golioth_settings_status_t (*golioth_float_setting_cb)(float new_value, void* arg);
typedef golioth_settings_status_t (
        *golioth_string_setting_cb)(const char* new_value, size_t new_value_len, void* arg);
 
typedef struct {
    bool is_valid;
    const char* key;  // aka name
    golioth_settings_value_type_t type;
    union {
        golioth_int_setting_cb int_cb;
        golioth_bool_setting_cb bool_cb;
        golioth_float_setting_cb float_cb;
        golioth_string_setting_cb string_cb;
    };
    int32_t int_min_val;  // applies only to integers
    int32_t int_max_val;  // applies only to integers
    void* cb_arg;
} golioth_setting_t;
 
typedef struct {
    bool initialized;
    golioth_setting_t settings[CONFIG_GOLIOTH_MAX_NUM_SETTINGS];
    size_t num_settings;
} golioth_settings_t;
 
golioth_status_t golioth_settings_register_int(
        golioth_client_t client,
        const char* setting_name,
        golioth_int_setting_cb callback,
        void* callback_arg);
 
golioth_status_t golioth_settings_register_int_with_range(
        golioth_client_t client,
        const char* setting_name,
        int32_t min_val,
        int32_t max_val,
        golioth_int_setting_cb callback,
        void* callback_arg);
 
golioth_status_t golioth_settings_register_bool(
        golioth_client_t client,
        const char* setting_name,
        golioth_bool_setting_cb callback,
        void* callback_arg);
 
golioth_status_t golioth_settings_register_float(
        golioth_client_t client,
        const char* setting_name,
        golioth_float_setting_cb callback,
        void* callback_arg);