BigfootDev/flatbuffers
1
0
Fork 1
mirror of https://github.com/google/flatbuffers.git synced 2026-06-08 22:20:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarified note on multi-threading in the docs.

Browse Source 
Change-Id: Ib36ec71aab02fc66d2a6d0c916ebfa4dd1d0d02f
This commit is contained in:
Wouter van Oortmerssen
2014-11-17 13:14:31 -08:00
parent d6f70cdd7d
commit 0ce53c96c3
2 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/source/CppUsage.md
View File

@@ -291,7 +291,14 @@ file, that you can access as described above.
### Threading
None of the code is thread-safe, by design. That said, since currently a
FlatBuffer is read-only and entirely `const`, reading by multiple threads
is possible.
Reading a FlatBuffer does not touch any memory outside the original buffer,
and is entirely read-only (all const), so is safe to access from multiple
threads even without synchronisation primitives.
Creating a FlatBuffer is not thread safe. All state related to building
a FlatBuffer is contained in a FlatBufferBuilder instance, and no memory
outside of it is touched. To make this thread safe, either do not
share instances of FlatBufferBuilder between threads (recommended), or
manually wrap it in synchronisation primites. There's no automatic way to
accomplish this, by design, as we feel multithreaded construction
of a single buffer will be rare, and synchronisation overhead would be costly.