/* SPDX-License-Identifier: GPL-3.0-or-later
* Copyright © 2016-2018 The TokTok team.
* Copyright © 2013 Tox project.
*/
/** @file
* @brief Implementation of an efficient array to store that we pinged something.
#ifndef C_TOXCORE_TOXCORE_PING_ARRAY_H
#define C_TOXCORE_TOXCORE_PING_ARRAY_H
#include <stddef.h>
#include <stdint.h>
#include "attributes.h"
#include "crypto_core.h"
#include "mem.h"
#include "mono_time.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct Ping_Array Ping_Array;
/**
* @brief Initialize a Ping_Array.
*
* @param size represents the total size of the array and should be a power of 2.
* @param timeout represents the maximum timeout in seconds for the entry.
* @return pointer to allocated Ping_Array on success, nullptr on failure.
non_null()
struct Ping_Array *ping_array_new(const Memory *mem, uint32_t size, uint32_t timeout);
* @brief Free all the allocated memory in a @ref Ping_Array.
nullable(1)
void ping_array_kill(Ping_Array *array);
* @brief Add a data with length to the @ref Ping_Array list and return a ping_id.
* @return ping_id on success, 0 on failure.
uint64_t ping_array_add(Ping_Array *array, const Mono_Time *mono_time, const Random *rng,
const uint8_t *data, uint32_t length);
* @brief Check if @p ping_id is valid and not timed out.
* On success, copies the data into data of length,
* @return length of data copied on success, -1 on failure.
int32_t ping_array_check(Ping_Array *array, const Mono_Time *mono_time, uint8_t *data, size_t length,
uint64_t ping_id);
} /* extern "C" */
#endif /* C_TOXCORE_TOXCORE_PING_ARRAY_H */
