2023-01-13 13:59:52 +00:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title > Index - ESP32 - — ESP-Protocols latest documentation< / title >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/copybutton.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/theme_overrides.css" type = "text/css" / >
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
< script data-url_root = "./" id = "documentation_options" src = "_static/documentation_options.js" > < / script >
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/doctools.js" > < / script >
< script src = "_static/clipboard.min.js" > < / script >
< script src = "_static/copybutton.js" > < / script >
< script src = "_static/js/theme.js" > < / script >
< script type = "text/javascript" >
DOCUMENTATION_OPTIONS.PAGENAME = 'genindex';
DOCUMENTATION_OPTIONS.PROJECT_SLUG = 'esp-idf';
DOCUMENTATION_OPTIONS.LATEST_BRANCH_NAME = 'master';
DOCUMENTATION_OPTIONS.VERSIONS_URL = 'https://github.com/espressif/esp-protocols/docs/docs_versions.js';
DOCUMENTATION_OPTIONS.LANGUAGES = ["en"];
DOCUMENTATION_OPTIONS.IDF_TARGET = 'esp32';
DOCUMENTATION_OPTIONS.HAS_IDF_TARGETS = ["esp32"]
DOCUMENTATION_OPTIONS.RELEASE = 'latest';
< / script >
< script type = "text/javascript" src = "https://github.com/espressif/esp-protocols/docs/docs_versions.js" > < / script >
< link rel = "index" title = "Index" href = "#" / >
< link rel = "search" title = "Search" href = "search.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "index.html" class = "icon icon-home" > ESP-Protocols
< img src = "_static/espressif-logo.svg" class = "logo" alt = "Logo" / >
< / a >
< div class = "selectors" >
< select id = "target-select" style = "width: 150px;" hidden >
< option value = "" disabled selected > Choose target...< / option >
< / select >
< / div >
< div class = "selectors" >
< select id = "version-select" style = "width: 150px;" hidden >
< option value = "" disabled selected > Choose version...< / option >
< / select >
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div > < div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "Navigation menu" >
<!-- Local TOC -->
< div class = "local-toc" > < / div >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" > < nav class = "wy-nav-top" aria-label = "Mobile navigation menu" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "index.html" > ESP-Protocols< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "Page navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" class = "icon icon-home" > < / a > » < / li >
< li > Index< / li >
< li class = "wy-breadcrumbs-aside" >
2023-02-17 14:10:01 +00:00
< a href = "https://github.com/espressif/esp-docs/blob/9ae88aa/docs/en/genindex" class = "fa fa-github" > Edit on GitHub< / a >
2023-01-13 13:59:52 +00:00
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< h1 id = "index" > Index< / h1 >
< div class = "genindex-jumpbox" >
< a href = "#E" > < strong > E< / strong > < / a >
< / div >
< h2 id = "E" > E< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "index.html#_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t" > esp_websocket_client_close (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t" > esp_websocket_client_close_with_code (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv429esp_websocket_client_config_t" > esp_websocket_client_config_t (C++ struct)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t11buffer_sizeE" > esp_websocket_client_config_t::buffer_size (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t8cert_lenE" > esp_websocket_client_config_t::cert_len (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t8cert_pemE" > esp_websocket_client_config_t::cert_pem (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t11client_certE" > esp_websocket_client_config_t::client_cert (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t15client_cert_lenE" > esp_websocket_client_config_t::client_cert_len (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t10client_keyE" > esp_websocket_client_config_t::client_key (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t14client_key_lenE" > esp_websocket_client_config_t::client_key_len (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t17crt_bundle_attachE" > esp_websocket_client_config_t::crt_bundle_attach (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t22disable_auto_reconnectE" > esp_websocket_client_config_t::disable_auto_reconnect (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t23disable_pingpong_disconE" > esp_websocket_client_config_t::disable_pingpong_discon (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t7headersE" > esp_websocket_client_config_t::headers (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t4hostE" > esp_websocket_client_config_t::host (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t7if_nameE" > esp_websocket_client_config_t::if_name (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t16keep_alive_countE" > esp_websocket_client_config_t::keep_alive_count (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t17keep_alive_enableE" > esp_websocket_client_config_t::keep_alive_enable (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t15keep_alive_idleE" > esp_websocket_client_config_t::keep_alive_idle (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t19keep_alive_intervalE" > esp_websocket_client_config_t::keep_alive_interval (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t18network_timeout_msE" > esp_websocket_client_config_t::network_timeout_ms (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t8passwordE" > esp_websocket_client_config_t::password (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t4pathE" > esp_websocket_client_config_t::path (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t17ping_interval_secE" > esp_websocket_client_config_t::ping_interval_sec (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t20pingpong_timeout_secE" > esp_websocket_client_config_t::pingpong_timeout_sec (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t4portE" > esp_websocket_client_config_t::port (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t20reconnect_timeout_msE" > esp_websocket_client_config_t::reconnect_timeout_ms (C++ member)< / a >
< / li >
< 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 >
2023-02-08 15:12:25 +00:00
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t9task_nameE" > esp_websocket_client_config_t::task_name (C++ member)< / a >
2023-01-13 13:59:52 +00:00
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t9task_prioE" > esp_websocket_client_config_t::task_prio (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t10task_stackE" > esp_websocket_client_config_t::task_stack (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t9transportE" > esp_websocket_client_config_t::transport (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t3uriE" > esp_websocket_client_config_t::uri (C++ member)< / a >
< / li >
< 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 >
2023-02-01 14:02:21 +00:00
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
2023-02-08 15:12:25 +00:00
< li > < a href = "index.html#_CPPv4N29esp_websocket_client_config_t12user_contextE" > esp_websocket_client_config_t::user_context (C++ member)< / a >
< / li >
2023-01-13 13:59:52 +00:00
< 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 >
2023-02-01 14:02:21 +00:00
< / 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 >
2023-01-13 13:59:52 +00:00
< / 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 >
< li > < a href = "index.html#_CPPv429esp_websocket_client_handle_t" > esp_websocket_client_handle_t (C++ type)< / a >
< / li >
< li > < a href = "index.html#_CPPv425esp_websocket_client_initPK29esp_websocket_client_config_t" > esp_websocket_client_init (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv433esp_websocket_client_is_connected29esp_websocket_client_handle_t" > esp_websocket_client_is_connected (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t" > esp_websocket_client_send_bin (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t" > esp_websocket_client_send_text (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t" > esp_websocket_client_send_with_opcode (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t" > esp_websocket_client_set_ping_interval_sec (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv428esp_websocket_client_set_uri29esp_websocket_client_handle_tPKc" > esp_websocket_client_set_uri (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv426esp_websocket_client_start29esp_websocket_client_handle_t" > esp_websocket_client_start (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv425esp_websocket_client_stop29esp_websocket_client_handle_t" > esp_websocket_client_stop (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv426esp_websocket_event_data_t" > esp_websocket_event_data_t (C++ struct)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N26esp_websocket_event_data_t6clientE" > esp_websocket_event_data_t::client (C++ member)< / a >
< / li >
< 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 >
< li > < a href = "index.html#_CPPv4N26esp_websocket_event_data_t11payload_lenE" > esp_websocket_event_data_t::payload_len (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N26esp_websocket_event_data_t14payload_offsetE" > esp_websocket_event_data_t::payload_offset (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N26esp_websocket_event_data_t12user_contextE" > esp_websocket_event_data_t::user_context (C++ member)< / a >
< / li >
< li > < a href = "index.html#_CPPv424esp_websocket_event_id_t" > esp_websocket_event_id_t (C++ enum)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE" > esp_websocket_event_id_t::WEBSOCKET_EVENT_ANY (C++ enumerator)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N24esp_websocket_event_id_t22WEBSOCKET_EVENT_CLOSEDE" > esp_websocket_event_id_t::WEBSOCKET_EVENT_CLOSED (C++ enumerator)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N24esp_websocket_event_id_t25WEBSOCKET_EVENT_CONNECTEDE" > esp_websocket_event_id_t::WEBSOCKET_EVENT_CONNECTED (C++ enumerator)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N24esp_websocket_event_id_t20WEBSOCKET_EVENT_DATAE" > esp_websocket_event_id_t::WEBSOCKET_EVENT_DATA (C++ enumerator)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N24esp_websocket_event_id_t28WEBSOCKET_EVENT_DISCONNECTEDE" > esp_websocket_event_id_t::WEBSOCKET_EVENT_DISCONNECTED (C++ enumerator)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N24esp_websocket_event_id_t21WEBSOCKET_EVENT_ERRORE" > esp_websocket_event_id_t::WEBSOCKET_EVENT_ERROR (C++ enumerator)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE" > esp_websocket_event_id_t::WEBSOCKET_EVENT_MAX (C++ enumerator)< / a >
< / li >
< li > < a href = "index.html#_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv" > esp_websocket_register_events (C++ function)< / a >
< / li >
< li > < a href = "index.html#_CPPv425esp_websocket_transport_t" > esp_websocket_transport_t (C++ enum)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_SSLE" > esp_websocket_transport_t::WEBSOCKET_TRANSPORT_OVER_SSL (C++ enumerator)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_TCPE" > esp_websocket_transport_t::WEBSOCKET_TRANSPORT_OVER_TCP (C++ enumerator)< / a >
< / li >
< li > < a href = "index.html#_CPPv4N25esp_websocket_transport_t27WEBSOCKET_TRANSPORT_UNKNOWNE" > esp_websocket_transport_t::WEBSOCKET_TRANSPORT_UNKNOWN (C++ enumerator)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
< p > © Copyright 2016 - 2022, Espressif Systems (Shanghai) Co., Ltd.< / p >
< / div >
< ul class = "footer" >
< li >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/espressif/sphinx_idf_theme" > theme< / a > based on < a href = "https://github.com/readthedocs/sphinx_rtd_theme" > Read the Docs Sphinx Theme< / a > .
< / li >
< li class = "footer-aside" >
< a href = "./esp-idf-en-master-esp32.pdf" class = "fa fa-file-pdf-o" > Download PDF< / a >
< / li >
< / ul >
< / footer >
< / div >
< / div >
< / section >
< / div >
< script >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
