mirror of
https://github.com/espressif/esp-protocols.git
synced 2025-08-06 14:14:29 +02:00
Deploying to gh-pages from @ espressif/esp-protocols@010f98ca80 🚀
This commit is contained in:
@@ -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: 2aa1879729e335b9b300fd7cba2b2eb0
|
||||
config: 3993d1d09dfdae7fd5fdc789e1472420
|
||||
tags: 549b3d6d0415232fb7e35403b330ff49
|
||||
|
@@ -90,7 +90,7 @@
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li>Index</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/b6852a0/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/010f98c/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
|
@@ -102,7 +102,7 @@
|
||||
<li><a href="#" class="icon icon-home"></a> »</li>
|
||||
<li>ASIO port</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/b6852a0/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/010f98c/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -143,12 +143,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 heading"></a></h2>
|
||||
<p>ESP examples are based on standard asio <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/b6852a0/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/010f98c/examples/../examples">examples </a>:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/b6852a0/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/b6852a0/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/b6852a0/examples/../examples/asio_chat">asio_chat </a></p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/b6852a0/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/010f98c/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/010f98c/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/010f98c/examples/../examples/asio_chat">asio_chat </a></p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/010f98c/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>
|
||||
|
Binary file not shown.
@@ -201,7 +201,7 @@ as a class derived from <code class="docutils literal notranslate"><span class="
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
|
@@ -288,7 +288,7 @@ a custom DTE object and supply it into <a class="reference internal" href="#dce-
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
|
@@ -1027,7 +1027,7 @@ pointer as the return value. The API expects the output data to point to user al
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
|
@@ -287,7 +287,7 @@ It simply gets destroyed and cleaned-up automatically if the object goes out of
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
|
@@ -129,7 +129,7 @@
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
|
@@ -603,7 +603,7 @@
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
</div>
|
||||
|
@@ -160,7 +160,7 @@
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
|
@@ -146,7 +146,7 @@ to multiplex the terminal.</p>
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
|
@@ -1384,7 +1384,7 @@ Please refer to the <a class="reference internal" href="api_docs.html#c-api"><sp
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
|
@@ -116,7 +116,7 @@
|
||||
©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.0</a>
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
</div>
|
||||
|
@@ -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: ef3c95e41d94aa5359233be0c6a3dcc9
|
||||
config: 39836b5e2f6fbb4685a454987ee93274
|
||||
tags: 549b3d6d0415232fb7e35403b330ff49
|
||||
|
@@ -90,7 +90,7 @@
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li>Index</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/espressif/esp-docs/blob/b6852a0/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-docs/blob/010f98c/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
|
@@ -118,7 +118,7 @@
|
||||
<li><a href="#" class="icon icon-home"></a> »</li>
|
||||
<li>ESP WebSocket Client</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/espressif/esp-docs/blob/b6852a0/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-docs/blob/010f98c/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -235,7 +235,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 heading"></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/b6852a0/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/010f98c/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 heading"></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>
|
||||
@@ -249,7 +249,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 heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/b6852a0/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/010f98c/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="functions">
|
||||
|
@@ -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: 2aa1879729e335b9b300fd7cba2b2eb0
|
||||
config: 3993d1d09dfdae7fd5fdc789e1472420
|
||||
tags: 549b3d6d0415232fb7e35403b330ff49
|
||||
|
@@ -90,7 +90,7 @@
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li>Index</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/b6852a0/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/010f98c/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
|
@@ -115,7 +115,7 @@
|
||||
<li><a href="#" class="icon icon-home"></a> »</li>
|
||||
<li>mDNS Service</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/b6852a0/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/010f98c/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -318,14 +318,14 @@
|
||||
</section>
|
||||
<section id="application-example">
|
||||
<h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this heading"></a></h2>
|
||||
<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/b6852a0/examples/../examples"></a>.</p>
|
||||
<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/010f98c/examples/../examples"></a>.</p>
|
||||
</section>
|
||||
<section id="api-reference">
|
||||
<h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading"></a></h2>
|
||||
<section id="header-file">
|
||||
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/b6852a0/include/mdns.h">include/mdns.h</a></p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/010f98c/include/mdns.h">include/mdns.h</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="functions">
|
||||
|
@@ -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: 23d18dea2ad85b14076356945260b6ad
|
||||
config: 9148f295c97c6a4f9f0181a8940786ef
|
||||
tags: 549b3d6d0415232fb7e35403b330ff49
|
||||
|
@@ -91,7 +91,7 @@
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li>索引</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/b6852a0/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/010f98c/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
|
@@ -113,7 +113,7 @@
|
||||
<li><a href="#" class="icon icon-home"></a> »</li>
|
||||
<li>mDNS 服务</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/b6852a0/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
|
||||
<a href="https://github.com/espressif/esp-protocols/blob/010f98c/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -297,14 +297,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/b6852a0/examples/../examples"></a>。</p>
|
||||
<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/010f98c/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/b6852a0/include/mdns.h">include/mdns.h</a></p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/010f98c/include/mdns.h">include/mdns.h</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="functions">
|
||||
|
Reference in New Issue
Block a user