access_reliable.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ACCESS_RELIABLE_H__
#define ACCESS_RELIABLE_H__

#include <stdint.h>
#include "access.h"

#include "utils.h"
#include "nrf_mesh_config_bearer.h"

#define ACCESS_RELIABLE_TIMEOUT_MIN (SEC_TO_US(2))

#define ACCESS_RELIABLE_TIMEOUT_MAX (SEC_TO_US(60))

#define ACCESS_RELIABLE_HOP_PENALTY (MS_TO_US(BEARER_ADV_INT_DEFAULT_MS))

#define ACCESS_RELIABLE_SEGMENT_COUNT_PENALTY MS_TO_US(BEARER_ADV_INT_DEFAULT_MS)

#define ACCESS_RELIABLE_INTERVAL_DEFAULT (MS_TO_US(BEARER_ADV_INT_DEFAULT_MS) * 10)

#define ACCESS_RELIABLE_BACK_OFF_FACTOR (2)

#define ACCESS_RELIABLE_TIMEOUT_MARGIN (MS_TO_US(1))

#define ACCESS_RELIABLE_RETRY_DELAY (MS_TO_US(BEARER_ADV_INT_DEFAULT_MS) * 2)

typedef enum
{
 ACCESS_RELIABLE_TRANSFER_SUCCESS,
 ACCESS_RELIABLE_TRANSFER_TIMEOUT,
 ACCESS_RELIABLE_TRANSFER_CANCELLED
} access_reliable_status_t;

typedef void (*access_reliable_cb_t)(access_model_handle_t model_handle,
 void * p_args,
 access_reliable_status_t status);

typedef struct
{
 access_model_handle_t model_handle;
 access_message_tx_t message;
 access_opcode_t reply_opcode;
 uint32_t timeout;
 access_reliable_cb_t status_cb;
} access_reliable_t;

void access_reliable_init(void);

void access_reliable_cancel_all(void);

uint32_t access_model_reliable_publish(const access_reliable_t * p_reliable);

uint32_t access_model_reliable_cancel(access_model_handle_t model_handle);

void access_reliable_message_rx_cb(access_model_handle_t model_handle, const access_message_rx_t * p_message, void * p_args);

bool access_reliable_model_is_free(access_model_handle_t model_handle);

#endif /* ACCESS_RELIABLE_H__ */