From 02651c793eb848faf18751fdf40de0bcbb6db9f4 Mon Sep 17 00:00:00 2001 From: Stephen Seo Date: Fri, 12 Jan 2024 13:31:36 +0900 Subject: [PATCH] Add note in docs about update for UDPC_init(...) --- src/UDPC.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/UDPC.h b/src/UDPC.h index 7c73d4f..7c87c69 100644 --- a/src/UDPC.h +++ b/src/UDPC.h @@ -323,6 +323,12 @@ UDPC_EXPORT UDPC_ConnectionId UDPC_create_id_hostname(const char *hostname, uint * * \warning The received UDPC_HContext must be freed with a call to UDPC_destroy(). * + * \note This function creates a context that does not use a separate thread to + * call update periodically. You must call \ref UDPC_update() periodically, + * enable threaded update with \ref UDPC_enable_threaded_update or \ref + * UDPC_enable_threaded_update_ms, or use \ref UDPC_init_threaded_update or + * \ref UDPC_init_threaded_update_ms instead of \ref UDPC_init . + * * \return A UDPC context */ UDPC_EXPORT UDPC_HContext UDPC_init(UDPC_ConnectionId listenId, int isClient, int isUsingLibsodium);