From a585a2778e0540e7e2514796c42da8287a77e190 Mon Sep 17 00:00:00 2001 From: allen Date: Thu, 10 Oct 2019 19:43:17 +0800 Subject: add note for non-blocking file descriptor used for json_loadfd --- doc/apiref.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/apiref.rst b/doc/apiref.rst index 3c4fa47..cdd2058 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 also note that this function cannot be used on + non-blocking file descriptors (such as 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. -- cgit v1.1