summaryrefslogtreecommitdiff
path: root/protocols/Tox/libtox/src/toxcore/ping.h
diff options
context:
space:
mode:
authorGeorge Hazan <ghazan@miranda.im>2022-07-24 16:44:24 +0300
committerGeorge Hazan <ghazan@miranda.im>2022-07-24 16:44:24 +0300
commite55d071e5485a937efd427d159b76c208cccdcce (patch)
tree48d09dc5cf1df2581fd6471b5ccf1560015fa3a4 /protocols/Tox/libtox/src/toxcore/ping.h
parentf36629f67153bc500c828cf51de31988122a1024 (diff)
fixes #3118 (Update toxcore to 0.2.18)
Diffstat (limited to 'protocols/Tox/libtox/src/toxcore/ping.h')
-rw-r--r--protocols/Tox/libtox/src/toxcore/ping.h16
1 files changed, 12 insertions, 4 deletions
diff --git a/protocols/Tox/libtox/src/toxcore/ping.h b/protocols/Tox/libtox/src/toxcore/ping.h
index 4e8192323a..da8d7f003e 100644
--- a/protocols/Tox/libtox/src/toxcore/ping.h
+++ b/protocols/Tox/libtox/src/toxcore/ping.h
@@ -17,24 +17,32 @@
typedef struct Ping Ping;
-Ping *ping_new(const struct Mono_Time *mono_time, DHT *dht);
+non_null()
+Ping *ping_new(const Mono_Time *mono_time, const Random *rng, DHT *dht);
+nullable(1)
void ping_kill(Ping *ping);
-/** Add nodes to the to_ping list.
+/** @brief Add nodes to the to_ping list.
* All nodes in this list are pinged every TIME_TO_PING seconds
* and are then removed from the list.
* If the list is full the nodes farthest from our public_key are replaced.
* The purpose of this list is to enable quick integration of new nodes into the
* network while preventing amplification attacks.
*
- * return 0 if node was added.
- * return -1 if node was not added.
+ * @retval 0 if node was added.
+ * @retval -1 if node was not added.
*/
+non_null()
int32_t ping_add(Ping *ping, const uint8_t *public_key, const IP_Port *ip_port);
+/** @brief Ping all the valid nodes in the to_ping list every TIME_TO_PING seconds.
+ * This function must be run at least once every TIME_TO_PING seconds.
+ */
+non_null()
void ping_iterate(Ping *ping);
+non_null()
void ping_send_request(Ping *ping, const IP_Port *ipp, const uint8_t *public_key);
#endif // C_TOXCORE_TOXCORE_PING_H