forked from espressif/esp-protocols
Deploying to gh-pages from @ espressif/esp-protocols@3bdb2067e0 🚀
This commit is contained in:
david-cermak committed
1 parent
1164a9382a
commit
559bb47efe
15 files changed
+34
-26
No files matched your search
@@ -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: 90271c2c0525da991cecbd655ce62259
|
||||
config: 85b9ec72139e857ab5e43e51f6431408
|
||||
tags: 549b3d6d0415232fb7e35403b330ff49
|
||||
@@ -89,7 +89,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/de1480a/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-docs/blob/3bdb206/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -164,6 +164,8 @@
|
||||
<li><a href="index.html#_CPPv4N29esp_websocket_client_config_t27skip_cert_common_name_checkE">esp_websocket_client_config_t::skip_cert_common_name_check (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="index.html#_CPPv4N29esp_websocket_client_config_t11subprotocolE">esp_websocket_client_config_t::subprotocol (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="index.html#_CPPv4N29esp_websocket_client_config_t9task_nameE">esp_websocket_client_config_t::task_name (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="index.html#_CPPv4N29esp_websocket_client_config_t9task_prioE">esp_websocket_client_config_t::task_prio (C++ member)</a>
|
||||
</li>
|
||||
@@ -176,11 +178,11 @@
|
||||
<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>
|
||||
<li><a href="index.html#_CPPv4N29esp_websocket_client_config_t10user_agentE">esp_websocket_client_config_t::user_agent (C++ member)</a>
|
||||
</li>
|
||||
<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_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>
|
||||
|
||||
@@ -117,7 +117,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/de1480a/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
|
||||
<a href="https://github.com/espressif/esp-docs/blob/3bdb206/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/de1480a/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/3bdb206/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/de1480a/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/3bdb206/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="functions">
|
||||
@@ -668,6 +668,12 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
|
||||
<dd><p>Websocket task priority </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="cpp var">
|
||||
<dt class="sig sig-object cpp" id="_CPPv4N29esp_websocket_client_config_t9task_nameE">
|
||||
<span id="_CPPv3N29esp_websocket_client_config_t9task_nameE"></span><span id="_CPPv2N29esp_websocket_client_config_t9task_nameE"></span><span id="esp_websocket_client_config_t::task_name__cCP"></span><span class="target" id="structesp__websocket__client__config__t_1a923c7b85cfb467be65f04363b000eb46"></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="sig-name descname"><span class="n"><span class="pre">task_name</span></span></span><a class="headerlink" href="#_CPPv4N29esp_websocket_client_config_t9task_nameE" title="Permalink to this definition"></a><br /></dt>
|
||||
<dd><p>Websocket task name </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="cpp var">
|
||||
<dt class="sig sig-object cpp" id="_CPPv4N29esp_websocket_client_config_t10task_stackE">
|
||||
<span id="_CPPv3N29esp_websocket_client_config_t10task_stackE"></span><span id="_CPPv2N29esp_websocket_client_config_t10task_stackE"></span><span id="esp_websocket_client_config_t::task_stack__i"></span><span class="target" id="structesp__websocket__client__config__t_1aaa2eb851ef9ad2f21057c0548df14aa4"></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">task_stack</span></span></span><a class="headerlink" href="#_CPPv4N29esp_websocket_client_config_t10task_stackE" title="Permalink to this definition"></a><br /></dt>
|
||||
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,sphinx:56},filenames:["index.rst"],objects:{"":[[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE","WEBSOCKET_EVENT_ANY"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t22WEBSOCKET_EVENT_CLOSEDE","WEBSOCKET_EVENT_CLOSED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t25WEBSOCKET_EVENT_CONNECTEDE","WEBSOCKET_EVENT_CONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t20WEBSOCKET_EVENT_DATAE","WEBSOCKET_EVENT_DATA"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t28WEBSOCKET_EVENT_DISCONNECTEDE","WEBSOCKET_EVENT_DISCONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t21WEBSOCKET_EVENT_ERRORE","WEBSOCKET_EVENT_ERROR"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE","WEBSOCKET_EVENT_MAX"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_SSLE","WEBSOCKET_TRANSPORT_OVER_SSL"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_TCPE","WEBSOCKET_TRANSPORT_OVER_TCP"],[0,0,1,"_CPPv4N25esp_websocket_transport_t27WEBSOCKET_TRANSPORT_UNKNOWNE","WEBSOCKET_TRANSPORT_UNKNOWN"],[0,1,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close"],[0,2,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close::client"],[0,2,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close::timeout"],[0,1,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::client"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::code"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::data"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::len"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::timeout"],[0,3,1,"_CPPv429esp_websocket_client_config_t","esp_websocket_client_config_t"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11buffer_sizeE","esp_websocket_client_config_t::buffer_size"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8cert_lenE","esp_websocket_client_config_t::cert_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8cert_pemE","esp_websocket_client_config_t::cert_pem"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11client_certE","esp_websocket_client_config_t::client_cert"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t15client_cert_lenE","esp_websocket_client_config_t::client_cert_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t10client_keyE","esp_websocket_client_config_t::client_key"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t14client_key_lenE","esp_websocket_client_config_t::client_key_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17crt_bundle_attachE","esp_websocket_client_config_t::crt_bundle_attach"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t22disable_auto_reconnectE","esp_websocket_client_config_t::disable_auto_reconnect"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t23disable_pingpong_disconE","esp_websocket_client_config_t::disable_pingpong_discon"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t7headersE","esp_websocket_client_config_t::headers"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4hostE","esp_websocket_client_config_t::host"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t7if_nameE","esp_websocket_client_config_t::if_name"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t16keep_alive_countE","esp_websocket_client_config_t::keep_alive_count"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17keep_alive_enableE","esp_websocket_client_config_t::keep_alive_enable"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t15keep_alive_idleE","esp_websocket_client_config_t::keep_alive_idle"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t19keep_alive_intervalE","esp_websocket_client_config_t::keep_alive_interval"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t18network_timeout_msE","esp_websocket_client_config_t::network_timeout_ms"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8passwordE","esp_websocket_client_config_t::password"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4pathE","esp_websocket_client_config_t::path"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17ping_interval_secE","esp_websocket_client_config_t:Line truncated
|
||||
Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,sphinx:56},filenames:["index.rst"],objects:{"":[[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE","WEBSOCKET_EVENT_ANY"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t22WEBSOCKET_EVENT_CLOSEDE","WEBSOCKET_EVENT_CLOSED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t25WEBSOCKET_EVENT_CONNECTEDE","WEBSOCKET_EVENT_CONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t20WEBSOCKET_EVENT_DATAE","WEBSOCKET_EVENT_DATA"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t28WEBSOCKET_EVENT_DISCONNECTEDE","WEBSOCKET_EVENT_DISCONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t21WEBSOCKET_EVENT_ERRORE","WEBSOCKET_EVENT_ERROR"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE","WEBSOCKET_EVENT_MAX"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_SSLE","WEBSOCKET_TRANSPORT_OVER_SSL"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_TCPE","WEBSOCKET_TRANSPORT_OVER_TCP"],[0,0,1,"_CPPv4N25esp_websocket_transport_t27WEBSOCKET_TRANSPORT_UNKNOWNE","WEBSOCKET_TRANSPORT_UNKNOWN"],[0,1,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close"],[0,2,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close::client"],[0,2,1,"_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t","esp_websocket_client_close::timeout"],[0,1,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::client"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::code"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::data"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::len"],[0,2,1,"_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t","esp_websocket_client_close_with_code::timeout"],[0,3,1,"_CPPv429esp_websocket_client_config_t","esp_websocket_client_config_t"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11buffer_sizeE","esp_websocket_client_config_t::buffer_size"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8cert_lenE","esp_websocket_client_config_t::cert_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8cert_pemE","esp_websocket_client_config_t::cert_pem"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11client_certE","esp_websocket_client_config_t::client_cert"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t15client_cert_lenE","esp_websocket_client_config_t::client_cert_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t10client_keyE","esp_websocket_client_config_t::client_key"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t14client_key_lenE","esp_websocket_client_config_t::client_key_len"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17crt_bundle_attachE","esp_websocket_client_config_t::crt_bundle_attach"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t22disable_auto_reconnectE","esp_websocket_client_config_t::disable_auto_reconnect"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t23disable_pingpong_disconE","esp_websocket_client_config_t::disable_pingpong_discon"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t7headersE","esp_websocket_client_config_t::headers"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4hostE","esp_websocket_client_config_t::host"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t7if_nameE","esp_websocket_client_config_t::if_name"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t16keep_alive_countE","esp_websocket_client_config_t::keep_alive_count"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17keep_alive_enableE","esp_websocket_client_config_t::keep_alive_enable"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t15keep_alive_idleE","esp_websocket_client_config_t::keep_alive_idle"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t19keep_alive_intervalE","esp_websocket_client_config_t::keep_alive_interval"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t18network_timeout_msE","esp_websocket_client_config_t::network_timeout_ms"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8passwordE","esp_websocket_client_config_t::password"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4pathE","esp_websocket_client_config_t::path"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t17ping_interval_secE","esp_websocket_client_config_t:Line truncated
|
||||
Reference in new issue
Block a user