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

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

Browse Source
This commit is contained in:
david-cermak
2023-02-03 14:23:52 +00:00
parent 64245b33c9
commit 84f1d3ee0c
17 changed files with 57 additions and 29 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: deae5b6a39abd62e9862e8fe12df5dfa
config: 69da9c26b3fdd2f2927093ba66146ca6
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/2881314/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/cc259aa/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/2881314/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/cc259aa/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/2881314/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/cc259aa/examples/../examples">examples </a>:</p>
<ul class="simple">
<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>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/cc259aa/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/cc259aa/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/cc259aa/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/cc259aa/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: 0b4a1393a6215fb6e119554ee4ed7a60
config: bbef153e7ff64932801f4759e461c541
tags: 549b3d6d0415232fb7e35403b330ff49

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

6
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/2881314/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/cc259aa/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/2881314/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/cc259aa/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/2881314/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/cc259aa/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
</ul>
</section>
<section id="functions">

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: deae5b6a39abd62e9862e8fe12df5dfa
config: 69da9c26b3fdd2f2927093ba66146ca6
tags: 549b3d6d0415232fb7e35403b330ff49

10
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/2881314/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/cc259aa/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -124,6 +124,10 @@
<li><a href="index.html#_CPPv4N20mdns_event_actions_t21MDNS_EVENT_ENABLE_IP4E">mdns_event_actions_t::MDNS_EVENT_ENABLE_IP4 (C++ enumerator)</a>
</li>
<li><a href="index.html#_CPPv4N20mdns_event_actions_t21MDNS_EVENT_ENABLE_IP6E">mdns_event_actions_t::MDNS_EVENT_ENABLE_IP6 (C++ enumerator)</a>
</li>
<li><a href="index.html#_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE">mdns_event_actions_t::MDNS_EVENT_IP4_REVERSE_LOOKUP (C++ enumerator)</a>
</li>
<li><a href="index.html#_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE">mdns_event_actions_t::MDNS_EVENT_IP6_REVERSE_LOOKUP (C++ enumerator)</a>
</li>
<li><a href="index.html#_CPPv49mdns_freev">mdns_free (C++ function)</a>
</li>
@@ -190,11 +194,11 @@
<li><a href="index.html#_CPPv4N13mdns_result_s9esp_netifE">mdns_result_s::esp_netif (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N13mdns_result_s8hostnameE">mdns_result_s::hostname (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N13mdns_result_s13instance_nameE">mdns_result_s::instance_name (C++ member)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#_CPPv4N13mdns_result_s13instance_nameE">mdns_result_s::instance_name (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N13mdns_result_s11ip_protocolE">mdns_result_s::ip_protocol (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N13mdns_result_s4nextE">mdns_result_s::next (C++ member)</a>

16
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/2881314/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/cc259aa/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/2881314/examples/../examples"></a>.</p>
<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/cc259aa/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/2881314/include/mdns.h">include/mdns.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/cc259aa/include/mdns.h">include/mdns.h</a></p></li>
</ul>
</section>
<section id="functions">
@@ -1507,6 +1507,16 @@
<span id="_CPPv3N20mdns_event_actions_t22MDNS_EVENT_DISABLE_IP6E"></span><span id="_CPPv2N20mdns_event_actions_t22MDNS_EVENT_DISABLE_IP6E"></span><span class="target" id="mdns_8h_1a14279e8f2e7c65c12320222a55f09fdfa5406bf4e980611d0fe5b8d27fc79554a"></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">MDNS_EVENT_DISABLE_IP6</span></span></span><a class="headerlink" href="#_CPPv4N20mdns_event_actions_t22MDNS_EVENT_DISABLE_IP6E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE">
<span id="_CPPv3N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE"></span><span id="_CPPv2N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE"></span><span class="target" id="mdns_8h_1a14279e8f2e7c65c12320222a55f09fdfacdd7f535f9cd3873a07715b39d967842"></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">MDNS_EVENT_IP4_REVERSE_LOOKUP</span></span></span><a class="headerlink" href="#_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE">
<span id="_CPPv3N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE"></span><span id="_CPPv2N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE"></span><span class="target" id="mdns_8h_1a14279e8f2e7c65c12320222a55f09fdfa09accfff1b78150b88fcab24f2413e76"></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">MDNS_EVENT_IP6_REVERSE_LOOKUP</span></span></span><a class="headerlink" href="#_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</dd></dl>
<dl class="cpp enum">

BIN
mdns/en/objects.inv
View File

Binary file not shown.

2
mdns/en/searchindex.js
View File

File diff suppressed because one or more lines are too long

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: 1e77762b484f2a3dd34f8787862747b6
config: fbe8c14604785094cabc0f86cde8a528
tags: 549b3d6d0415232fb7e35403b330ff49

10
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/2881314/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
<a href="https://github.com/espressif/esp-protocols/blob/cc259aa/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
</li>
</ul>
<hr/>
@@ -125,6 +125,10 @@
<li><a href="index.html#_CPPv4N20mdns_event_actions_t21MDNS_EVENT_ENABLE_IP4E">mdns_event_actions_t::MDNS_EVENT_ENABLE_IP4 (C++ enumerator)</a>
</li>
<li><a href="index.html#_CPPv4N20mdns_event_actions_t21MDNS_EVENT_ENABLE_IP6E">mdns_event_actions_t::MDNS_EVENT_ENABLE_IP6 (C++ enumerator)</a>
</li>
<li><a href="index.html#_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE">mdns_event_actions_t::MDNS_EVENT_IP4_REVERSE_LOOKUP (C++ enumerator)</a>
</li>
<li><a href="index.html#_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE">mdns_event_actions_t::MDNS_EVENT_IP6_REVERSE_LOOKUP (C++ enumerator)</a>
</li>
<li><a href="index.html#_CPPv49mdns_freev">mdns_free (C++ function)</a>
</li>
@@ -191,11 +195,11 @@
<li><a href="index.html#_CPPv4N13mdns_result_s9esp_netifE">mdns_result_s::esp_netif (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N13mdns_result_s8hostnameE">mdns_result_s::hostname (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N13mdns_result_s13instance_nameE">mdns_result_s::instance_name (C++ member)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#_CPPv4N13mdns_result_s13instance_nameE">mdns_result_s::instance_name (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N13mdns_result_s11ip_protocolE">mdns_result_s::ip_protocol (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N13mdns_result_s4nextE">mdns_result_s::next (C++ member)</a>

16
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/2881314/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
<a href="https://github.com/espressif/esp-protocols/blob/cc259aa/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/2881314/examples/../examples"></a>。</p>
<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/cc259aa/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/2881314/include/mdns.h">include/mdns.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/cc259aa/include/mdns.h">include/mdns.h</a></p></li>
</ul>
</section>
<section id="functions">
@@ -1486,6 +1486,16 @@
<span id="_CPPv3N20mdns_event_actions_t22MDNS_EVENT_DISABLE_IP6E"></span><span id="_CPPv2N20mdns_event_actions_t22MDNS_EVENT_DISABLE_IP6E"></span><span class="target" id="mdns_8h_1a14279e8f2e7c65c12320222a55f09fdfa5406bf4e980611d0fe5b8d27fc79554a"></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">MDNS_EVENT_DISABLE_IP6</span></span></span><a class="headerlink" href="#_CPPv4N20mdns_event_actions_t22MDNS_EVENT_DISABLE_IP6E" title="永久链接至目标"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE">
<span id="_CPPv3N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE"></span><span id="_CPPv2N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE"></span><span class="target" id="mdns_8h_1a14279e8f2e7c65c12320222a55f09fdfacdd7f535f9cd3873a07715b39d967842"></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">MDNS_EVENT_IP4_REVERSE_LOOKUP</span></span></span><a class="headerlink" href="#_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP4_REVERSE_LOOKUPE" title="永久链接至目标"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE">
<span id="_CPPv3N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE"></span><span id="_CPPv2N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE"></span><span class="target" id="mdns_8h_1a14279e8f2e7c65c12320222a55f09fdfa09accfff1b78150b88fcab24f2413e76"></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">MDNS_EVENT_IP6_REVERSE_LOOKUP</span></span></span><a class="headerlink" href="#_CPPv4N20mdns_event_actions_t29MDNS_EVENT_IP6_REVERSE_LOOKUPE" title="永久链接至目标"></a><br /></dt>
<dd></dd></dl>
</dd></dl>
<dl class="cpp enum">

BIN
mdns/zh_CN/objects.inv
View File

Binary file not shown.

2
mdns/zh_CN/searchindex.js
View File

File diff suppressed because one or more lines are too long