diff options
author | Petri Lehtinen <petri@digip.org> | 2019-10-17 08:07:02 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-10-17 08:07:02 +0300 |
commit | 92873e9d27f11c333e5d0a40d58c2019d7770d0c (patch) | |
tree | 54a9b0131bf12512b86873124ea22bd7f71184a8 /doc | |
parent | 9e1c37c889dac1319fd1f096ce73f9315842dadd (diff) | |
parent | b403bbba8d161d28ac07d9bef083ccfdd92a0742 (diff) | |
download | jansson-92873e9d27f11c333e5d0a40d58c2019d7770d0c.zip jansson-92873e9d27f11c333e5d0a40d58c2019d7770d0c.tar.gz jansson-92873e9d27f11c333e5d0a40d58c2019d7770d0c.tar.bz2 |
Merge pull request #503 from AllenX2018/loadfd-doc
add note for non-blocking file descriptor used for json_loadfd
Diffstat (limited to 'doc')
-rw-r--r-- | doc/apiref.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/apiref.rst b/doc/apiref.rst index 3c4fa47..eb4706a 100644 --- a/doc/apiref.rst +++ b/doc/apiref.rst @@ -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. |