Deploying to gh-pages from @ espressif/esp-protocols@38149c8d9b 🚀

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: ef4effc5583825e3da3b797041c372d6
+config: 063ce4e84275d2576c6afcc4d93474df
 tags: 549b3d6d0415232fb7e35403b330ff49

esp_websocket_client/genindex.html

@@ -163,7 +163,7 @@
         
             
             
-              <a href="https://github.com/espressif/esp-docs/blob/1984da1/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-docs/blob/38149c8/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
             
           
         
@@ -253,15 +253,17 @@
 </li>
       <li><a href="index.html#_CPPv4N29esp_websocket_client_config_t19use_global_ca_storeE">esp_websocket_client_config_t::use_global_ca_store (C++ member)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <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>
 </li>
       <li><a href="index.html#_CPPv428esp_websocket_client_destroy29esp_websocket_client_handle_t">esp_websocket_client_destroy (C++ function)</a>
+</li>
+      <li><a href="index.html#_CPPv442esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t">esp_websocket_client_get_ping_interval_sec (C++ function)</a>
 </li>
       <li><a href="index.html#_CPPv429esp_websocket_client_handle_t">esp_websocket_client_handle_t (C++ type)</a>
 </li>
@@ -272,6 +274,8 @@
       <li><a href="index.html#_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t">esp_websocket_client_send_bin (C++ function)</a>
 </li>
       <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#_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t">esp_websocket_client_set_ping_interval_sec (C++ function)</a>
 </li>
       <li><a href="index.html#_CPPv428esp_websocket_client_set_uri29esp_websocket_client_handle_tPKc">esp_websocket_client_set_uri (C++ function)</a>
 </li>

esp_websocket_client/index.html

@@ -191,7 +191,7 @@
         
             
             
-              <a href="https://github.com/espressif/esp-docs/blob/1984da1/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-docs/blob/38149c8/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/1984da1/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/38149c8/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/1984da1/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/38149c8/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
 </ul>
 </section>
 <section id="functions">
@@ -536,6 +536,37 @@ 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="_CPPv442esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t">
+<span id="_CPPv342esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t"></span><span id="_CPPv242esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t"></span><span id="esp_websocket_client_get_ping_interval_sec__esp_websocket_client_handle_t"></span><span class="target" id="esp__websocket__client_8h_1ac8f96276df09f56af4b83675cd1487ff"></span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_websocket_client_get_ping_interval_sec</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="#_CPPv442esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Get the ping interval sec for client. </p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>client</strong> – <strong>[in]</strong> The client</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The ping interval in sec </p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t">
+<span id="_CPPv342esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t"></span><span id="_CPPv242esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t"></span><span id="esp_websocket_client_set_ping_interval_sec__esp_websocket_client_handle_t.s"></span><span class="target" id="esp__websocket__client_8h_1a72e61f91ed9d9424287f376284ffc9b3"></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_ping_interval_sec</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="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ping_interval_sec</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Set new ping interval sec for client. </p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>client</strong> – <strong>[in]</strong> The client </p></li>
+<li><p><strong>ping_interval_sec</strong> – <strong>[in]</strong> The new interval</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>esp_err_t </p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv">
 <span id="_CPPv329esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv"></span><span id="_CPPv229esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv"></span><span id="esp_websocket_register_events__esp_websocket_client_handle_t.esp_websocket_event_id_t.esp_event_handler_t.voidP"></span><span class="target" id="esp__websocket__client_8h_1a8d993808cd78275be7ae4de44e8c11d9"></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_register_events</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>, <a class="reference internal" href="#_CPPv424esp_websocket_event_id_t" title="esp_websocket_event_id_t"><span class="n"><span class="pre">esp_websocket_event_id_t</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">event</span></span>, <span class="n"><span class="pre">esp_event_handler_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">event_handler</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">event_handler_arg</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv" title="Permalink to this definition">¶</a><br /></dt>

esp_websocket_client/search.html

@@ -165,7 +165,7 @@
         
             
             
-              <a href="https://github.com/espressif/esp-docs/blob/1984da1/docs/en/search" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-docs/blob/38149c8/docs/en/search" class="fa fa-github"> Edit on GitHub</a>