diff --git a/asio/.buildinfo b/asio/.buildinfo index 7ad21b2fd..94a76938c 100644 --- a/asio/.buildinfo +++ b/asio/.buildinfo @@ -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: 1ab6dfdf454698f7bf7502a427e9423a +config: 6481ea716ed2d9655cce6caea6803f5d tags: 549b3d6d0415232fb7e35403b330ff49 diff --git a/asio/genindex.html b/asio/genindex.html index c66d01bd5..591be7aa0 100644 --- a/asio/genindex.html +++ b/asio/genindex.html @@ -89,7 +89,7 @@
  • »
  • Index
  • - Edit on GitHub + Edit on GitHub
    • diff --git a/asio/index.html b/asio/index.html index a1efbad79..46093cabf 100644 --- a/asio/index.html +++ b/asio/index.html @@ -101,7 +101,7 @@
  • »
  • ASIO port
  • - Edit on GitHub + Edit on GitHub
    • @@ -142,12 +142,12 @@ SSL/TLS support is disabled by default and could be enabled in component configu

    Application Example

    -

    ESP examples are based on standard asio examples :

    +

    ESP examples are based on standard asio examples :

    Please refer to the specific example README.md for details

    diff --git a/esp_modem/.doctrees/environment.pickle b/esp_modem/.doctrees/environment.pickle index daa31e547..3c91ac133 100644 Binary files a/esp_modem/.doctrees/environment.pickle and b/esp_modem/.doctrees/environment.pickle differ diff --git a/esp_websocket_client/.buildinfo b/esp_websocket_client/.buildinfo index 01aeda09a..7e1e73283 100644 --- a/esp_websocket_client/.buildinfo +++ b/esp_websocket_client/.buildinfo @@ -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: 6b5d04138319cf30632fcb0034285227 +config: ad317e982af0c52b41cf4956f154d959 tags: 549b3d6d0415232fb7e35403b330ff49 diff --git a/esp_websocket_client/genindex.html b/esp_websocket_client/genindex.html index ae2ca9ab8..1d78f7856 100644 --- a/esp_websocket_client/genindex.html +++ b/esp_websocket_client/genindex.html @@ -89,7 +89,7 @@
  • »
  • Index
  • - Edit on GitHub + Edit on GitHub
    • @@ -179,8 +179,6 @@
  • esp_websocket_client_config_t::user_agent (C++ member)
    • - - +
    @@ -234,7 +234,7 @@ In case a host operating system has openssl and sed pa

    Application Example

    -

    A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the websocket.org server can be found here: example .

    +

    A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the websocket.org server can be found here: example .

    Sending Text Data

    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:

    @@ -248,7 +248,7 @@ In case a host operating system has openssl and sed pa

    Header File

    @@ -288,6 +288,26 @@ In case a host operating system has openssl and sed pa +
    +
    +esp_err_t esp_websocket_client_set_headers(esp_websocket_client_handle_t client, const char *headers)
    +

    Set additional websocket headers for the client, when performing this behavior, the headers will replace the old ones.

    +
    +
    Parameters
    +
      +

    • client – [in] The client

      • +

    • headers – additional header strings each terminated with \r

      • +
    +
    +
    Pre
    +

    Must stop the WebSocket client before set headers if the client has been connected

    +
    +
    Returns
    +

    esp_err_t

    +
    +
    +
    +
    esp_err_t esp_websocket_client_start(esp_websocket_client_handle_t client)
    @@ -551,6 +571,45 @@ In case a host operating system has openssl and sed pa

    Structures

    +
    +
    +struct esp_websocket_error_codes_t
    +

    Websocket error code structure to be passed as a contextual information into ERROR event.

    +
    +

    Public Members

    +
    +
    +esp_err_t esp_tls_last_esp_err
    +

    last esp_err code reported from esp-tls component

    +
    + +
    +
    +int esp_tls_stack_err
    +

    tls specific error code reported from underlying tls stack

    +
    + +
    +
    +int esp_tls_cert_verify_flags
    +

    tls flags reported from underlying tls stack during certificate verification

    +
    + +
    +
    +int esp_ws_handshake_status_code
    +

    http status code of the websocket upgrade handshake

    +
    + +
    +
    +int esp_transport_sock_errno
    +

    errno from the underlying socket

    +
    + +
    +
    +
    struct esp_websocket_event_data_t
    @@ -605,6 +664,12 @@ In case a host operating system has openssl and sed pa

    Actual offset for the data associated with this event

    +
    +
    +esp_websocket_error_codes_t error_handle
    +

    esp-websocket error handle including esp-tls errors as well as internal websocket errors

    +
    + @@ -878,6 +943,12 @@ In case a host operating system has openssl and sed pa

    The connection has been closed cleanly

    +
    +
    +enumerator WEBSOCKET_EVENT_BEFORE_CONNECT
    +

    The event occurs before connecting

    +
    +
    enumerator WEBSOCKET_EVENT_MAX
    @@ -885,6 +956,33 @@ In case a host operating system has openssl and sed pa
    +
    +
    +enum esp_websocket_error_type_t
    +

    Websocket connection error codes propagated via ERROR event.

    +

    Values:

    +
    +
    +enumerator WEBSOCKET_ERROR_TYPE_NONE
    +
    + +
    +
    +enumerator WEBSOCKET_ERROR_TYPE_TCP_TRANSPORT
    +
    + +
    +
    +enumerator WEBSOCKET_ERROR_TYPE_PONG_TIMEOUT
    +
    + +
    +
    +enumerator WEBSOCKET_ERROR_TYPE_HANDSHAKE
    +
    + +
    +
    enum esp_websocket_transport_t
    diff --git a/esp_websocket_client/objects.inv b/esp_websocket_client/objects.inv index 6f0a9f5a4..d681213a2 100644 Binary files a/esp_websocket_client/objects.inv and b/esp_websocket_client/objects.inv differ diff --git a/esp_websocket_client/searchindex.js b/esp_websocket_client/searchindex.js index f83446d91..9d071e312 100644 --- a/esp_websocket_client/searchindex.js +++ b/esp_websocket_client/searchindex.js @@ -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::ping_interval_sec"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t20pingpong_timeout_secE","esp_websocket_client_config_t::pingpong_timeout_sec"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4portE","esp_websocket_client_config_t::port"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t20reconnect_timeout_msE","esp_websocket_client_config_t::reconnect_timeout_ms"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t27skip_cert_common_name_checkE","esp_websocket_client_config_t::skip_cert_common_name_check"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11subprotocolE","esp_websocket_client_config_t::subprotocol"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t9task_nameE","esp_websocket_client_config_t::task_name"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t9task_prioE","esp_websocket_client_config_t::task_prio"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t10task_stackE","esp_websocket_client_config_t::task_stack"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t9transportE","esp_websocket_client_config_t::transport"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t3uriE","esp_websocket_client_config_t::uri"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t19use_global_ca_storeE","esp_websocket_client_config_t::use_global_ca_store"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t10user_agentE","esp_websocket_client_config_t::user_agent"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t12user_contextE","esp_websocket_client_config_t::user_context"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8usernameE","esp_websocket_client_config_t::username"],[0,1,1,"_CPPv428esp_websocket_client_destroy29esp_websocket_client_handle_t","esp_websocket_client_destroy"],[0,2,1,"_CPPv428esp_websocket_client_destroy29esp_websocket_client_handle_t","esp_websocket_client_destroy::client"],[0,1,1,"_CPPv436esp_websocket_client_destroy_on_exit29esp_websocket_client_handle_t","esp_websocket_client_destroy_on_exit"],[0,2,1,"_CPPv436esp_websocket_client_destroy_on_exit29esp_websocket_client_handle_t","esp_websocket_client_destroy_on_exit::client"],[0,1,1,"_CPPv442esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t","esp_websocket_client_get_ping_interval_sec"],[0,2,1,"_CPPv442esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t","esp_websocket_client_get_ping_interval_sec::client"],[0,5,1,"_CPPv429esp_websocket_client_handle_t","esp_websocket_client_handle_t"],[0,1,1,"_CPPv425esp_websocket_client_initPK29esp_websocket_client_config_t","esp_websocket_client_init"],[0,2,1,"_CPPv425esp_websocket_client_initPK29esp_websocket_client_config_t","esp_websocket_client_init::config"],[0,1,1,"_CPPv433esp_websocket_client_is_connected29esp_websocket_client_handle_t","esp_websocket_client_is_connected"],[0,2,1,"_CPPv433esp_websocket_client_is_connected29esp_websocket_client_handle_t","esp_websocket_client_is_connected::client"],[0,1,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin"],[0,2,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin::client"],[0,2,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin::data"],[0,2,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin::len"],[0,2,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin::timeout"],[0,1,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text"],[0,2,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text::client"],[0,2,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text::data"],[0,2,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text::len"],[0,2,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text::timeout"],[0,1,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::client"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::data"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::len"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::opcode"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::timeout"],[0,1,1,"_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t","esp_websocket_client_set_ping_interval_sec"],[0,2,1,"_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t","esp_websocket_client_set_ping_interval_sec::client"],[0,2,1,"_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t","esp_websocket_client_set_ping_interval_sec::ping_interval_sec"],[0,1,1,"_CPPv428esp_websocket_client_set_uri29esp_websocket_client_handle_tPKc","esp_websocket_client_set_uri"],[0,2,1,"_CPPv428esp_websocket_client_set_uri29esp_websocket_client_handle_tPKc","esp_websocket_client_set_uri::client"],[0,2,1,"_CPPv428esp_websocket_client_set_uri29esp_websocket_client_handle_tPKc","esp_websocket_client_set_uri::uri"],[0,1,1,"_CPPv426esp_websocket_client_start29esp_websocket_client_handle_t","esp_websocket_client_start"],[0,2,1,"_CPPv426esp_websocket_client_start29esp_websocket_client_handle_t","esp_websocket_client_start::client"],[0,1,1,"_CPPv425esp_websocket_client_stop29esp_websocket_client_handle_t","esp_websocket_client_stop"],[0,2,1,"_CPPv425esp_websocket_client_stop29esp_websocket_client_handle_t","esp_websocket_client_stop::client"],[0,3,1,"_CPPv426esp_websocket_event_data_t","esp_websocket_event_data_t"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t6clientE","esp_websocket_event_data_t::client"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t8data_lenE","esp_websocket_event_data_t::data_len"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t8data_ptrE","esp_websocket_event_data_t::data_ptr"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t3finE","esp_websocket_event_data_t::fin"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t7op_codeE","esp_websocket_event_data_t::op_code"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t11payload_lenE","esp_websocket_event_data_t::payload_len"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t14payload_offsetE","esp_websocket_event_data_t::payload_offset"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t12user_contextE","esp_websocket_event_data_t::user_context"],[0,6,1,"_CPPv424esp_websocket_event_id_t","esp_websocket_event_id_t"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE","esp_websocket_event_id_t::WEBSOCKET_EVENT_ANY"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t22WEBSOCKET_EVENT_CLOSEDE","esp_websocket_event_id_t::WEBSOCKET_EVENT_CLOSED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t25WEBSOCKET_EVENT_CONNECTEDE","esp_websocket_event_id_t::WEBSOCKET_EVENT_CONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t20WEBSOCKET_EVENT_DATAE","esp_websocket_event_id_t::WEBSOCKET_EVENT_DATA"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t28WEBSOCKET_EVENT_DISCONNECTEDE","esp_websocket_event_id_t::WEBSOCKET_EVENT_DISCONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t21WEBSOCKET_EVENT_ERRORE","esp_websocket_event_id_t::WEBSOCKET_EVENT_ERROR"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE","esp_websocket_event_id_t::WEBSOCKET_EVENT_MAX"],[0,1,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events"],[0,2,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events::client"],[0,2,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events::event"],[0,2,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events::event_handler"],[0,2,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events::event_handler_arg"],[0,6,1,"_CPPv425esp_websocket_transport_t","esp_websocket_transport_t"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_SSLE","esp_websocket_transport_t::WEBSOCKET_TRANSPORT_OVER_SSL"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_TCPE","esp_websocket_transport_t::WEBSOCKET_TRANSPORT_OVER_TCP"],[0,0,1,"_CPPv4N25esp_websocket_transport_t27WEBSOCKET_TRANSPORT_UNKNOWNE","esp_websocket_transport_t::WEBSOCKET_TRANSPORT_UNKNOWN"]]},objnames:{"0":["cpp","enumerator","C++ enumerator"],"1":["cpp","function","C++ function"],"2":["cpp","functionParam","C++ function parameter"],"3":["cpp","class","C++ class"],"4":["cpp","member","C++ member"],"5":["cpp","type","C++ type"],"6":["cpp","enum","C++ enum"]},objtypes:{"0":"cpp:enumerator","1":"cpp:function","2":"cpp:functionParam","3":"cpp:class","4":"cpp:member","5":"cpp:type","6":"cpp:enum"},terms:{"0":0,"01":0,"02":0,"1":0,"10":0,"104":0,"123":0,"3":0,"4":0,"443":0,"4567":0,"5":0,"7":0,"8":0,"80":0,"case":0,"char":0,"const":0,"default":0,"do":0,"enum":0,"int":0,"new":0,"null":0,"public":0,"return":0,"true":0,"void":0,A:0,For:0,If:0,In:0,It:0,Not:0,The:0,abl:0,abort:0,accept:0,access:0,actual:0,addit:0,after:0,agent:0,aliv:0,all:0,also:0,an:0,ani:0,ar:0,associ:0,auth:0,authent:0,auto:0,automat:0,basic:0,becaus:0,been:0,befor:0,begin:0,behavior:0,below:0,binari:0,bool:0,both:0,buffer:0,buffer_s:0,bundl:0,ca:0,ca_stor:0,call:0,callback:0,can:0,cannot:0,cert_len:0,cert_pem:0,certfic:0,certif:0,chain:0,charact:0,check:0,clean:0,cleanli:0,client_cert:0,client_cert_len:0,client_kei:0,client_key_len:0,client_key_pem:0,close:0,cn:0,code:0,command:0,complet:0,conf:0,config:0,connect:0,connectionhandl:0,contain:0,context:0,correspond:0,could:0,count:0,crt_bundle_attach:0,current:0,custom:0,d:0,dangl:0,data_len:0,data_ptr:0,defin:0,depend:0,der:0,destroi:0,directli:0,disabl:0,disable_auto_reconnect:0,disable_pingpong_discon:0,disconnect:0,doe:0,domain:0,download:0,due:0,dure:0,e:0,easi:0,echo:0,enabl:0,encod:0,end:0,environ:0,error:0,esp32:0,esp_crt_bundl:0,esp_crt_bundle_attach:0,esp_err_t:0,esp_event_handler_t:0,esp_websocket_cli:0,esp_websocket_client_clos:0,esp_websocket_client_close_with_cod:0,esp_websocket_client_config_t:0,esp_websocket_client_destroi:0,esp_websocket_client_destroy_on_exit:0,esp_websocket_client_get_ping_interval_sec:0,esp_websocket_client_handle_t:0,esp_websocket_client_init:0,esp_websocket_client_is_connect:0,esp_websocket_client_send_bin:0,esp_websocket_client_send_text:0,esp_websocket_client_send_with_opcod:0,esp_websocket_client_set_ping_interval_sec:0,esp_websocket_client_set_uri:0,esp_websocket_client_start:0,esp_websocket_client_stop:0,esp_websocket_event_data_t:0,esp_websocket_event_id_t:0,esp_websocket_register_ev:0,esp_websocket_transport_t:0,establish:0,event_handl:0,event_handler_arg:0,exce:0,exceed:0,exchang:0,execut:0,extract:0,fail:0,fals:0,field:0,fin:0,finish:0,first:0,flag:0,follow:0,format:0,found:0,fragment:0,frame:0,free:0,from:0,g:0,get:0,global:0,go:0,good:0,h:0,ha:0,handl:0,handler:0,handler_arg:0,handshak:0,have:0,here:0,host:0,http:0,i:0,id:0,idl:0,if_nam:0,ifreq:0,implement:0,includ:0,indiffer:0,inform:0,initi:0,input:0,instal:0,instanc:0,interfac:0,intermedi:0,interv:0,ip:0,keep:0,keep_alive_count:0,keep_alive_en:0,keep_alive_idl:0,keep_alive_interv:0,kei:0,last:0,layer:0,len:0,length:0,like:0,linux:0,loop:0,mai:0,matter:0,mbedtl:0,mbedtls_certificate_bundl:0,member:0,menuconfig:0,messag:0,might:0,milisecond:0,millisecond:0,minim:0,more:0,multipl:0,must:0,mutual:0,n:0,name:0,nativ:0,need:0,network:0,network_timeout_m:0,never:0,non:0,note:0,now:0,number:0,occur:0,offset:0,old:0,onc:0,one:0,ones:0,onli:0,op_cod:0,opcod:0,open:0,openssl:0,oper:0,opposit:0,option:0,org:0,other:0,outform:0,over:0,overrid:0,overridden:0,p:0,packag:0,packet:0,paramet:0,pars:0,pass:0,password:0,path:0,payload:0,payload_len:0,payload_offset:0,pem:0,perform:0,period:0,ping:0,ping_interval_sec:0,pingpong_timeout_sec:0,pleas:0,point:0,pointer:0,pong:0,port:0,portion:0,portmax_delai:0,possibl:0,post:0,practic:0,prioriti:0,privat:0,protocol:0,provid:0,queri:0,read:0,readi:0,receiv:0,reconnect:0,reconnect_timeout_m:0,regist:0,relat:0,replac:0,repli:0,request:0,requir:0,resourc:0,respons:0,retri:0,rfc6455:0,root:0,rto:0,s_client:0,same:0,sampl:0,save:0,scheme:0,sec:0,second:0,section:0,sed:0,see:0,sent:0,sequenc:0,server:0,session:0,set:0,setup:0,should:0,showcert:0,simpl:0,size:0,size_t:0,skip:0,skip_cert_common_name_check:0,soap:0,ssl:0,stack:0,start:0,state:0,statu:0,stop:0,string:0,struct:0,successfulli:0,support:0,system:0,task:0,task_nam:0,task_prio:0,task_stack:0,tcp:0,termin:0,textual:0,thi:0,through:0,tick:0,ticktype_t:0,time:0,timeout:0,total:0,transport:0,typedef:0,uint8_t:0,unavail:0,unknown:0,until:0,url:0,us:0,use_global_ca_stor:0,user:0,user_ag:0,user_context:0,user_data:0,usernam:0,utf:0,valid:0,valu:0,verif:0,verifi:0,wa:0,wai:0,wait:0,want:0,websocket_client_config_t:0,websocket_event_ani:0,websocket_event_clos:0,websocket_event_connect:0,websocket_event_data:0,websocket_event_disconnect:0,websocket_event_error:0,websocket_event_max:0,websocket_org:0,websocket_org_pem_start:0,websocket_transport_over_ssl:0,websocket_transport_over_tcp:0,websocket_transport_unknown:0,well:0,what:0,when:0,which:0,window:0,within:0,without:0,would:0,write:0,ws:0,ws_cfg:0,ws_transport_opcodes_t:0,wss:0,x509:0,you:0},titles:["ESP WebSocket Client"],titleterms:{"function":0,api:0,applic:0,client:0,configur:0,data:0,definit:0,enumer:0,esp:0,event:0,exampl:0,featur:0,file:0,header:0,issu:0,known:0,limit:0,overview:0,refer:0,send:0,structur:0,subprotocol:0,text:0,tl:0,type:0,uri:0,websocket:0}}) \ No newline at end of file +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,"_CPPv4N26esp_websocket_error_type_t30WEBSOCKET_ERROR_TYPE_HANDSHAKEE","WEBSOCKET_ERROR_TYPE_HANDSHAKE"],[0,0,1,"_CPPv4N26esp_websocket_error_type_t25WEBSOCKET_ERROR_TYPE_NONEE","WEBSOCKET_ERROR_TYPE_NONE"],[0,0,1,"_CPPv4N26esp_websocket_error_type_t33WEBSOCKET_ERROR_TYPE_PONG_TIMEOUTE","WEBSOCKET_ERROR_TYPE_PONG_TIMEOUT"],[0,0,1,"_CPPv4N26esp_websocket_error_type_t34WEBSOCKET_ERROR_TYPE_TCP_TRANSPORTE","WEBSOCKET_ERROR_TYPE_TCP_TRANSPORT"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE","WEBSOCKET_EVENT_ANY"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t30WEBSOCKET_EVENT_BEFORE_CONNECTE","WEBSOCKET_EVENT_BEFORE_CONNECT"],[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::ping_interval_sec"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t20pingpong_timeout_secE","esp_websocket_client_config_t::pingpong_timeout_sec"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t4portE","esp_websocket_client_config_t::port"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t20reconnect_timeout_msE","esp_websocket_client_config_t::reconnect_timeout_ms"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t27skip_cert_common_name_checkE","esp_websocket_client_config_t::skip_cert_common_name_check"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t11subprotocolE","esp_websocket_client_config_t::subprotocol"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t9task_nameE","esp_websocket_client_config_t::task_name"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t9task_prioE","esp_websocket_client_config_t::task_prio"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t10task_stackE","esp_websocket_client_config_t::task_stack"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t9transportE","esp_websocket_client_config_t::transport"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t3uriE","esp_websocket_client_config_t::uri"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t19use_global_ca_storeE","esp_websocket_client_config_t::use_global_ca_store"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t10user_agentE","esp_websocket_client_config_t::user_agent"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t12user_contextE","esp_websocket_client_config_t::user_context"],[0,4,1,"_CPPv4N29esp_websocket_client_config_t8usernameE","esp_websocket_client_config_t::username"],[0,1,1,"_CPPv428esp_websocket_client_destroy29esp_websocket_client_handle_t","esp_websocket_client_destroy"],[0,2,1,"_CPPv428esp_websocket_client_destroy29esp_websocket_client_handle_t","esp_websocket_client_destroy::client"],[0,1,1,"_CPPv436esp_websocket_client_destroy_on_exit29esp_websocket_client_handle_t","esp_websocket_client_destroy_on_exit"],[0,2,1,"_CPPv436esp_websocket_client_destroy_on_exit29esp_websocket_client_handle_t","esp_websocket_client_destroy_on_exit::client"],[0,1,1,"_CPPv442esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t","esp_websocket_client_get_ping_interval_sec"],[0,2,1,"_CPPv442esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t","esp_websocket_client_get_ping_interval_sec::client"],[0,5,1,"_CPPv429esp_websocket_client_handle_t","esp_websocket_client_handle_t"],[0,1,1,"_CPPv425esp_websocket_client_initPK29esp_websocket_client_config_t","esp_websocket_client_init"],[0,2,1,"_CPPv425esp_websocket_client_initPK29esp_websocket_client_config_t","esp_websocket_client_init::config"],[0,1,1,"_CPPv433esp_websocket_client_is_connected29esp_websocket_client_handle_t","esp_websocket_client_is_connected"],[0,2,1,"_CPPv433esp_websocket_client_is_connected29esp_websocket_client_handle_t","esp_websocket_client_is_connected::client"],[0,1,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin"],[0,2,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin::client"],[0,2,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin::data"],[0,2,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin::len"],[0,2,1,"_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_bin::timeout"],[0,1,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text"],[0,2,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text::client"],[0,2,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text::data"],[0,2,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text::len"],[0,2,1,"_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t","esp_websocket_client_send_text::timeout"],[0,1,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::client"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::data"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::len"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::opcode"],[0,2,1,"_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t","esp_websocket_client_send_with_opcode::timeout"],[0,1,1,"_CPPv432esp_websocket_client_set_headers29esp_websocket_client_handle_tPKc","esp_websocket_client_set_headers"],[0,2,1,"_CPPv432esp_websocket_client_set_headers29esp_websocket_client_handle_tPKc","esp_websocket_client_set_headers::client"],[0,2,1,"_CPPv432esp_websocket_client_set_headers29esp_websocket_client_handle_tPKc","esp_websocket_client_set_headers::headers"],[0,1,1,"_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t","esp_websocket_client_set_ping_interval_sec"],[0,2,1,"_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t","esp_websocket_client_set_ping_interval_sec::client"],[0,2,1,"_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t","esp_websocket_client_set_ping_interval_sec::ping_interval_sec"],[0,1,1,"_CPPv428esp_websocket_client_set_uri29esp_websocket_client_handle_tPKc","esp_websocket_client_set_uri"],[0,2,1,"_CPPv428esp_websocket_client_set_uri29esp_websocket_client_handle_tPKc","esp_websocket_client_set_uri::client"],[0,2,1,"_CPPv428esp_websocket_client_set_uri29esp_websocket_client_handle_tPKc","esp_websocket_client_set_uri::uri"],[0,1,1,"_CPPv426esp_websocket_client_start29esp_websocket_client_handle_t","esp_websocket_client_start"],[0,2,1,"_CPPv426esp_websocket_client_start29esp_websocket_client_handle_t","esp_websocket_client_start::client"],[0,1,1,"_CPPv425esp_websocket_client_stop29esp_websocket_client_handle_t","esp_websocket_client_stop"],[0,2,1,"_CPPv425esp_websocket_client_stop29esp_websocket_client_handle_t","esp_websocket_client_stop::client"],[0,3,1,"_CPPv427esp_websocket_error_codes_t","esp_websocket_error_codes_t"],[0,4,1,"_CPPv4N27esp_websocket_error_codes_t25esp_tls_cert_verify_flagsE","esp_websocket_error_codes_t::esp_tls_cert_verify_flags"],[0,4,1,"_CPPv4N27esp_websocket_error_codes_t20esp_tls_last_esp_errE","esp_websocket_error_codes_t::esp_tls_last_esp_err"],[0,4,1,"_CPPv4N27esp_websocket_error_codes_t17esp_tls_stack_errE","esp_websocket_error_codes_t::esp_tls_stack_err"],[0,4,1,"_CPPv4N27esp_websocket_error_codes_t24esp_transport_sock_errnoE","esp_websocket_error_codes_t::esp_transport_sock_errno"],[0,4,1,"_CPPv4N27esp_websocket_error_codes_t28esp_ws_handshake_status_codeE","esp_websocket_error_codes_t::esp_ws_handshake_status_code"],[0,6,1,"_CPPv426esp_websocket_error_type_t","esp_websocket_error_type_t"],[0,0,1,"_CPPv4N26esp_websocket_error_type_t30WEBSOCKET_ERROR_TYPE_HANDSHAKEE","esp_websocket_error_type_t::WEBSOCKET_ERROR_TYPE_HANDSHAKE"],[0,0,1,"_CPPv4N26esp_websocket_error_type_t25WEBSOCKET_ERROR_TYPE_NONEE","esp_websocket_error_type_t::WEBSOCKET_ERROR_TYPE_NONE"],[0,0,1,"_CPPv4N26esp_websocket_error_type_t33WEBSOCKET_ERROR_TYPE_PONG_TIMEOUTE","esp_websocket_error_type_t::WEBSOCKET_ERROR_TYPE_PONG_TIMEOUT"],[0,0,1,"_CPPv4N26esp_websocket_error_type_t34WEBSOCKET_ERROR_TYPE_TCP_TRANSPORTE","esp_websocket_error_type_t::WEBSOCKET_ERROR_TYPE_TCP_TRANSPORT"],[0,3,1,"_CPPv426esp_websocket_event_data_t","esp_websocket_event_data_t"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t6clientE","esp_websocket_event_data_t::client"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t8data_lenE","esp_websocket_event_data_t::data_len"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t8data_ptrE","esp_websocket_event_data_t::data_ptr"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t12error_handleE","esp_websocket_event_data_t::error_handle"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t3finE","esp_websocket_event_data_t::fin"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t7op_codeE","esp_websocket_event_data_t::op_code"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t11payload_lenE","esp_websocket_event_data_t::payload_len"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t14payload_offsetE","esp_websocket_event_data_t::payload_offset"],[0,4,1,"_CPPv4N26esp_websocket_event_data_t12user_contextE","esp_websocket_event_data_t::user_context"],[0,6,1,"_CPPv424esp_websocket_event_id_t","esp_websocket_event_id_t"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE","esp_websocket_event_id_t::WEBSOCKET_EVENT_ANY"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t30WEBSOCKET_EVENT_BEFORE_CONNECTE","esp_websocket_event_id_t::WEBSOCKET_EVENT_BEFORE_CONNECT"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t22WEBSOCKET_EVENT_CLOSEDE","esp_websocket_event_id_t::WEBSOCKET_EVENT_CLOSED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t25WEBSOCKET_EVENT_CONNECTEDE","esp_websocket_event_id_t::WEBSOCKET_EVENT_CONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t20WEBSOCKET_EVENT_DATAE","esp_websocket_event_id_t::WEBSOCKET_EVENT_DATA"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t28WEBSOCKET_EVENT_DISCONNECTEDE","esp_websocket_event_id_t::WEBSOCKET_EVENT_DISCONNECTED"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t21WEBSOCKET_EVENT_ERRORE","esp_websocket_event_id_t::WEBSOCKET_EVENT_ERROR"],[0,0,1,"_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE","esp_websocket_event_id_t::WEBSOCKET_EVENT_MAX"],[0,1,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events"],[0,2,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events::client"],[0,2,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events::event"],[0,2,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events::event_handler"],[0,2,1,"_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv","esp_websocket_register_events::event_handler_arg"],[0,6,1,"_CPPv425esp_websocket_transport_t","esp_websocket_transport_t"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_SSLE","esp_websocket_transport_t::WEBSOCKET_TRANSPORT_OVER_SSL"],[0,0,1,"_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_TCPE","esp_websocket_transport_t::WEBSOCKET_TRANSPORT_OVER_TCP"],[0,0,1,"_CPPv4N25esp_websocket_transport_t27WEBSOCKET_TRANSPORT_UNKNOWNE","esp_websocket_transport_t::WEBSOCKET_TRANSPORT_UNKNOWN"]]},objnames:{"0":["cpp","enumerator","C++ enumerator"],"1":["cpp","function","C++ function"],"2":["cpp","functionParam","C++ function parameter"],"3":["cpp","class","C++ class"],"4":["cpp","member","C++ member"],"5":["cpp","type","C++ type"],"6":["cpp","enum","C++ enum"]},objtypes:{"0":"cpp:enumerator","1":"cpp:function","2":"cpp:functionParam","3":"cpp:class","4":"cpp:member","5":"cpp:type","6":"cpp:enum"},terms:{"0":0,"01":0,"02":0,"1":0,"10":0,"104":0,"123":0,"3":0,"4":0,"443":0,"4567":0,"5":0,"7":0,"8":0,"80":0,"case":0,"char":0,"const":0,"default":0,"do":0,"enum":0,"int":0,"new":0,"null":0,"public":0,"return":0,"true":0,"void":0,A:0,For:0,If:0,In:0,It:0,Not:0,The:0,abl:0,abort:0,accept:0,access:0,actual:0,addit:0,after:0,agent:0,aliv:0,all:0,also:0,an:0,ani:0,ar:0,associ:0,auth:0,authent:0,auto:0,automat:0,basic:0,becaus:0,been:0,befor:0,begin:0,behavior:0,below:0,binari:0,bool:0,both:0,buffer:0,buffer_s:0,bundl:0,ca:0,ca_stor:0,call:0,callback:0,can:0,cannot:0,cert_len:0,cert_pem:0,certfic:0,certif:0,chain:0,charact:0,check:0,clean:0,cleanli:0,client_cert:0,client_cert_len:0,client_kei:0,client_key_len:0,client_key_pem:0,close:0,cn:0,code:0,command:0,complet:0,compon:0,conf:0,config:0,connect:0,connectionhandl:0,contain:0,context:0,contextu:0,correspond:0,could:0,count:0,crt_bundle_attach:0,current:0,custom:0,d:0,dangl:0,data_len:0,data_ptr:0,defin:0,depend:0,der:0,destroi:0,directli:0,disabl:0,disable_auto_reconnect:0,disable_pingpong_discon:0,disconnect:0,doe:0,domain:0,download:0,due:0,dure:0,e:0,each:0,easi:0,echo:0,enabl:0,encod:0,end:0,environ:0,errno:0,error:0,error_handl:0,esp32:0,esp_crt_bundl:0,esp_crt_bundle_attach:0,esp_err:0,esp_err_t:0,esp_event_handler_t:0,esp_tls_cert_verify_flag:0,esp_tls_last_esp_err:0,esp_tls_stack_err:0,esp_transport_sock_errno:0,esp_websocket_cli:0,esp_websocket_client_clos:0,esp_websocket_client_close_with_cod:0,esp_websocket_client_config_t:0,esp_websocket_client_destroi:0,esp_websocket_client_destroy_on_exit:0,esp_websocket_client_get_ping_interval_sec:0,esp_websocket_client_handle_t:0,esp_websocket_client_init:0,esp_websocket_client_is_connect:0,esp_websocket_client_send_bin:0,esp_websocket_client_send_text:0,esp_websocket_client_send_with_opcod:0,esp_websocket_client_set_head:0,esp_websocket_client_set_ping_interval_sec:0,esp_websocket_client_set_uri:0,esp_websocket_client_start:0,esp_websocket_client_stop:0,esp_websocket_error_codes_t:0,esp_websocket_error_type_t:0,esp_websocket_event_data_t:0,esp_websocket_event_id_t:0,esp_websocket_register_ev:0,esp_websocket_transport_t:0,esp_ws_handshake_status_cod:0,establish:0,event_handl:0,event_handler_arg:0,exce:0,exceed:0,exchang:0,execut:0,extract:0,fail:0,fals:0,field:0,fin:0,finish:0,first:0,flag:0,follow:0,format:0,found:0,fragment:0,frame:0,free:0,from:0,g:0,get:0,global:0,go:0,good:0,h:0,ha:0,handl:0,handler:0,handler_arg:0,handshak:0,have:0,here:0,host:0,http:0,i:0,id:0,idl:0,if_nam:0,ifreq:0,implement:0,includ:0,indiffer:0,inform:0,initi:0,input:0,instal:0,instanc:0,interfac:0,intermedi:0,intern:0,interv:0,ip:0,keep:0,keep_alive_count:0,keep_alive_en:0,keep_alive_idl:0,keep_alive_interv:0,kei:0,last:0,layer:0,len:0,length:0,like:0,linux:0,loop:0,mai:0,matter:0,mbedtl:0,mbedtls_certificate_bundl:0,member:0,menuconfig:0,messag:0,might:0,milisecond:0,millisecond:0,minim:0,more:0,multipl:0,must:0,mutual:0,n:0,name:0,nativ:0,need:0,network:0,network_timeout_m:0,never:0,non:0,note:0,now:0,number:0,occur:0,offset:0,old:0,onc:0,one:0,ones:0,onli:0,op_cod:0,opcod:0,open:0,openssl:0,oper:0,opposit:0,option:0,org:0,other:0,outform:0,over:0,overrid:0,overridden:0,p:0,packag:0,packet:0,paramet:0,pars:0,pass:0,password:0,path:0,payload:0,payload_len:0,payload_offset:0,pem:0,perform:0,period:0,ping:0,ping_interval_sec:0,pingpong_timeout_sec:0,pleas:0,point:0,pointer:0,pong:0,port:0,portion:0,portmax_delai:0,possibl:0,post:0,practic:0,pre:0,prioriti:0,privat:0,propag:0,protocol:0,provid:0,queri:0,r:0,read:0,readi:0,receiv:0,reconnect:0,reconnect_timeout_m:0,regist:0,relat:0,replac:0,repli:0,report:0,request:0,requir:0,resourc:0,respons:0,retri:0,rfc6455:0,root:0,rto:0,s_client:0,same:0,sampl:0,save:0,scheme:0,sec:0,second:0,section:0,sed:0,see:0,sent:0,sequenc:0,server:0,session:0,set:0,setup:0,should:0,showcert:0,simpl:0,size:0,size_t:0,skip:0,skip_cert_common_name_check:0,soap:0,socket:0,specif:0,ssl:0,stack:0,start:0,state:0,statu:0,stop:0,string:0,struct:0,successfulli:0,support:0,system:0,task:0,task_nam:0,task_prio:0,task_stack:0,tcp:0,termin:0,textual:0,thi:0,through:0,tick:0,ticktype_t:0,time:0,timeout:0,total:0,transport:0,typedef:0,uint8_t:0,unavail:0,underli:0,unknown:0,until:0,upgrad:0,url:0,us:0,use_global_ca_stor:0,user:0,user_ag:0,user_context:0,user_data:0,usernam:0,utf:0,valid:0,valu:0,verif:0,verifi:0,via:0,wa:0,wai:0,wait:0,want:0,websocket_client_config_t:0,websocket_error_type_handshak:0,websocket_error_type_non:0,websocket_error_type_pong_timeout:0,websocket_error_type_tcp_transport:0,websocket_event_ani:0,websocket_event_before_connect:0,websocket_event_clos:0,websocket_event_connect:0,websocket_event_data:0,websocket_event_disconnect:0,websocket_event_error:0,websocket_event_max:0,websocket_org:0,websocket_org_pem_start:0,websocket_transport_over_ssl:0,websocket_transport_over_tcp:0,websocket_transport_unknown:0,well:0,what:0,when:0,which:0,window:0,within:0,without:0,would:0,write:0,ws:0,ws_cfg:0,ws_transport_opcodes_t:0,wss:0,x509:0,you:0},titles:["ESP WebSocket Client"],titleterms:{"function":0,api:0,applic:0,client:0,configur:0,data:0,definit:0,enumer:0,esp:0,event:0,exampl:0,featur:0,file:0,header:0,issu:0,known:0,limit:0,overview:0,refer:0,send:0,structur:0,subprotocol:0,text:0,tl:0,type:0,uri:0,websocket:0}}) \ No newline at end of file diff --git a/mdns/en/.buildinfo b/mdns/en/.buildinfo index 7ad21b2fd..94a76938c 100644 --- a/mdns/en/.buildinfo +++ b/mdns/en/.buildinfo @@ -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: 1ab6dfdf454698f7bf7502a427e9423a +config: 6481ea716ed2d9655cce6caea6803f5d tags: 549b3d6d0415232fb7e35403b330ff49 diff --git a/mdns/en/genindex.html b/mdns/en/genindex.html index a059c5cce..52159534b 100644 --- a/mdns/en/genindex.html +++ b/mdns/en/genindex.html @@ -89,7 +89,7 @@
  • »
  • Index
  • - Edit on GitHub + Edit on GitHub
    • diff --git a/mdns/en/index.html b/mdns/en/index.html index 6e4d186ae..09b8ec8b4 100644 --- a/mdns/en/index.html +++ b/mdns/en/index.html @@ -114,7 +114,7 @@
  • »
  • mDNS Service
  • - Edit on GitHub + Edit on GitHub
    • @@ -317,14 +317,14 @@

    Application Example

    -

    mDNS server/scanner example: .

    +

    mDNS server/scanner example: .

    API Reference

    Header File

    diff --git a/mdns/zh_CN/.buildinfo b/mdns/zh_CN/.buildinfo index 448ce385f..cb286d287 100644 --- a/mdns/zh_CN/.buildinfo +++ b/mdns/zh_CN/.buildinfo @@ -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: 2d59ef2a66c5f14dcfebf1fd71b1be44 +config: 607d945fca710b76c54a776698df2a21 tags: 549b3d6d0415232fb7e35403b330ff49 diff --git a/mdns/zh_CN/genindex.html b/mdns/zh_CN/genindex.html index 525ebe412..25b05c888 100644 --- a/mdns/zh_CN/genindex.html +++ b/mdns/zh_CN/genindex.html @@ -90,7 +90,7 @@
  • »
  • 索引
  • - 在 GitHub 上修改 + 在 GitHub 上修改
    • diff --git a/mdns/zh_CN/index.html b/mdns/zh_CN/index.html index 3978e3fd2..dbc7534dd 100644 --- a/mdns/zh_CN/index.html +++ b/mdns/zh_CN/index.html @@ -112,7 +112,7 @@
  • »
  • mDNS 服务
  • - 在 GitHub 上修改 + 在 GitHub 上修改
    • @@ -296,14 +296,14 @@

    应用示例

    -

    有关 mDNS 服务器和查询器的应用示例请参考 。

    +

    有关 mDNS 服务器和查询器的应用示例请参考 。

    API 参考

    Header File