core.h

Go to the documentation of this file.

/*
 * Copyright 2023-2025 AVSystem <avsystem@avsystem.com>
 * AVSystem Anjay Lite LwM2M SDK
 * All rights reserved.
 *
 * Licensed under AVSystem Anjay Lite LwM2M Client SDK - Non-Commercial License.
 * See the attached LICENSE file for details.
 */
 
#include <anj/init.h>
 
#ifndef ANJ_CORE_H
#    define ANJ_CORE_H
 
#    include <anj/compat/net/anj_net_api.h>
#    include <anj/defs.h>
#    include <anj/dm/core.h>
 
#    define ANJ_INTERNAL_INCLUDE_EXCHANGE
#    include <anj_internal/exchange.h> // IWYU pragma: export
#    undef ANJ_INTERNAL_INCLUDE_EXCHANGE
#    ifdef ANJ_WITH_BOOTSTRAP
#        define ANJ_INTERNAL_INCLUDE_BOOTSTRAP
#        include <anj_internal/bootstrap.h> // IWYU pragma: export
#        undef ANJ_INTERNAL_INCLUDE_BOOTSTRAP
#    endif // ANJ_WITH_BOOTSTRAP
#    ifdef ANJ_WITH_LWM2M_SEND
#        include <anj/lwm2m_send.h>
#    endif // ANJ_WITH_LWM2M_SEND
 
#    ifdef __cplusplus
extern "C" {
#    endif
 
#    if defined(ANJ_COAP_WITH_TCP) && defined(ANJ_COAP_WITH_UDP)
#        define ANJ_SUPPORTED_BINDING_MODES "UT"
#    elif defined(ANJ_COAP_WITH_TCP)
#        define ANJ_SUPPORTED_BINDING_MODES "T"
#    else
#        define ANJ_SUPPORTED_BINDING_MODES "U"
#    endif
 
typedef enum {
    ANJ_CONN_STATUS_INITIAL,
 
    ANJ_CONN_STATUS_INVALID,
 
    ANJ_CONN_STATUS_FAILURE,
 
    ANJ_CONN_STATUS_BOOTSTRAPPING,
 
    ANJ_CONN_STATUS_BOOTSTRAPPED,
 
    ANJ_CONN_STATUS_REGISTERING,
 
    ANJ_CONN_STATUS_REGISTERED,
 
    ANJ_CONN_STATUS_SUSPENDED,
 
    ANJ_CONN_STATUS_ENTERING_QUEUE_MODE,
 
    ANJ_CONN_STATUS_QUEUE_MODE,
} anj_conn_status_t;
 
typedef enum {
    ANJ_CORE_CHANGE_TYPE_VALUE_CHANGED = 0,
 
    ANJ_CORE_CHANGE_TYPE_ADDED = 1,
 
    ANJ_CORE_CHANGE_TYPE_DELETED = 2
} anj_core_change_type_t;
 
typedef void anj_connection_status_callback_t(void *arg,
                                              anj_t *anj,
                                              anj_conn_status_t conn_status);
 
typedef struct anj_configuration_struct {
    const char *endpoint_name;
 
    anj_connection_status_callback_t *connection_status_cb;
 
    void *connection_status_cb_arg;
 
    bool queue_mode_enabled;
 
    anj_time_duration_t queue_mode_timeout;
 
    const anj_net_socket_configuration_t *net_socket_cfg;
 
    const anj_exchange_udp_tx_params_t *udp_tx_params;
 
    anj_time_duration_t exchange_request_timeout;
#    ifdef ANJ_WITH_BOOTSTRAP
 
    uint16_t bootstrap_retry_count;
 
    anj_time_duration_t bootstrap_retry_timeout;
 
    anj_time_duration_t bootstrap_timeout;
#    endif // ANJ_WITH_BOOTSTRAP
} anj_configuration_t;
 
int anj_core_init(anj_t *anj, const anj_configuration_t *config);
 
void anj_core_step(anj_t *anj);
 
anj_time_duration_t anj_core_next_step_time(anj_t *anj);
 
void anj_core_server_obj_disable_executed(anj_t *anj, uint32_t timeout);
 
void anj_core_server_obj_registration_update_trigger_executed(anj_t *anj);
 
void anj_core_server_obj_bootstrap_request_trigger_executed(anj_t *anj);
 
void anj_core_data_model_changed(anj_t *anj,
                                 const anj_uri_path_t *path,
                                 anj_core_change_type_t change_type);
 
void anj_core_disable_server(anj_t *anj, anj_time_duration_t timeout);
 
void anj_core_request_bootstrap(anj_t *anj);
 
void anj_core_restart(anj_t *anj);
 
void anj_core_request_update(anj_t *anj);
 
int anj_core_shutdown(anj_t *anj);
 
#    define ANJ_INTERNAL_INCLUDE_CORE
#    include <anj_internal/core.h> // IWYU pragma: export
#    undef ANJ_INTERNAL_INCLUDE_CORE
#    ifdef __cplusplus
}
#    endif
 
#endif // ANJ_CORE_H