sergiotarxz/nuttx-apps
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

webclient.h: Update the state diagram after the tunnelling stuff

Browse Source
This commit is contained in:
YAMAMOTO Takashi 2022-06-17 15:00:09 +09:00 committed by Xiang Xiao
parent 2be66e83a4
commit 5cfc5cd4f2
1 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
include/netutils/webclient.h
View File

@ -295,13 +295,27 @@ struct webclient_tls_ops
* | | * | |
* webclient_perform * webclient_perform
* | * |
* +---------------+ * |
* | | * +-- non-blocking mode, returns -EAGAIN ---> IN-PROGRESS
* | non-blocking mode, * |
* | returns -EAGAIN * +-- returns -errno ---> DONE
* | | * |
* v v * returns 0
* DONE IN-PROGRESS * |
* +-- !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): * (uninitialized):
* After the memory for webclient_context is allocated, * 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, * If the application wants to reuse the context for another request,
* it should initialize it with webclient_set_defaults() again. * 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 struct webclient_context