espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-08-06 06:04:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ espressif/esp-protocols@28813148b2 🚀

Browse Source
This commit is contained in:
gabsuren
2023-02-01 14:02:21 +00:00
parent c7f4ada42c
commit 64245b33c9
15 changed files with 46 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
asio/.buildinfo
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: 3984ab2d18c66b8e7830d365e0d950e9
config: deae5b6a39abd62e9862e8fe12df5dfa
tags: 549b3d6d0415232fb7e35403b330ff49

2
asio/genindex.html
View File

@@ -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/ae38f27/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/2881314/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>

12
asio/index.html
View File

@@ -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/ae38f27/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/2881314/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/ae38f27/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/2881314/examples/../examples">examples </a>:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/ae38f27/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/ae38f27/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/ae38f27/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/ae38f27/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/2881314/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/2881314/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/2881314/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/2881314/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>

BIN
esp_modem/.doctrees/environment.pickle
View File

Binary file not shown.

2
esp_websocket_client/.buildinfo
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: bba79c97672cba4c202bed913fd3f8f0
config: 0b4a1393a6215fb6e119554ee4ed7a60
tags: 549b3d6d0415232fb7e35403b330ff49

8
esp_websocket_client/genindex.html
View File

@@ -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/ae38f27/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/2881314/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -177,13 +177,15 @@
</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>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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#_CPPv436esp_websocket_client_destroy_on_exit29esp_websocket_client_handle_t">esp_websocket_client_destroy_on_exit (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>

24
esp_websocket_client/index.html
View File

@@ -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/ae38f27/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/2881314/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/ae38f27/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/2881314/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/ae38f27/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/2881314/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
</ul>
</section>
<section id="functions">
@@ -339,6 +339,24 @@ 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="_CPPv436esp_websocket_client_destroy_on_exit29esp_websocket_client_handle_t">
<span id="_CPPv336esp_websocket_client_destroy_on_exit29esp_websocket_client_handle_t"></span><span id="_CPPv236esp_websocket_client_destroy_on_exit29esp_websocket_client_handle_t"></span><span id="esp_websocket_client_destroy_on_exit__esp_websocket_client_handle_t"></span><span class="target" id="esp__websocket__client_8h_1a5ede8e7f1ae206734cf4ec5691722908"></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_destroy_on_exit</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="#_CPPv436esp_websocket_client_destroy_on_exit29esp_websocket_client_handle_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>If this API called, WebSocket client will destroy and free all resources at the end of event loop. </p>
<p>Notes:<ul class="simple">
<li><p>After event loop finished, client handle would be dangling and should never be used</p></li>
</ul>
</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>client</strong> – <strong>[in]</strong> The client</p>
</dd>
<dt class="field-even">Returns</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_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t">
<span id="_CPPv329esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t"></span><span id="_CPPv229esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t"></span><span id="esp_websocket_client_send_bin__esp_websocket_client_handle_t.cCP.i.TickType_t"></span><span class="target" id="esp__websocket__client_8h_1a7c0f6ba95ed2c5a79aaffdd98c755052"></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_websocket_client_send_bin</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">data</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">len</span></span>, <span class="n"><span class="pre">TickType_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">timeout</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t" title="Permalink to this definition"></a><br /></dt>

BIN
esp_websocket_client/objects.inv
View File

Binary file not shown.

2
esp_websocket_client/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
mdns/en/.buildinfo
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: 3984ab2d18c66b8e7830d365e0d950e9
config: deae5b6a39abd62e9862e8fe12df5dfa
tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/en/genindex.html
View File

@@ -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/ae38f27/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/2881314/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>

6
mdns/en/index.html
View File

@@ -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/ae38f27/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/2881314/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/ae38f27/examples/../examples"></a>.</p>
<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/2881314/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/ae38f27/include/mdns.h">include/mdns.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/2881314/include/mdns.h">include/mdns.h</a></p></li>
</ul>
</section>
<section id="functions">

2
mdns/zh_CN/.buildinfo
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: b8076ef9c07946588e1698d07c0b4a07
config: 1e77762b484f2a3dd34f8787862747b6
tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/zh_CN/genindex.html
View File

@@ -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/ae38f27/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
<a href="https://github.com/espressif/esp-protocols/blob/2881314/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
</li>
</ul>
<hr/>

6
mdns/zh_CN/index.html
View File

@@ -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/ae38f27/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
<a href="https://github.com/espressif/esp-protocols/blob/2881314/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/ae38f27/examples/../examples"></a>。</p>
<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/2881314/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/ae38f27/include/mdns.h">include/mdns.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/2881314/include/mdns.h">include/mdns.h</a></p></li>
</ul>
</section>
<section id="functions">