3b6bb15e86
d9b8fa6098d fix: Fake broadcast address for 127.x.x.x aa649165a57 chore: Add code for future netprof TCP testing 9e5693de5ac chore: add to_string functions for netprof enums 52d915e6a90 cleanup: Heap allocate network profile objects 80fabd4a729 feat: Implement Tox network profiler 05abe083cb6 cleanup: Some random cleanups, mostly related to mem. 5cca24513b8 cleanup: Check that onion IP/Port packing worked. e092ecd1244 cleanup: Use tox memory allocator in some more places. 3cfe41c7587 fix: Avoid `memcpy`-ing structs into onion ping id data. e32ac001938 fix: Add more information on why the frame was not sent. ab887003687 fix: Allow TCP connections to fail `connect` calls. 7603170e663 refactor: Use tox memory in group connection allocations. 5bd8a85eb89 cleanup: Align internal logger with external on type of source line. e9bf524d9e1 cleanup: Add missing `#include` to sort_test.cc. d10c966b998 feat: Add `to_string` functions for toxencryptsave errors. 7bfd0dc8003 docs: Update the docs for group join functions 380dde9f2ae test: Add more logging to TCP connection constructor. 0f12f384c8c cleanup: Reduce stack frame sizes to below 4096 bytes. bc43cec0626 chore: Happy new year! fbe78f1702e cleanup: Add a `TOX_HIDE_DEPRECATED` check to hide deprecated symbols. 44d9da07e77 refactor: Use tox memory for group moderation/pack allocations. 7f26d520168 refactor: Use tox memory in group chats allocations. 2f62f3d0e77 refactor: Use tox Memory for group allocations. 8a968162041 chore: Add dispatch/events headers to bazel export. 2bbfb35abf6 docs: Output the error code string instead of int. in toxav logging d55d0e4eaef cleanup: Remove redundant code for checking if group exists 2a6dc643338 chore: Upgrade dependencies for websockify. fc0650601c1 fix: Allow peers to reconnect to group chats using a password git-subtree-dir: external/toxcore/c-toxcore git-subtree-split: d9b8fa6098de6c074038b6664d2572627540b148
107 lines
3.8 KiB
C
107 lines
3.8 KiB
C
/* SPDX-License-Identifier: GPL-3.0-or-later
|
|
* Copyright © 2016-2020 The TokTok team.
|
|
* Copyright © 2014 Tox project.
|
|
*/
|
|
#ifndef C_TOXCORE_TOXCORE_MONO_TIME_H
|
|
#define C_TOXCORE_TOXCORE_MONO_TIME_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#include "attributes.h"
|
|
#include "mem.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* The timer portion of the toxcore event loop.
|
|
*
|
|
* We update the time exactly once per tox_iterate call. Programs built on lower
|
|
* level APIs such as the DHT bootstrap node must update the time manually in
|
|
* each iteration.
|
|
*
|
|
* Time is kept per Tox instance, not globally, even though "time" as a concept
|
|
* is global. This is because by definition `mono_time` represents the time at
|
|
* the start of an iteration, and also by definition the time when all network
|
|
* events for the current iteration occurred. This affects mainly two situations:
|
|
*
|
|
* 1. Two timers started in the same iteration: e.g. two timers set to expire in
|
|
* 10 seconds will both expire at the same time, i.e. about 10 seconds later.
|
|
* If the time were global, `mono_time` would be a random number that is
|
|
* either the time at the start of an iteration, or 1 second later (since the
|
|
* timer resolution is 1 second). This can happen when one update happens at
|
|
* e.g. 10:00:00.995 and a few milliseconds later a concurrently running
|
|
* instance updates the time at 10:00:01.005, making one timer expire a
|
|
* second after the other.
|
|
* 2. One timer based on an event: if we want to encode a behaviour of a timer
|
|
* expiring e.g. 10 seconds after a network event occurred, we simply start a
|
|
* timer in the event handler. If a concurrent instance updates the time
|
|
* underneath us, it may instead expire 9 seconds after the event.
|
|
*
|
|
* Both these situations cause incorrect behaviour randomly. In practice,
|
|
* toxcore is somewhat robust against strange timer behaviour, but the
|
|
* implementation should at least theoretically match the specification.
|
|
*/
|
|
typedef struct Mono_Time Mono_Time;
|
|
|
|
typedef uint64_t mono_time_current_time_cb(void *user_data);
|
|
|
|
non_null(1) nullable(2, 3)
|
|
Mono_Time *mono_time_new(const Memory *mem, mono_time_current_time_cb *current_time_callback, void *user_data);
|
|
|
|
non_null(1) nullable(2)
|
|
void mono_time_free(const Memory *mem, Mono_Time *mono_time);
|
|
|
|
/**
|
|
* Update mono_time; subsequent calls to mono_time_get or mono_time_is_timeout
|
|
* will use the time at the call to mono_time_update.
|
|
*/
|
|
non_null()
|
|
void mono_time_update(Mono_Time *mono_time);
|
|
|
|
/** @brief Return current monotonic time in milliseconds (ms).
|
|
*
|
|
* The starting point is UNIX epoch as measured by `time()` in `mono_time_new()`.
|
|
*/
|
|
non_null()
|
|
uint64_t mono_time_get_ms(const Mono_Time *mono_time);
|
|
|
|
/** @brief Return a monotonically increasing time in seconds.
|
|
*
|
|
* The starting point is UNIX epoch as measured by `time()` in `mono_time_new()`.
|
|
*/
|
|
non_null()
|
|
uint64_t mono_time_get(const Mono_Time *mono_time);
|
|
|
|
/**
|
|
* Return true iff timestamp is at least timeout seconds in the past.
|
|
*/
|
|
non_null()
|
|
bool mono_time_is_timeout(const Mono_Time *mono_time, uint64_t timestamp, uint64_t timeout);
|
|
|
|
/** @brief Return current monotonic time in milliseconds (ms).
|
|
*
|
|
* The starting point is unspecified and in particular is likely not comparable
|
|
* to the return value of `mono_time_get_ms()`.
|
|
*/
|
|
non_null()
|
|
uint64_t current_time_monotonic(const Mono_Time *mono_time);
|
|
|
|
/**
|
|
* Override implementation of `current_time_monotonic()` (for tests).
|
|
*
|
|
* The caller is obligated to ensure that `current_time_monotonic()` continues
|
|
* to increase monotonically.
|
|
*/
|
|
non_null(1) nullable(2, 3)
|
|
void mono_time_set_current_time_callback(Mono_Time *mono_time,
|
|
mono_time_current_time_cb *current_time_callback, void *user_data);
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* C_TOXCORE_TOXCORE_MONO_TIME_H */
|