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
commit 5cfc5cd4f2cb546423ff7bcfc81871f65f7e6d9f
Author: YAMAMOTO Takashi <yamam...@midokura.com>
AuthorDate: Fri Jun 17 15:00:09 2022 +0900
webclient.h: Update the state diagram after the tunnelling stuff
---
include/netutils/webclient.h | 32 +++++++++++++++++++++++++-------
1 file changed, 25 insertions(+), 7 deletions(-)
diff --git a/include/netutils/webclient.h b/include/netutils/webclient.h
index 5d38df82f..33aa4ac93 100644
--- a/include/netutils/webclient.h
+++ b/include/netutils/webclient.h
@@ -295,13 +295,27 @@ struct webclient_tls_ops
* | |
* webclient_perform
* |
- * +---------------+
- * | |
- * | non-blocking mode,
- * | returns -EAGAIN
- * | |
- * v v
- * DONE IN-PROGRESS
+ * |
+ * +-- non-blocking mode, returns -EAGAIN ---> IN-PROGRESS
+ * |
+ * +-- returns -errno ---> DONE
+ * |
+ * returns 0
+ * |
+ * +-- !WEBCLIENT_FLAG_TUNNEL --> DONE
+ * |
+ * +-- WEBCLIENT_FLAG_TUNNEL, http_status 2xx -----> TUNNEL_ESTABLISHED
+ * |
+ * +-- WEBCLIENT_FLAG_TUNNEL, http_status others --> DONE
+ *
+ *
+ * TUNNEL_ESTABLISHED
+ * |
+ * webclient_get_tunnel
+ * |
+ * v
+ * DONE
+ *
*
* (uninitialized):
* After the memory for webclient_context is allocated,
@@ -341,6 +355,10 @@ struct webclient_tls_ops
*
* If the application wants to reuse the context for another request,
* it should initialize it with webclient_set_defaults() again.
+ *
+ * TUNNEL_ESTABLISHED
+ * webclient_get_tunnel() should be called exactly once to return
+ * the established tunnel.
*/
struct webclient_context
