forked from espressif/esp-protocols
Deploying to gh-pages from @ espressif/esp-protocols@6e4d8a19ed 🚀
This commit is contained in:
Binary file not shown.
@@ -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: 2338c15411746b8e6777a14bc705e758
|
||||
config: e8cae2279d8f317a1b14b193de176564
|
||||
tags: 549b3d6d0415232fb7e35403b330ff49
|
||||
|
@@ -163,7 +163,7 @@
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/espressif/esp-docs/blob/6e5bede/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-docs/blob/6e4d8a1/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
|
||||
|
||||
|
||||
@@ -286,6 +286,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_t3finE">esp_websocket_event_data_t::fin (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="index.html#_CPPv4N26esp_websocket_event_data_t7op_codeE">esp_websocket_event_data_t::op_code (C++ member)</a>
|
||||
</li>
|
||||
|
@@ -191,7 +191,7 @@
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/espressif/esp-docs/blob/6e5bede/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-docs/blob/6e4d8a1/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/6e5bede/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/6e4d8a1/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/6e5bede/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/6e4d8a1/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="functions">
|
||||
@@ -576,6 +576,12 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
|
||||
<dd><p>Data length </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="cpp var">
|
||||
<dt class="sig sig-object cpp" id="_CPPv4N26esp_websocket_event_data_t3finE">
|
||||
<span id="_CPPv3N26esp_websocket_event_data_t3finE"></span><span id="_CPPv2N26esp_websocket_event_data_t3finE"></span><span id="esp_websocket_event_data_t::fin__b"></span><span class="target" id="structesp__websocket__event__data__t_1a34e3831399dbc1d9ed526b63528eac29"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">fin</span></span></span><a class="headerlink" href="#_CPPv4N26esp_websocket_event_data_t3finE" title="Permalink to this definition">¶</a><br /></dt>
|
||||
<dd><p>Fin flag </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="cpp var">
|
||||
<dt class="sig sig-object cpp" id="_CPPv4N26esp_websocket_event_data_t7op_codeE">
|
||||
<span id="_CPPv3N26esp_websocket_event_data_t7op_codeE"></span><span id="_CPPv2N26esp_websocket_event_data_t7op_codeE"></span><span id="esp_websocket_event_data_t::op_code__uint8_t"></span><span class="target" id="structesp__websocket__event__data__t_1aeba7476e8b18de266426a6d345fa530c"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">op_code</span></span></span><a class="headerlink" href="#_CPPv4N26esp_websocket_event_data_t7op_codeE" title="Permalink to this definition">¶</a><br /></dt>
|
||||
|
Binary file not shown.
@@ -165,7 +165,7 @@
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/espressif/esp-docs/blob/6e5bede/docs/en/search" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-docs/blob/6e4d8a1/docs/en/search" class="fa fa-github"> Edit on GitHub</a>
|
||||
|
||||
|
||||
|
||||
|
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user