attribute_resolver.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
#ifndef ATTRIBUTE_RESOLVER_H
#define ATTRIBUTE_RESOLVER_H
 
#include "sl_status.h"
#include "attribute_store.h"
#include "clock.h"
#include <stdbool.h>
 
typedef void (*attribute_resolver_callback_t)(attribute_store_node_t node);
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
  void (*send_init)(void);
  sl_status_t (*send)(attribute_store_node_t node,
                      const uint8_t *frame_data,
                      uint16_t frame_data_len,
                      bool is_set);
  sl_status_t (*abort)(attribute_store_node_t node);
  // Retry timeout for get commands
  clock_time_t get_retry_timeout;
  // Number of times to retry sending a get
  uint8_t get_retry_count;
} attribute_resolver_config_t;
 
#define MAX_FRAME_LEN 255
 
typedef sl_status_t (*attribute_resolver_function_t)(
  attribute_store_node_t node, uint8_t *frame, uint16_t *frame_len);
 
sl_status_t
  attribute_resolver_init(attribute_resolver_config_t resolver_config);
 
int attribute_resolver_teardown();
 
sl_status_t
  attribute_resolver_register_rule(attribute_store_type_t node_type,
                                   attribute_resolver_function_t set_func,
                                   attribute_resolver_function_t get_func);
 
sl_status_t
  attribute_resolver_set_attribute_depth(attribute_store_type_t node_type,
                                         int depth);
 
void attribute_resolver_pause_node_resolution(attribute_store_node_t node);
 
void attribute_resolver_resume_node_resolution(attribute_store_node_t node);
 
void attribute_resolver_set_resolution_listener(
  attribute_store_node_t node, attribute_resolver_callback_t callback);
 
void attribute_resolver_clear_resolution_listener(
  attribute_store_node_t node, attribute_resolver_callback_t callback);
 
void attribute_resolver_set_resolution_give_up_listener(
  attribute_store_type_t node_type, attribute_resolver_callback_t callback);
 
void attribute_resolver_set_resolution_resumption_listener(
  attribute_store_node_t node, attribute_resolver_callback_t callback);
 
void attribute_resolver_clear_resolution_resumption_listener(
  attribute_store_node_t node, attribute_resolver_callback_t callback);
 
sl_status_t
  attribute_resolver_restart_set_resolution(attribute_store_node_t node);
 
sl_status_t
  attribute_resolver_restart_get_resolution(attribute_store_node_t node);
 
attribute_resolver_config_t attribute_resolver_get_config();
 
bool attribute_resolver_node_or_child_needs_resolution(
  attribute_store_node_t node);
 
bool is_node_or_parent_paused(attribute_store_node_t node);
 
bool is_node_pending_set_resolution(attribute_store_node_t node);
 
void attribute_resolver_state_log();
 
#ifdef __cplusplus
}
#endif
 
#endif  //ATTRIBUTE_RESOLVER_H