FGCOM/jansson
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #503 from AllenX2018/loadfd-doc

Browse Source 
add note for non-blocking file descriptor used for json_loadfd
This commit is contained in:
Petri Lehtinen 2019-10-17 08:07:02 +03:00 committed by GitHub
commit 92873e9d27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/apiref.rst
View File

@ -1333,7 +1333,11 @@ If no error or position information is needed, you can pass *NULL*.
It is important to note that this function can only succeed on stream
file descriptors (such as SOCK_STREAM). Using this function on a
non-stream file descriptor will result in undefined behavior. For
non-stream file descriptors, see instead :func:`json_loadb()`.
non-stream file descriptors, see instead :func:`json_loadb()`. In
addition, please note that this function cannot be used on non-blocking
file descriptors (such as a non-blocking socket). Using this function
on non-blocking file descriptors has a high risk of data loss because
it does not support resuming.
This function requires POSIX and fails on all non-POSIX systems.