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

Note in documentation about thread safety
All checks were successful
Publish doxygen documentation to seodisparate.com / doxygen-gen-and-publish (push) Successful in 0s
Details

Browse source 
Basically, all functions should be thread-safe unless mentioned
otherwise.
This commit is contained in:
Stephen Seo 2024-01-01 12:25:04 +09:00
parent ad0e62f718
commit f4ed1aa136
1 changed files with 3 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/UDPC.h
View file

@ -6,6 +6,9 @@
/*! /*!
* \file UDPC.h * \file UDPC.h
* \brief Public API for UDPConnection * \brief Public API for UDPConnection
*
* Note that all functions are thread-safe unless mentioned otherwise in the
* function's documentation.
*/ */
#ifndef UDPC_CONNECTION_H #ifndef UDPC_CONNECTION_H
@ -861,8 +864,6 @@ UDPC_EXPORT const char *UDPC_atostr(UDPC_HContext ctx, UDPC_IPV6_ADDR_TYPE addr)
* \warning The returned pointer must be freed with free(), or * \warning The returned pointer must be freed with free(), or
* UDPC_atostr_unsafe_free(), or UDPC_atostr_unsafe_free_ptr(). * UDPC_atostr_unsafe_free(), or UDPC_atostr_unsafe_free_ptr().
* *
* This function is thread-safe.
*
* UDPC internally uses UDPC_atostr() for logging. This means that while UDPC * UDPC internally uses UDPC_atostr() for logging. This means that while UDPC
* is running, a string created with UDPC_atostr() may be overwritten * is running, a string created with UDPC_atostr() may be overwritten
* eventually by UDPC. To avoid this situation, UDPC_atostr_unsafe() or * eventually by UDPC. To avoid this situation, UDPC_atostr_unsafe() or
@ -879,8 +880,6 @@ UDPC_EXPORT const char *UDPC_atostr_unsafe(UDPC_IPV6_ADDR_TYPE addr);
* \warning The returned pointer must be freed with free(), or * \warning The returned pointer must be freed with free(), or
* UDPC_atostr_unsafe_free(), or UDPC_atostr_unsafe_free_ptr(). * UDPC_atostr_unsafe_free(), or UDPC_atostr_unsafe_free_ptr().
* *
* This function is thread-safe.
*
* UDPC internally uses UDPC_atostr() for logging. This means that while UDPC * UDPC internally uses UDPC_atostr() for logging. This means that while UDPC
* is running, a string created with UDPC_atostr() may be overwritten * is running, a string created with UDPC_atostr() may be overwritten
* eventually by UDPC. To avoid this situation, UDPC_atostr_unsafe() or * eventually by UDPC. To avoid this situation, UDPC_atostr_unsafe() or
@ -891,8 +890,6 @@ UDPC_EXPORT const char *UDPC_atostr_unsafe_cid(UDPC_ConnectionId cid);
/*! /*!
* \brief Free an addr string created with UDPC_atostr_unsafe(). * \brief Free an addr string created with UDPC_atostr_unsafe().
*
* This function is thread-safe.
*/ */
UDPC_EXPORT void UDPC_atostr_unsafe_free(const char *addrBuf); UDPC_EXPORT void UDPC_atostr_unsafe_free(const char *addrBuf);
@ -900,8 +897,6 @@ UDPC_EXPORT void UDPC_atostr_unsafe_free(const char *addrBuf);
* \brief Free an addr string created with UDPC_atostr_unsafe() and zeroes the * \brief Free an addr string created with UDPC_atostr_unsafe() and zeroes the
* pointer. * pointer.
* *
* This function is thread-safe.
*
* \code{.c} * \code{.c}
* UDPC_ConnectionId aConnectionId = ...; * UDPC_ConnectionId aConnectionId = ...;
* const char *addrString = UDPC_atostr_unsafe_cid(aConnectionId); * const char *addrString = UDPC_atostr_unsafe_cid(aConnectionId);