cs_MeshModelMulticastAcked.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Apr 1, 2020
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
 
#pragma once
 
#include <mesh/cs_MeshCommon.h>
#include <third/std/function.h>
#include <util/cs_BitmaskVarSize.h>
 
extern "C" {
#include <access.h>
}
 
class MeshModelMulticastAcked {
public:
    typedef function<void(MeshMsgEvent& msg)> callback_msg_t;
 
    void registerMsgHandler(const callback_msg_t& closure);
 
    void init(uint16_t modelId);
 
    void configureSelf(dsm_handle_t appkeyHandle);
 
    cs_ret_code_t addToQueue(MeshUtil::cs_mesh_queue_item_t& item);
 
    cs_ret_code_t remFromQueue(cs_mesh_model_msg_type_t type, uint16_t id);
 
    void tick(uint32_t tickCount);
 
    void handleMsg(const access_message_rx_t* accessMsg);
 
private:
    const static uint8_t QUEUE_SIZE       = 5;
 
    const static uint8_t QUEUE_INDEX_NONE = 255;
 
    struct __attribute__((__packed__)) cs_multicast_acked_queue_item_t {
        MeshUtil::cs_mesh_queue_item_meta_data_t metaData;
        uint8_t numStoneIds;
        stone_id_t* stoneIdsPtr;
        cs_control_cmd_t controlCommand;
        uint8_t msgSize;
        uint8_t* msgPtr = nullptr;
    };
 
    access_model_handle_t _accessModelHandle = ACCESS_HANDLE_INVALID;
 
    dsm_handle_t _groupAddressHandle         = DSM_HANDLE_INVALID;
 
    callback_msg_t _msgCallback              = nullptr;
 
    cs_multicast_acked_queue_item_t _queue[QUEUE_SIZE];
 
    uint8_t _queueIndexInProgress = QUEUE_INDEX_NONE;
 
    uint8_t _queueIndexNext       = 0;
 
    BitmaskVarSize _ackedStonesBitmask;
 
    TYPIFY(CONFIG_CROWNSTONE_ID) _ownStoneId = 0;
 
    uint16_t _processCallsLeft;
 
    void cancelQueueItem(uint8_t index);
 
    void remQueueItem(uint8_t index);
 
    void processQueue();
 
    int getNextItemInQueue(bool priority);
 
    bool sendMsgFromQueue();
 
    bool prepareForMsg(cs_multicast_acked_queue_item_t* item);
 
    cs_ret_code_t sendMsg(const uint8_t* data, uint16_t len);
 
    void sendReply(const access_message_rx_t* accessMsg, const uint8_t* data, uint16_t len);
 
    void handleReply(MeshMsgEvent& msg);
 
    void checkDone();
 
    void retryMsg();
};