Deploying to gh-pages from @ espressif/esp-protocols@6e4d8a19ed 🚀

This commit is contained in:
david-cermak committed 2022-04-26 06:49:12 +00:00
1 parent e58a43b69a
commit 1c1a22890a
7 files changed
+15 -7

No files matched your search

+1 -1
View File
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 2338c15411746b8e6777a14bc705e758
config: e8cae2279d8f317a1b14b193de176564
tags: 549b3d6d0415232fb7e35403b330ff49
+3 -1
View File
@@ -163,7 +163,7 @@
<a href="https://github.com/espressif/esp-docs/blob/6e5bede/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/6e4d8a1/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
@@ -286,6 +286,8 @@
<li><a href="index.html#_CPPv4N26esp_websocket_event_data_t8data_lenE">esp_websocket_event_data_t::data_len (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N26esp_websocket_event_data_t8data_ptrE">esp_websocket_event_data_t::data_ptr (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N26esp_websocket_event_data_t3finE">esp_websocket_event_data_t::fin (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N26esp_websocket_event_data_t7op_codeE">esp_websocket_event_data_t::op_code (C++ member)</a>
</li>
+9 -3
View File
@@ -191,7 +191,7 @@
<a href="https://github.com/espressif/esp-docs/blob/6e5bede/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/6e4d8a1/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
@@ -314,7 +314,7 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
</section>
<section id="application-example">
<h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this headline"></a></h2>
<p>A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the <a class="reference external" href="https://websocket.org">websocket.org</a> server can be found here: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/6e5bede/examples/../examples">example </a>.</p>
<p>A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the <a class="reference external" href="https://websocket.org">websocket.org</a> server can be found here: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/6e4d8a1/examples/../examples">example </a>.</p>
<section id="sending-text-data">
<h3>Sending Text Data<a class="headerlink" href="#sending-text-data" title="Permalink to this headline"></a></h3>
<p>The WebSocket client supports sending data as a text data frame, which informs the application layer that the payload data is text data encoded as UTF-8. Example:</p>
@@ -328,7 +328,7 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
<section id="header-file">
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/6e5bede/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/6e4d8a1/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
</ul>
</section>
<section id="functions">
@@ -576,6 +576,12 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
<dd><p>Data length </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_websocket_event_data_t3finE">
<span id="_CPPv3N26esp_websocket_event_data_t3finE"></span><span id="_CPPv2N26esp_websocket_event_data_t3finE"></span><span id="esp_websocket_event_data_t::fin__b"></span><span class="target" id="structesp__websocket__event__data__t_1a34e3831399dbc1d9ed526b63528eac29"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">fin</span></span></span><a class="headerlink" href="#_CPPv4N26esp_websocket_event_data_t3finE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Fin flag </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_websocket_event_data_t7op_codeE">
<span id="_CPPv3N26esp_websocket_event_data_t7op_codeE"></span><span id="_CPPv2N26esp_websocket_event_data_t7op_codeE"></span><span id="esp_websocket_event_data_t::op_code__uint8_t"></span><span class="target" id="structesp__websocket__event__data__t_1aeba7476e8b18de266426a6d345fa530c"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">op_code</span></span></span><a class="headerlink" href="#_CPPv4N26esp_websocket_event_data_t7op_codeE" title="Permalink to this definition"></a><br /></dt>
Binary file not shown.
+1 -1
View File
@@ -165,7 +165,7 @@
<a href="https://github.com/espressif/esp-docs/blob/6e5bede/docs/en/search" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/6e4d8a1/docs/en/search" class="fa fa-github"> Edit on GitHub</a>
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,sphinx:56},filenames:["index.rst"],objects:{"":[[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE","WEBSOCKET_EVENT_ANY"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t22WEBSOCKET_EVENT_CLOSEDE","WEBSOCKET_EVENT_CLOSED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t25WEBSOCKET_EVENT_CONNECTEDE","WEBSOCKET_EVENT_CONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t20WEBSOCKET_EVENT_DATAE","WEBSOCKET_EVENT_DATA"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t28WEBSOCKET_EVENT_DISCONNECTEDE","WEBSOCKET_EVENT_DISCONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t21WEBSOCKET_EVENT_ERRORE","WEBSOCKET_EVENT_ERROR"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE","WEBSOCKET_EVENT_MAX"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_SSLE","WEBSOCKET_TRANSPORT_OVER_SSL"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_TCPE","WEBSOCKET_TRANSPORT_OVER_TCP"],[0,0,1,"_CPPv4N25esp_websocket_transport_t27WEBSOCKET_TRANSPORT_UNKNOWNE","WEBSOCKET_TRANSPORT_UNKNOWN"],[0,1,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close"],[0,2,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close::client"],[0,2,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close::timeout"],[0,1,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::client"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::code"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::data"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::len"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::timeout"],[0,3,1,"_CPPv429esp_websocket_client_config_t","esp_websocket_client_config_t"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11buffer_sizeE","esp_websocket_client_config_t::buffer_size"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8cert_lenE","esp_websocket_client_config_t::cert_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8cert_pemE","esp_websocket_client_config_t::cert_pem"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11client_certE","esp_websocket_client_config_t::client_cert"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t15client_cert_lenE","esp_websocket_client_config_t::client_cert_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t10client_keyE","esp_websocket_client_config_t::client_key"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t14client_key_lenE","esp_websocket_client_config_t::client_key_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t22disable_auto_reconnectE","esp_websocket_client_config_t::disable_auto_reconnect"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t23disable_pingpong_disconE","esp_websocket_client_config_t::disable_pingpong_discon"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t7headersE","esp_websocket_client_config_t::headers"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4hostE","esp_websocket_client_config_t::host"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t7if_nameE","esp_websocket_client_config_t::if_name"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t16keep_alive_countE","esp_websocket_client_config_t::keep_alive_count"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17keep_alive_enableE","esp_websocket_client_config_t::keep_alive_enable"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t15keep_alive_idleE","esp_websocket_client_config_t::keep_alive_idle"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t19keep_alive_intervalE","esp_websocket_client_config_t::keep_alive_interval"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t18network_timeout_msE","esp_websocket_client_config_t::network_timeout_ms"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8passwordE","esp_websocket_client_config_t::password"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4pathE","esp_websocket_client_config_t::path"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17ping_interval_secE","esp_websocket_client_config_t::ping_interval_sec"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t20pingpong_timeout_secE","esp_websocket_client_configLine truncated
Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,sphinx:56},filenames:["index.rst"],objects:{"":[[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE","WEBSOCKET_EVENT_ANY"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t22WEBSOCKET_EVENT_CLOSEDE","WEBSOCKET_EVENT_CLOSED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t25WEBSOCKET_EVENT_CONNECTEDE","WEBSOCKET_EVENT_CONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t20WEBSOCKET_EVENT_DATAE","WEBSOCKET_EVENT_DATA"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t28WEBSOCKET_EVENT_DISCONNECTEDE","WEBSOCKET_EVENT_DISCONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t21WEBSOCKET_EVENT_ERRORE","WEBSOCKET_EVENT_ERROR"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE","WEBSOCKET_EVENT_MAX"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_SSLE","WEBSOCKET_TRANSPORT_OVER_SSL"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_TCPE","WEBSOCKET_TRANSPORT_OVER_TCP"],[0,0,1,"_CPPv4N25esp_websocket_transport_t27WEBSOCKET_TRANSPORT_UNKNOWNE","WEBSOCKET_TRANSPORT_UNKNOWN"],[0,1,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close"],[0,2,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close::client"],[0,2,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close::timeout"],[0,1,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::client"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::code"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::data"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::len"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::timeout"],[0,3,1,"_CPPv429esp_websocket_client_config_t","esp_websocket_client_config_t"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11buffer_sizeE","esp_websocket_client_config_t::buffer_size"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8cert_lenE","esp_websocket_client_config_t::cert_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8cert_pemE","esp_websocket_client_config_t::cert_pem"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11client_certE","esp_websocket_client_config_t::client_cert"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t15client_cert_lenE","esp_websocket_client_config_t::client_cert_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t10client_keyE","esp_websocket_client_config_t::client_key"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t14client_key_lenE","esp_websocket_client_config_t::client_key_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t22disable_auto_reconnectE","esp_websocket_client_config_t::disable_auto_reconnect"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t23disable_pingpong_disconE","esp_websocket_client_config_t::disable_pingpong_discon"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t7headersE","esp_websocket_client_config_t::headers"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4hostE","esp_websocket_client_config_t::host"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t7if_nameE","esp_websocket_client_config_t::if_name"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t16keep_alive_countE","esp_websocket_client_config_t::keep_alive_count"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17keep_alive_enableE","esp_websocket_client_config_t::keep_alive_enable"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t15keep_alive_idleE","esp_websocket_client_config_t::keep_alive_idle"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t19keep_alive_intervalE","esp_websocket_client_config_t::keep_alive_interval"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t18network_timeout_msE","esp_websocket_client_config_t::network_timeout_ms"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8passwordE","esp_websocket_client_config_t::password"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4pathE","esp_websocket_client_config_t::path"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17ping_interval_secE","esp_websocket_client_config_t::ping_interval_sec"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t20pingpong_timeout_secE","esp_websocket_client_configLine truncated