mesh_friend.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 MESH_FRIEND_H__
#define MESH_FRIEND_H__

#include <stdint.h>
#include <stdbool.h>
#include "mesh_friendship_types.h"
#include "friend_sublist.h"
#include "friend_queue.h"
#include "core_tx_friend.h"

#define MESH_FRIEND_RECEIVE_WINDOW_MIN_MS (1)

#define MESH_FRIEND_RECEIVE_WINDOW_MAX_MS (255)

#define MESH_FRIEND_RECEIVE_WINDOW_DEFAULT_MS (5)


typedef struct
{
 friend_queue_stats_t queue; 
 friend_sublist_stats_t sublist; 
 core_tx_friend_stats_t bearer; 
} mesh_friend_stats_t;

uint32_t mesh_friend_init(void);

void mesh_friend_enable(void);

void mesh_friend_disable(void);

bool mesh_friend_is_enabled(void);

uint32_t mesh_friend_friendship_terminate(const mesh_friendship_t * p_friendship);

uint32_t mesh_friend_friendship_terminate_all(void);

uint32_t mesh_friend_receive_window_set(uint8_t receive_window_ms);

uint32_t mesh_friend_friendships_get(const mesh_friendship_t ** pp_friendships, uint8_t * p_count);

uint32_t mesh_friend_stats_get(const mesh_friendship_t * p_friendship, mesh_friend_stats_t * p_stats);

#endif /* MESH_FRIEND_H__ */