stephenseo/UDPConnection
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages 1 Wiki Activity Actions

Add note in docs about update for UDPC_init(...)
All checks were successful
Publish doxygen documentation to seodisparate.com / doxygen-gen-and-publish (push) Successful in 0s
Details

Browse source
This commit is contained in:
Stephen Seo 2024-01-12 13:31:36 +09:00
parent 894a564774
commit 02651c793e
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/UDPC.h
View file

@ -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(). * \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 * \return A UDPC context
*/ */
UDPC_EXPORT UDPC_HContext UDPC_init(UDPC_ConnectionId listenId, int isClient, int isUsingLibsodium); UDPC_EXPORT UDPC_HContext UDPC_init(UDPC_ConnectionId listenId, int isClient, int isUsingLibsodium);