[incubator-nuttx-apps] branch master updated: webclient: Distinguish request size and buffer size in body callback

[xi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx-apps.git


The following commit(s) were added to refs/heads/master by this push:
     new 73fb7ba  webclient: Distinguish request size and buffer size in body callback
73fb7ba is described below

commit 73fb7baa0509d039f73777d68c21b4b557a178e5
Author: YAMAMOTO Takashi <ya...@midokura.com>
AuthorDate: Fri Nov 20 09:50:11 2020 +0900

    webclient: Distinguish request size and buffer size in body callback
    
    This fixes the case when webclient_set_static_body is used
    for data larger than webclient_context::buflen.
    
    Note: as of writing this, webclient_set_static_body is the
    only user of body_callback in NuttX apps tree.
---
 include/netutils/webclient.h   | 22 ++++++++++++++++------
 netutils/webclient/webclient.c |  3 +++
 2 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/include/netutils/webclient.h b/include/netutils/webclient.h
index 5dd3dd4..7aaa5d7 100644
--- a/include/netutils/webclient.h
+++ b/include/netutils/webclient.h
@@ -129,8 +129,10 @@ typedef CODE int (*webclient_sink_callback_t)(FAR char **buffer, int offset,
  * An implementation of this callback should perform either of
  * the followings:
  *
- * - fill the buffer (specified by buffer and *sizep) with the data
- * - update *datap with a buffer filled with the data
+ * - Fill the buffer (specified by buffer and *sizep) with the data
+ *
+ * - Update *datap with a buffer filled with the data. In this case,
+ *   it can return more than the amount specified *sizep.
  *
  * Either ways, it should update *sizep to the size of the data.
  *
@@ -138,10 +140,17 @@ typedef CODE int (*webclient_sink_callback_t)(FAR char **buffer, int offset,
  * again to provide the remaining data.
  *
  * Input Parameters:
- *   buffer - The buffer to fill.
- *   sizep  - The size of buffer/data in bytes.
- *   datap  - The data to return.
- *   ctx    - The value of webclient_context::body_callback_arg.
+ *   buffer  - The buffer to fill.
+ *   sizep   - The size of buffer/data in bytes.
+ *   datap   - The data to return.
+ *   reqsize - The requested size.
+ *             Note: This can be larger than *sizep.
+ *             The callback can choose either of:
+ *               * return more than *sizep data by updating *datap
+ *                 with a large enough buffer
+ *               * or, just return up to *sizep. (For the rest of data,
+ *                 the callback will be called again later.)
+ *   ctx     - The value of webclient_context::body_callback_arg.
  *
  * Return value:
  *   0 on success.
@@ -152,6 +161,7 @@ typedef CODE int (*webclient_body_callback_t)(
     FAR void *buffer,
     FAR size_t *sizep,
     FAR const void * FAR *datap,
+    size_t reqsize,
     FAR void *ctx);
 
 struct webclient_tls_connection;
diff --git a/netutils/webclient/webclient.c b/netutils/webclient/webclient.c
index c744938..45cd91d 100644
--- a/netutils/webclient/webclient.c
+++ b/netutils/webclient/webclient.c
@@ -293,9 +293,11 @@ static void conn_close(struct webclient_context *ctx, struct conn *conn)
 static int webclient_static_body_func(FAR void *buffer,
                                       FAR size_t *sizep,
                                       FAR const void * FAR *datap,
+                                      size_t reqsize,
                                       FAR void *ctx)
 {
   *datap = ctx;
+  *sizep = reqsize;
   return 0;
 }
 
@@ -851,6 +853,7 @@ int webclient_perform(FAR struct webclient_context *ctx)
               ret = ctx->body_callback(ws->buffer,
                                        &input_buffer_size,
                                        &input_buffer,
+                                       todo,
                                        ctx->body_callback_arg);
               if (ret < 0)
                 {