shared_offline.h

Go to the documentation of this file.

/* Copyright 2020 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef _SHARED_OFFLINE_H_
#define _SHARED_OFFLINE_H_
 
#include <stdint.h>
#include <stdbool.h>
 
typedef enum
{
    SHARED_OFFLINE_RES_OK = 0,
    SHARED_OFFLINE_RES_NO_MORE_ROOM = 1,
    SHARED_OFFLINE_RES_WRONG_ID = 2,
    /* Module is not initialized */
    SHARED_OFFLINE_RES_UNINITIALIZED = 3,
    /* Stack is already online */
    SHARED_OFFLINE_RES_ALREADY_ONLINE = 4,
    /* Role is wrong to enter offline */
    SHARED_OFFLINE_RES_WRONG_ROLE = 5
} shared_offline_res_e;
 
typedef enum
{
    SHARED_OFFLINE_STATUS_OFFLINE = 0,
    SHARED_OFFLINE_STATUS_ONLINE = 1,
    /* Module is not initialized */
    SHARED_OFFLINE_STATUS_UNINITIALIZED = 3,
} shared_offline_status_e;
 
#define SHARED_OFFLINE_INFINITE_DELAY   (uint32_t)(-1)
 
typedef void (*offline_cb_f)(uint32_t delay_s);
 
typedef void (*online_cb_f)(uint32_t delay_from_deadline_s);
 
typedef struct {
    offline_cb_f on_offline_event;
    online_cb_f on_online_event;
} offline_setting_conf_t;
 
shared_offline_res_e Shared_Offline_init(void);
 
shared_offline_res_e Shared_Offline_register(uint8_t * id_p,
                                             offline_setting_conf_t cbs);
 
shared_offline_res_e Shared_Offline_unregister(uint8_t id_p);
 
shared_offline_res_e Shared_Offline_enter_offline_state(uint8_t id,
                                                        uint32_t delay_s);
 
shared_offline_res_e Shared_Offline_enter_online_state(uint8_t id);
 
shared_offline_status_e Shared_Offline_get_status(uint32_t * elapsed_s_p,
                                                  uint32_t * remaining_s_p);
 
 
#endif //_SHARED_OFFLINE_H_