Skip to content

Commit

Permalink
fix ToxAV threading documentation
Browse files Browse the repository at this point in the history
ToxAV is not thread-safe at the moment, remove that claim from the
header file.
  • Loading branch information
sudden6 committed Jan 2, 2020
1 parent 1b7d7b6 commit 683bc80
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions toxav/toxav.api.h
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ extern "C" {

/** \subsection threading Threading implications
*
* Unlike the Core API, this API is fully thread-safe. The library will ensure
* the proper synchronization of parallel calls.
* Only ${toxAV.iterate} is thread-safe, all other functions must run from the
* tox thread.
*
* A common way to run ToxAV (multiple or single instance) is to have a thread,
* separate from tox instance thread, running a simple ${toxAV.iterate} loop,
Expand Down
4 changes: 2 additions & 2 deletions toxav/toxav.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ extern "C" {
*/
/** \subsection threading Threading implications
*
* Unlike the Core API, this API is fully thread-safe. The library will ensure
* the proper synchronization of parallel calls.
* Only toxav_iterate is thread-safe, all other functions must run from the
* tox thread.
*
* A common way to run ToxAV (multiple or single instance) is to have a thread,
* separate from tox instance thread, running a simple toxav_iterate loop,
Expand Down

0 comments on commit 683bc80

Please sign in to comment.