ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

http_static: web app doc update

Browse Source 
Type: docs
Change-Id: I0d3395c1de51c086b2ac68cd92c97efe36665b62
Signed-off-by: Matus Fabian <matfabia@cisco.com>
This commit is contained in:
Matus Fabian
2024-08-01 16:36:44 +02:00
committed by Florin Coras
parent 119cbf2651
commit a67da25008
1 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/usecases/webapp.rst
View File

@ -19,8 +19,7 @@ why returning data in .json format tends to work out pretty well.
:: ::
static int static int
handle_get_status (http_builtin_method_type_t reqtype, handle_get_status (hss_url_handler_args_t *args)
u8 * request, http_session_t * hs)
{ {
my_main_t *mm = &my_main; my_main_t *mm = &my_main;
u8 *s = 0; u8 *s = 0;
@ -34,11 +33,11 @@ why returning data in .json format tends to work out pretty well.
s = format (s, "}}"); s = format (s, "}}");
/* And tell the static server plugin how to send the results */ /* And tell the static server plugin how to send the results */
hs->data = s; args->data = s;
hs->data_offset = 0; args->data_len = vec_len (s);
hs->cache_pool_index = ~0; args->ct = HTTP_CONTENT_APP_JSON;
hs->free_data = 1; /* free s when done with it, in the framework */ args->free_vec_data = 1; /* free s when done with it, in the framework */
return 0; return HSS_URL_HANDLER_OK;
} }
Words to the Wise: Chrome has a very nice set of debugging tools. Select Words to the Wise: Chrome has a very nice set of debugging tools. Select
@ -53,7 +52,7 @@ considerable amount of time debugging .json bugs.
Step 2: Register URL handlers with the server Step 2: Register URL handlers with the server
--------------------------------------------- ---------------------------------------------
Call http_static_server_register_builtin_handler() as shown. It’s likely Call ``hss_register_url_handler`` as shown. It’s likely
but not guaranteed that the static server plugin will be available. but not guaranteed that the static server plugin will be available.
:: ::
@ -65,7 +64,7 @@ but not guaranteed that the static server plugin will be available.
/* Look up the builtin URL registration handler */ /* Look up the builtin URL registration handler */
fp = vlib_get_plugin_symbol ("http_static_plugin.so", fp = vlib_get_plugin_symbol ("http_static_plugin.so",
"http_static_server_register_builtin_handler"); "hss_register_url_handler");
if (fp == 0) if (fp == 0)
{ {
@ -259,7 +258,7 @@ above:
:: ::
http static server www-root /myhugosite/public uri tcp://0.0.0.0/2345 cache-size 5m fifo-size 8192 http static server url-handlers www-root /myhugosite/public uri tcp://0.0.0.0/2345 cache-size 5m fifo-size 8192
The www-root must be specified, and must correctly name the compiled The www-root must be specified, and must correctly name the compiled
hugo site root. If your Hugo site is located at /myhugosite, specify hugo site root. If your Hugo site is located at /myhugosite, specify