Imported Upstream version 1.46.0

[platform/upstream/nghttp2.git] / doc / nghttp2_session_mem_recv.rst

diff --git a/doc/nghttp2_session_mem_recv.rst b/doc/nghttp2_session_mem_recv.rst
index 4e4d7f7..806acbf 100644 (file)
--- a/doc/nghttp2_session_mem_recv.rst
+++ b/doc/nghttp2_session_mem_recv.rst
@@ -11,7 +11,7 @@ Synopsis
 
     
     Processes data *in* as an input from the remote endpoint.  The
-    *inlen* indicates the number of bytes in the *in*.
+    *inlen* indicates the number of bytes to receive in the *in*.
     
     This function behaves like `nghttp2_session_recv()` except that it
     does not use :type:`nghttp2_recv_callback` to receive data; the
@@ -20,26 +20,26 @@ Synopsis
     are called in the same way as they are in `nghttp2_session_recv()`.
     
     In the current implementation, this function always tries to
-    processes all input data unless either an error occurs or
-    :macro:`NGHTTP2_ERR_PAUSE` is returned from
+    processes *inlen* bytes of input data unless either an error occurs or
+    :macro:`nghttp2_error.NGHTTP2_ERR_PAUSE` is returned from
     :type:`nghttp2_on_header_callback` or
     :type:`nghttp2_on_data_chunk_recv_callback`.  If
-    :macro:`NGHTTP2_ERR_PAUSE` is used, the return value includes the
-    number of bytes which was used to produce the data or frame for the
-    callback.
+    :macro:`nghttp2_error.NGHTTP2_ERR_PAUSE` is used, the return value
+    includes the number of bytes which was used to produce the data or
+    frame for the callback.
     
     This function returns the number of processed bytes, or one of the
     following negative error codes:
     
-    :macro:`NGHTTP2_ERR_NOMEM`
+    :macro:`nghttp2_error.NGHTTP2_ERR_NOMEM`
         Out of memory.
-    :macro:`NGHTTP2_ERR_CALLBACK_FAILURE`
+    :macro:`nghttp2_error.NGHTTP2_ERR_CALLBACK_FAILURE`
         The callback function failed.
-    :macro:`NGHTTP2_ERR_BAD_CLIENT_MAGIC`
+    :macro:`nghttp2_error.NGHTTP2_ERR_BAD_CLIENT_MAGIC`
         Invalid client magic was detected.  This error only returns
         when *session* was configured as server and
         `nghttp2_option_set_no_recv_client_magic()` is not used with
         nonzero value.
-    :macro:`NGHTTP2_ERR_FLOODED`
+    :macro:`nghttp2_error.NGHTTP2_ERR_FLOODED`
         Flooding was detected in this HTTP/2 session, and it must be
         closed.  This is most likely caused by misbehaviour of peer.