Deploying to gh-pages from @ espressif/esp-protocols@3bf0511938 🚀

2025-08-05 21:54:29 +02:00 · 2023-02-24 08:59:15 +00:00
parent ed80cc49c0
commit 9b4f12475b
15 changed files with 152 additions and 26 deletions
--- a/asio/.buildinfo
+++ b/asio/.buildinfo
@@ -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: 1ab6dfdf454698f7bf7502a427e9423a
+config: 6481ea716ed2d9655cce6caea6803f5d
 tags: 549b3d6d0415232fb7e35403b330ff49
--- a/asio/genindex.html
+++ b/asio/genindex.html
@@ -89,7 +89,7 @@
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
      <li>Index</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/319fce0/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/3bf0511/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
--- a/asio/index.html
+++ b/asio/index.html
@@ -101,7 +101,7 @@
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
      <li>ASIO port</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/319fce0/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/3bf0511/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
@@ -142,12 +142,12 @@ SSL/TLS support is disabled by default and could be enabled in component configu
 </section>
 <section id="application-example">
 <h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this headline"></a></h2>
-<p>ESP examples are based on standard asio <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/319fce0/examples/../examples">examples </a>:</p>
+<p>ESP examples are based on standard asio <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/3bf0511/examples/../examples">examples </a>:</p>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/319fce0/examples/../examples/udp_echo_server">udp_echo_server </a></p></li>
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/319fce0/examples/../examples/tcp_echo_server">tcp_echo_server </a></p></li>
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/319fce0/examples/../examples/asio_chat">asio_chat </a></p></li>
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/319fce0/examples/../examples/ssl_client_server">ssl_client_server </a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/3bf0511/examples/../examples/udp_echo_server">udp_echo_server </a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/3bf0511/examples/../examples/tcp_echo_server">tcp_echo_server </a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/3bf0511/examples/../examples/asio_chat">asio_chat </a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/3bf0511/examples/../examples/ssl_client_server">ssl_client_server </a></p></li>
 </ul>
 <p>Please refer to the specific example README.md for details</p>
 </section>
--- a/esp_modem/.doctrees/environment.pickle
+++ b/esp_modem/.doctrees/environment.pickle
--- a/esp_websocket_client/.buildinfo
+++ b/esp_websocket_client/.buildinfo
@@ -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: 6b5d04138319cf30632fcb0034285227
+config: ad317e982af0c52b41cf4956f154d959
 tags: 549b3d6d0415232fb7e35403b330ff49
--- a/esp_websocket_client/genindex.html
+++ b/esp_websocket_client/genindex.html
@@ -89,7 +89,7 @@
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
      <li>Index</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-docs/blob/319fce0/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-docs/blob/3bf0511/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
@@ -179,8 +179,6 @@
 </li>
      <li><a href="index.html#_CPPv4N29esp_websocket_client_config_t10user_agentE">esp_websocket_client_config_t::user_agent (C++ member)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="index.html#_CPPv4N29esp_websocket_client_config_t12user_contextE">esp_websocket_client_config_t::user_context (C++ member)</a>
 </li>
      <li><a href="index.html#_CPPv4N29esp_websocket_client_config_t8usernameE">esp_websocket_client_config_t::username (C++ member)</a>
@@ -195,6 +193,8 @@
 </li>
      <li><a href="index.html#_CPPv425esp_websocket_client_initPK29esp_websocket_client_config_t">esp_websocket_client_init (C++ function)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="index.html#_CPPv433esp_websocket_client_is_connected29esp_websocket_client_handle_t">esp_websocket_client_is_connected (C++ function)</a>
 </li>
      <li><a href="index.html#_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t">esp_websocket_client_send_bin (C++ function)</a>
@@ -202,6 +202,8 @@
      <li><a href="index.html#_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t">esp_websocket_client_send_text (C++ function)</a>
 </li>
      <li><a href="index.html#_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t">esp_websocket_client_send_with_opcode (C++ function)</a>
+</li>
+      <li><a href="index.html#_CPPv432esp_websocket_client_set_headers29esp_websocket_client_handle_tPKc">esp_websocket_client_set_headers (C++ function)</a>
 </li>
      <li><a href="index.html#_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t">esp_websocket_client_set_ping_interval_sec (C++ function)</a>
 </li>
@@ -210,6 +212,28 @@
      <li><a href="index.html#_CPPv426esp_websocket_client_start29esp_websocket_client_handle_t">esp_websocket_client_start (C++ function)</a>
 </li>
      <li><a href="index.html#_CPPv425esp_websocket_client_stop29esp_websocket_client_handle_t">esp_websocket_client_stop (C++ function)</a>
+</li>
+      <li><a href="index.html#_CPPv427esp_websocket_error_codes_t">esp_websocket_error_codes_t (C++ struct)</a>
+</li>
+      <li><a href="index.html#_CPPv4N27esp_websocket_error_codes_t25esp_tls_cert_verify_flagsE">esp_websocket_error_codes_t::esp_tls_cert_verify_flags (C++ member)</a>
+</li>
+      <li><a href="index.html#_CPPv4N27esp_websocket_error_codes_t20esp_tls_last_esp_errE">esp_websocket_error_codes_t::esp_tls_last_esp_err (C++ member)</a>
+</li>
+      <li><a href="index.html#_CPPv4N27esp_websocket_error_codes_t17esp_tls_stack_errE">esp_websocket_error_codes_t::esp_tls_stack_err (C++ member)</a>
+</li>
+      <li><a href="index.html#_CPPv4N27esp_websocket_error_codes_t24esp_transport_sock_errnoE">esp_websocket_error_codes_t::esp_transport_sock_errno (C++ member)</a>
+</li>
+      <li><a href="index.html#_CPPv4N27esp_websocket_error_codes_t28esp_ws_handshake_status_codeE">esp_websocket_error_codes_t::esp_ws_handshake_status_code (C++ member)</a>
+</li>
+      <li><a href="index.html#_CPPv426esp_websocket_error_type_t">esp_websocket_error_type_t (C++ enum)</a>
+</li>
+      <li><a href="index.html#_CPPv4N26esp_websocket_error_type_t30WEBSOCKET_ERROR_TYPE_HANDSHAKEE">esp_websocket_error_type_t::WEBSOCKET_ERROR_TYPE_HANDSHAKE (C++ enumerator)</a>
+</li>
+      <li><a href="index.html#_CPPv4N26esp_websocket_error_type_t25WEBSOCKET_ERROR_TYPE_NONEE">esp_websocket_error_type_t::WEBSOCKET_ERROR_TYPE_NONE (C++ enumerator)</a>
+</li>
+      <li><a href="index.html#_CPPv4N26esp_websocket_error_type_t33WEBSOCKET_ERROR_TYPE_PONG_TIMEOUTE">esp_websocket_error_type_t::WEBSOCKET_ERROR_TYPE_PONG_TIMEOUT (C++ enumerator)</a>
+</li>
+      <li><a href="index.html#_CPPv4N26esp_websocket_error_type_t34WEBSOCKET_ERROR_TYPE_TCP_TRANSPORTE">esp_websocket_error_type_t::WEBSOCKET_ERROR_TYPE_TCP_TRANSPORT (C++ enumerator)</a>
 </li>
      <li><a href="index.html#_CPPv426esp_websocket_event_data_t">esp_websocket_event_data_t (C++ struct)</a>
 </li>
@@ -218,6 +242,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_t12error_handleE">esp_websocket_event_data_t::error_handle (C++ member)</a>
 </li>
      <li><a href="index.html#_CPPv4N26esp_websocket_event_data_t3finE">esp_websocket_event_data_t::fin (C++ member)</a>
 </li>
@@ -232,6 +258,8 @@
      <li><a href="index.html#_CPPv424esp_websocket_event_id_t">esp_websocket_event_id_t (C++ enum)</a>
 </li>
      <li><a href="index.html#_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE">esp_websocket_event_id_t::WEBSOCKET_EVENT_ANY (C++ enumerator)</a>
+</li>
+      <li><a href="index.html#_CPPv4N24esp_websocket_event_id_t30WEBSOCKET_EVENT_BEFORE_CONNECTE">esp_websocket_event_id_t::WEBSOCKET_EVENT_BEFORE_CONNECT (C++ enumerator)</a>
 </li>
      <li><a href="index.html#_CPPv4N24esp_websocket_event_id_t22WEBSOCKET_EVENT_CLOSEDE">esp_websocket_event_id_t::WEBSOCKET_EVENT_CLOSED (C++ enumerator)</a>
 </li>
--- a/esp_websocket_client/index.html
+++ b/esp_websocket_client/index.html
@@ -117,7 +117,7 @@
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
      <li>ESP WebSocket Client</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-docs/blob/319fce0/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-docs/blob/3bf0511/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
@@ -234,7 +234,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/319fce0/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/3bf0511/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>
@@ -248,7 +248,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/319fce0/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/3bf0511/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
 </ul>
 </section>
 <section id="functions">
@@ -288,6 +288,26 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
 </dl>
 </dd></dl>

+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv432esp_websocket_client_set_headers29esp_websocket_client_handle_tPKc">
+<span id="_CPPv332esp_websocket_client_set_headers29esp_websocket_client_handle_tPKc"></span><span id="_CPPv232esp_websocket_client_set_headers29esp_websocket_client_handle_tPKc"></span><span id="esp_websocket_client_set_headers__esp_websocket_client_handle_t.cCP"></span><span class="target" id="esp__websocket__client_8h_1abcd052636df1554f787dd00e5670ceca"></span><span class="n"><span class="pre">esp_err_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_websocket_client_set_headers</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv429esp_websocket_client_handle_t" title="esp_websocket_client_handle_t"><span class="n"><span class="pre">esp_websocket_client_handle_t</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">client</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">headers</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv432esp_websocket_client_set_headers29esp_websocket_client_handle_tPKc" title="Permalink to this definition"></a><br /></dt>
+<dd><p>Set additional websocket headers for the client, when performing this behavior, the headers will replace the old ones. </p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>client</strong> – <strong>[in]</strong> The client </p></li>
+<li><p><strong>headers</strong> – additional header strings each terminated with \r</p></li>
+</ul>
+</dd>
+<dt class="field-even">Pre</dt>
+<dd class="field-even"><p>Must stop the WebSocket client before set headers if the client has been connected</p>
+</dd>
+<dt class="field-odd">Returns</dt>
+<dd class="field-odd"><p>esp_err_t </p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv426esp_websocket_client_start29esp_websocket_client_handle_t">
 <span id="_CPPv326esp_websocket_client_start29esp_websocket_client_handle_t"></span><span id="_CPPv226esp_websocket_client_start29esp_websocket_client_handle_t"></span><span id="esp_websocket_client_start__esp_websocket_client_handle_t"></span><span class="target" id="esp__websocket__client_8h_1a693a8aef5e81de4c26db82e398788d71"></span><span class="n"><span class="pre">esp_err_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_websocket_client_start</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv429esp_websocket_client_handle_t" title="esp_websocket_client_handle_t"><span class="n"><span class="pre">esp_websocket_client_handle_t</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">client</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426esp_websocket_client_start29esp_websocket_client_handle_t" title="Permalink to this definition"></a><br /></dt>
@@ -551,6 +571,45 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
 </section>
 <section id="structures">
 <h3>Structures<a class="headerlink" href="#structures" title="Permalink to this headline"></a></h3>
+<dl class="cpp struct">
+<dt class="sig sig-object cpp" id="_CPPv427esp_websocket_error_codes_t">
+<span id="_CPPv327esp_websocket_error_codes_t"></span><span id="_CPPv227esp_websocket_error_codes_t"></span><span id="esp_websocket_error_codes_t"></span><span class="target" id="structesp__websocket__error__codes__t"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_websocket_error_codes_t</span></span></span><a class="headerlink" href="#_CPPv427esp_websocket_error_codes_t" title="Permalink to this definition"></a><br /></dt>
+<dd><p>Websocket error code structure to be passed as a contextual information into ERROR event. </p>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N27esp_websocket_error_codes_t20esp_tls_last_esp_errE">
+<span id="_CPPv3N27esp_websocket_error_codes_t20esp_tls_last_esp_errE"></span><span id="_CPPv2N27esp_websocket_error_codes_t20esp_tls_last_esp_errE"></span><span id="esp_websocket_error_codes_t::esp_tls_last_esp_err__esp_err_t"></span><span class="target" id="structesp__websocket__error__codes__t_1a8e4d0d1935ee716a6901b8c3948b3ea3"></span><span class="n"><span class="pre">esp_err_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_tls_last_esp_err</span></span></span><a class="headerlink" href="#_CPPv4N27esp_websocket_error_codes_t20esp_tls_last_esp_errE" title="Permalink to this definition"></a><br /></dt>
+<dd><p>last esp_err code reported from esp-tls component </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N27esp_websocket_error_codes_t17esp_tls_stack_errE">
+<span id="_CPPv3N27esp_websocket_error_codes_t17esp_tls_stack_errE"></span><span id="_CPPv2N27esp_websocket_error_codes_t17esp_tls_stack_errE"></span><span id="esp_websocket_error_codes_t::esp_tls_stack_err__i"></span><span class="target" id="structesp__websocket__error__codes__t_1adcaab157f8089843031bf4b2d72b08da"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_tls_stack_err</span></span></span><a class="headerlink" href="#_CPPv4N27esp_websocket_error_codes_t17esp_tls_stack_errE" title="Permalink to this definition"></a><br /></dt>
+<dd><p>tls specific error code reported from underlying tls stack </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N27esp_websocket_error_codes_t25esp_tls_cert_verify_flagsE">
+<span id="_CPPv3N27esp_websocket_error_codes_t25esp_tls_cert_verify_flagsE"></span><span id="_CPPv2N27esp_websocket_error_codes_t25esp_tls_cert_verify_flagsE"></span><span id="esp_websocket_error_codes_t::esp_tls_cert_verify_flags__i"></span><span class="target" id="structesp__websocket__error__codes__t_1a77c724ac2f1e67e3f16dd4663c48718f"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_tls_cert_verify_flags</span></span></span><a class="headerlink" href="#_CPPv4N27esp_websocket_error_codes_t25esp_tls_cert_verify_flagsE" title="Permalink to this definition"></a><br /></dt>
+<dd><p>tls flags reported from underlying tls stack during certificate verification </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N27esp_websocket_error_codes_t28esp_ws_handshake_status_codeE">
+<span id="_CPPv3N27esp_websocket_error_codes_t28esp_ws_handshake_status_codeE"></span><span id="_CPPv2N27esp_websocket_error_codes_t28esp_ws_handshake_status_codeE"></span><span id="esp_websocket_error_codes_t::esp_ws_handshake_status_code__i"></span><span class="target" id="structesp__websocket__error__codes__t_1a8f804cf82464f89aa144f9c7b8ae1f95"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_ws_handshake_status_code</span></span></span><a class="headerlink" href="#_CPPv4N27esp_websocket_error_codes_t28esp_ws_handshake_status_codeE" title="Permalink to this definition"></a><br /></dt>
+<dd><p>http status code of the websocket upgrade handshake </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N27esp_websocket_error_codes_t24esp_transport_sock_errnoE">
+<span id="_CPPv3N27esp_websocket_error_codes_t24esp_transport_sock_errnoE"></span><span id="_CPPv2N27esp_websocket_error_codes_t24esp_transport_sock_errnoE"></span><span id="esp_websocket_error_codes_t::esp_transport_sock_errno__i"></span><span class="target" id="structesp__websocket__error__codes__t_1a096361ffbbacce31e817db7e183ebdb2"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_transport_sock_errno</span></span></span><a class="headerlink" href="#_CPPv4N27esp_websocket_error_codes_t24esp_transport_sock_errnoE" title="Permalink to this definition"></a><br /></dt>
+<dd><p>errno from the underlying socket </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
 <dl class="cpp struct">
 <dt class="sig sig-object cpp" id="_CPPv426esp_websocket_event_data_t">
 <span id="_CPPv326esp_websocket_event_data_t"></span><span id="_CPPv226esp_websocket_event_data_t"></span><span id="esp_websocket_event_data_t"></span><span class="target" id="structesp__websocket__event__data__t"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_websocket_event_data_t</span></span></span><a class="headerlink" href="#_CPPv426esp_websocket_event_data_t" title="Permalink to this definition"></a><br /></dt>
@@ -605,6 +664,12 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
 <dd><p>Actual offset for the data associated with this event </p>
 </dd></dl>

+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N26esp_websocket_event_data_t12error_handleE">
+<span id="_CPPv3N26esp_websocket_event_data_t12error_handleE"></span><span id="_CPPv2N26esp_websocket_event_data_t12error_handleE"></span><span id="esp_websocket_event_data_t::error_handle__esp_websocket_error_codes_t"></span><span class="target" id="structesp__websocket__event__data__t_1a0b9a9288428cd7a647d5f7f8b3df2c59"></span><a class="reference internal" href="#_CPPv427esp_websocket_error_codes_t" title="esp_websocket_error_codes_t"><span class="n"><span class="pre">esp_websocket_error_codes_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">error_handle</span></span></span><a class="headerlink" href="#_CPPv4N26esp_websocket_event_data_t12error_handleE" title="Permalink to this definition"></a><br /></dt>
+<dd><p>esp-websocket error handle including esp-tls errors as well as internal websocket errors </p>
+</dd></dl>
+
 </div>
 </dd></dl>

@@ -878,6 +943,12 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
 <dd><p>The connection has been closed cleanly </p>
 </dd></dl>

+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp" id="_CPPv4N24esp_websocket_event_id_t30WEBSOCKET_EVENT_BEFORE_CONNECTE">
+<span id="_CPPv3N24esp_websocket_event_id_t30WEBSOCKET_EVENT_BEFORE_CONNECTE"></span><span id="_CPPv2N24esp_websocket_event_id_t30WEBSOCKET_EVENT_BEFORE_CONNECTE"></span><span class="target" id="esp__websocket__client_8h_1a781bbfb5f24162bd806d09cefe317b10a630ef50443a42419342e7a2b72664625"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">WEBSOCKET_EVENT_BEFORE_CONNECT</span></span></span><a class="headerlink" href="#_CPPv4N24esp_websocket_event_id_t30WEBSOCKET_EVENT_BEFORE_CONNECTE" title="Permalink to this definition"></a><br /></dt>
+<dd><p>The event occurs before connecting </p>
+</dd></dl>
+
 <dl class="cpp enumerator">
 <dt class="sig sig-object cpp" id="_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE">
 <span id="_CPPv3N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE"></span><span id="_CPPv2N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE"></span><span class="target" id="esp__websocket__client_8h_1a781bbfb5f24162bd806d09cefe317b10a104fe520c71c532635d64e024e9a02cb"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">WEBSOCKET_EVENT_MAX</span></span></span><a class="headerlink" href="#_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE" title="Permalink to this definition"></a><br /></dt>
@@ -885,6 +956,33 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa

 </dd></dl>

+<dl class="cpp enum">
+<dt class="sig sig-object cpp" id="_CPPv426esp_websocket_error_type_t">
+<span id="_CPPv326esp_websocket_error_type_t"></span><span id="_CPPv226esp_websocket_error_type_t"></span><span class="target" id="esp__websocket__client_8h_1ad76379d2141bca31d4657ded08cb8e26"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_websocket_error_type_t</span></span></span><a class="headerlink" href="#_CPPv426esp_websocket_error_type_t" title="Permalink to this definition"></a><br /></dt>
+<dd><p>Websocket connection error codes propagated via ERROR event. </p>
+<p><em>Values:</em></p>
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp" id="_CPPv4N26esp_websocket_error_type_t25WEBSOCKET_ERROR_TYPE_NONEE">
+<span id="_CPPv3N26esp_websocket_error_type_t25WEBSOCKET_ERROR_TYPE_NONEE"></span><span id="_CPPv2N26esp_websocket_error_type_t25WEBSOCKET_ERROR_TYPE_NONEE"></span><span class="target" id="esp__websocket__client_8h_1ad76379d2141bca31d4657ded08cb8e26ad2523c22e28a4f34990bdc60dd38a147"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">WEBSOCKET_ERROR_TYPE_NONE</span></span></span><a class="headerlink" href="#_CPPv4N26esp_websocket_error_type_t25WEBSOCKET_ERROR_TYPE_NONEE" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp" id="_CPPv4N26esp_websocket_error_type_t34WEBSOCKET_ERROR_TYPE_TCP_TRANSPORTE">
+<span id="_CPPv3N26esp_websocket_error_type_t34WEBSOCKET_ERROR_TYPE_TCP_TRANSPORTE"></span><span id="_CPPv2N26esp_websocket_error_type_t34WEBSOCKET_ERROR_TYPE_TCP_TRANSPORTE"></span><span class="target" id="esp__websocket__client_8h_1ad76379d2141bca31d4657ded08cb8e26afdad0f70b1c7ca4d009977519ae3e363"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">WEBSOCKET_ERROR_TYPE_TCP_TRANSPORT</span></span></span><a class="headerlink" href="#_CPPv4N26esp_websocket_error_type_t34WEBSOCKET_ERROR_TYPE_TCP_TRANSPORTE" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp" id="_CPPv4N26esp_websocket_error_type_t33WEBSOCKET_ERROR_TYPE_PONG_TIMEOUTE">
+<span id="_CPPv3N26esp_websocket_error_type_t33WEBSOCKET_ERROR_TYPE_PONG_TIMEOUTE"></span><span id="_CPPv2N26esp_websocket_error_type_t33WEBSOCKET_ERROR_TYPE_PONG_TIMEOUTE"></span><span class="target" id="esp__websocket__client_8h_1ad76379d2141bca31d4657ded08cb8e26ae4afd7452f0c5ea819c991e85091cdf0"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">WEBSOCKET_ERROR_TYPE_PONG_TIMEOUT</span></span></span><a class="headerlink" href="#_CPPv4N26esp_websocket_error_type_t33WEBSOCKET_ERROR_TYPE_PONG_TIMEOUTE" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp" id="_CPPv4N26esp_websocket_error_type_t30WEBSOCKET_ERROR_TYPE_HANDSHAKEE">
+<span id="_CPPv3N26esp_websocket_error_type_t30WEBSOCKET_ERROR_TYPE_HANDSHAKEE"></span><span id="_CPPv2N26esp_websocket_error_type_t30WEBSOCKET_ERROR_TYPE_HANDSHAKEE"></span><span class="target" id="esp__websocket__client_8h_1ad76379d2141bca31d4657ded08cb8e26a7a1c2ce0bcd89cd1027919aa2d9d6f65"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">WEBSOCKET_ERROR_TYPE_HANDSHAKE</span></span></span><a class="headerlink" href="#_CPPv4N26esp_websocket_error_type_t30WEBSOCKET_ERROR_TYPE_HANDSHAKEE" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
 <dl class="cpp enum">
 <dt class="sig sig-object cpp" id="_CPPv425esp_websocket_transport_t">
 <span id="_CPPv325esp_websocket_transport_t"></span><span id="_CPPv225esp_websocket_transport_t"></span><span class="target" id="esp__websocket__client_8h_1aecb53723a9770b3584483ffc2d97ddc1"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_websocket_transport_t</span></span></span><a class="headerlink" href="#_CPPv425esp_websocket_transport_t" title="Permalink to this definition"></a><br /></dt>
--- a/esp_websocket_client/objects.inv
+++ b/esp_websocket_client/objects.inv
--- a/esp_websocket_client/searchindex.js
+++ b/esp_websocket_client/searchindex.js
--- a/mdns/en/.buildinfo
+++ b/mdns/en/.buildinfo
@@ -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: 1ab6dfdf454698f7bf7502a427e9423a
+config: 6481ea716ed2d9655cce6caea6803f5d
 tags: 549b3d6d0415232fb7e35403b330ff49
--- a/mdns/en/genindex.html
+++ b/mdns/en/genindex.html
@@ -89,7 +89,7 @@
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
      <li>Index</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/319fce0/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/3bf0511/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
--- a/mdns/en/index.html
+++ b/mdns/en/index.html
@@ -114,7 +114,7 @@
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
      <li>mDNS Service</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/319fce0/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/3bf0511/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
@@ -317,14 +317,14 @@
 </section>
 <section id="application-example">
 <h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this headline"></a></h2>
-<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/319fce0/examples/../examples"></a>.</p>
+<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/3bf0511/examples/../examples"></a>.</p>
 </section>
 <section id="api-reference">
 <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h2>
 <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/319fce0/include/mdns.h">include/mdns.h</a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/3bf0511/include/mdns.h">include/mdns.h</a></p></li>
 </ul>
 </section>
 <section id="functions">
--- a/mdns/zh_CN/.buildinfo
+++ b/mdns/zh_CN/.buildinfo
@@ -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: 2d59ef2a66c5f14dcfebf1fd71b1be44
+config: 607d945fca710b76c54a776698df2a21
 tags: 549b3d6d0415232fb7e35403b330ff49
--- a/mdns/zh_CN/genindex.html
+++ b/mdns/zh_CN/genindex.html
@@ -90,7 +90,7 @@
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
      <li>索引</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/319fce0/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/3bf0511/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
      </li>
  </ul>
  <hr/>
--- a/mdns/zh_CN/index.html
+++ b/mdns/zh_CN/index.html
@@ -112,7 +112,7 @@
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
      <li>mDNS 服务</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/319fce0/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/3bf0511/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
      </li>
  </ul>
  <hr/>
@@ -296,14 +296,14 @@
 </section>
 <section id="id7">
 <h2>应用示例<a class="headerlink" href="#id7" title="永久链接至标题"></a></h2>
-<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/319fce0/examples/../examples"></a>。</p>
+<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/3bf0511/examples/../examples"></a>。</p>
 </section>
 <section id="api">
 <h2>API 参考<a class="headerlink" href="#api" title="永久链接至标题"></a></h2>
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="永久链接至标题"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/319fce0/include/mdns.h">include/mdns.h</a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/3bf0511/include/mdns.h">include/mdns.h</a></p></li>
 </ul>
 </section>
 <section id="functions">