alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-10 04:43:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix broken references to misc API functions and types.

Browse Source
This commit is contained in:
Marius Vikhammer
2022-03-24 14:57:51 +08:00
parent 2cf6399cd5
commit a6543f0d21
52 changed files with 404 additions and 365 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/en/api-reference/protocols/esp_https_server.rst
View File

@@ -23,9 +23,9 @@ The following API of `esp_http_server` should not be used with `esp_https_server
* :cpp:func:`httpd_sess_get_transport_ctx` - returns SSL used for the session
* :cpp:func:`httpd_sess_set_transport_ctx`
* :cpp:func:`httpd_get_global_transport_ctx` - returns the shared SSL context
* :c:member:`httpd_config_t.global_transport_ctx`
* :c:member:`httpd_config_t.global_transport_ctx_free_fn`
* :c:member:`httpd_config_t.open_fn` - used to set up secure sockets
* :cpp:member:`httpd_config::global_transport_ctx`
* :cpp:member:`httpd_config::global_transport_ctx_free_fn`
* :cpp:member:`httpd_config::open_fn` - used to set up secure sockets
Everything else can be used without limitations.
@@ -36,7 +36,7 @@ Please see the example :example:`protocols/https_server` to learn how to set up
Basically all you need is to generate a certificate, embed it in the firmware, and provide its pointers and lengths to the start function via the init struct.
The server can be started with or without SSL by changing a flag in the init struct - :c:member:`httpd_ssl_config.transport_mode`. This could be used e.g. for testing or in trusted environments where you prefer speed over security.
The server can be started with or without SSL by changing a flag in the init struct - :cpp:member:`httpd_ssl_config::transport_mode`. This could be used e.g. for testing or in trusted environments where you prefer speed over security.
Performance
-----------