Green Sky
a3126d581b
82460b212 feat: add ngc events 24b54722a fix: Ensure we have allocators available for the error paths. 48dbcfebc cleanup: Remove redundant `-DSODIUM_EXPORT` from definitions. 0cef46ee9 cleanup: Fix a few more clang-tidy warnings. 0c5b918e9 cleanup: Fix a few more clang-tidy warnings. 4d3c97f49 cleanup: Enforce stricter identifier naming using clang-tidy. a549807df refactor: Add `mem` module to allow tests to override allocators. 6133fb153 chore: Add devcontainer setup for codespaces. 620e07ecd chore: Set a timeout for tests started using Conan c0ec33b16 chore: Migrate Windows CI from Appveyor to Azure DevOps 8ed47f3ef fix incorrect documentation a1e245841 docs: Fix doxygen config and remove some redundant comments. b0f633185 chore: Fix the Android CI job 7469a529b fix: Add missing `#include <array>`. 2b1a6b0d2 add missing ngc constants getter declarations and definitions 2e02d5637 chore: Add missing module dependencies. REVERT: 67badf694 feat: add ngc events git-subtree-dir: external/toxcore/c-toxcore git-subtree-split: 82460b2124216af1ac9d63060de310a682a2fd15
67 lines
1.7 KiB
C
67 lines
1.7 KiB
C
/* 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 "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.
|
|
*/
|
|
non_null()
|
|
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.
|
|
*/
|
|
non_null()
|
|
int32_t ping_array_check(Ping_Array *array, const Mono_Time *mono_time, uint8_t *data, size_t length,
|
|
uint64_t ping_id);
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif // C_TOXCORE_TOXCORE_PING_ARRAY_H
|