const esp_websocket_client_config_t ws_cfg = {
.uri = "wss://echo.websocket.org",
@@ -200,7 +198,7 @@ In case a host operating system has openssl and sed pa
This command will extract the second certificate in the chain and save it as a pem-file.
-Subprotocol
+Subprotocol
The subprotocol field in the config struct can be used to request a subprotocol
const esp_websocket_client_config_t ws_cfg = {
.uri = "ws://websocket.org",
@@ -216,7 +214,7 @@ In case a host operating system has openssl and sed pa
-Events
+Events
WEBSOCKET_EVENT_CONNECTED: The client has successfully established a connection to the server. The client is now ready to send and receive data. Contains no event data.
WEBSOCKET_EVENT_DISCONNECTED: The client has aborted the connection due to the transport layer failing to read data, e.g. because the server is unavailable. Contains no event data.
@@ -229,16 +227,16 @@ In case a host operating system has openssl and sed pa
-Limitations and Known Issues
+Limitations and Known Issues
-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 .
+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 .
-Sending Text Data
+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:
esp_websocket_client_send_text(client, data, len, portMAX_DELAY);
@@ -246,24 +244,24 @@ In case a host operating system has
openssl and
sed pa
-API Reference
+API Reference
-Functions
+Functions
-
esp_websocket_client_handle_t esp_websocket_client_init(const esp_websocket_client_config_t *config)
Start a Websocket session This function must be the first function to call, and it returns a esp_websocket_client_handle_t that you must use as input to other functions in the interface. This call MUST have a corresponding call to esp_websocket_client_destroy when the operation is complete.
-- Parameters:
+- Parameters
config – [in] The configuration
-- Returns:
+- Returns
esp_websocket_client_handle_t
NULL if any errors
@@ -278,13 +276,13 @@ In case a host operating system has openssl and sed pa
esp_err_t esp_websocket_client_set_uri(esp_websocket_client_handle_t client, const char *uri)
Set URL for client, when performing this behavior, the options in the URL will replace the old ones Must stop the WebSocket client before set URI if the client has been connected.
-- Parameters:
+- Parameters
client – [in] The client
uri – [in] The uri
-- Returns:
+- Returns
esp_err_t
@@ -295,10 +293,10 @@ In case a host operating system has openssl and sed pa
esp_err_t esp_websocket_client_start(esp_websocket_client_handle_t client)
Open the WebSocket connection.
-- Parameters:
+- Parameters
client – [in] The client
-- Returns:
+- Returns
esp_err_t
@@ -314,10 +312,10 @@ In case a host operating system has openssl and sed pa
-- Parameters:
+- Parameters
client – [in] The client
-- Returns:
+- Returns
esp_err_t
@@ -332,10 +330,10 @@ In case a host operating system has openssl and sed pa
-- Parameters:
+- Parameters
client – [in] The client
-- Returns:
+- Returns
esp_err_t
@@ -346,7 +344,7 @@ In case a host operating system has openssl and sed pa
int esp_websocket_client_send_bin(esp_websocket_client_handle_t client, const char *data, int len, TickType_t timeout)
Write binary data to the WebSocket connection (data send with WS OPCODE=02, i.e. binary)
-- Parameters:
+- Parameters
-
-- Returns:
+- Returns
-Structures
+Structures
-
struct esp_websocket_event_data_t
@@ -807,7 +805,7 @@ In case a host operating system has openssl and sed pa
-Type Definitions
+Type Definitions
-
typedef struct esp_websocket_client *esp_websocket_client_handle_t
@@ -815,7 +813,7 @@ In case a host operating system has openssl and sed pa
-Enumerations
+Enumerations
-
enum esp_websocket_event_id_t
diff --git a/esp_websocket_client/search.html b/esp_websocket_client/search.html
index a355e39d0..2d41b3b5e 100644
--- a/esp_websocket_client/search.html
+++ b/esp_websocket_client/search.html
@@ -16,9 +16,7 @@
-
-
diff --git a/esp_websocket_client/searchindex.js b/esp_websocket_client/searchindex.js
index 9cb16be24..891ea9ae6 100644
--- a/esp_websocket_client/searchindex.js
+++ b/esp_websocket_client/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["index"], "filenames": ["index.rst"], "titles": ["ESP WebSocket Client"], "terms": {"The": 0, "i": 0, "an": 0, "implement": 0, "protocol": 0, "esp32": 0, "support": 0, "over": 0, "tcp": 0, "mbedtl": 0, "easi": 0, "setup": 0, "multipl": 0, "instanc": 0, "one": 0, "w": 0, "wss": 0, "scheme": 0, "sampl": 0, "echo": 0, "org": 0, "default": 0, "port": 0, "80": 0, "ssl": 0, "443": 0, "minim": 0, "const": 0, "esp_websocket_client_config_t": 0, "ws_cfg": 0, "us": 0, "both": 0, "path": 0, "queri": 0, "connectionhandl": 0, "id": 0, "104": 0, "If": 0, "ar": 0, "ani": 0, "option": 0, "relat": 0, "defin": 0, "overridden": 0, "123": 0, "4567": 0, "connect": 0, "cert_pem": 0, "char": 0, "websocket_org_pem_start": 0, "you": 0, "want": 0, "verifi": 0, "server": 0, "need": 0, "provid": 0, "certif": 0, "pem": 0, "format": 0, "websocket_client_config_t": 0, "certfic": 0, "requir": 0, "verif": 0, "thi": 0, "could": 0, "extract": 0, "from": 0, "openssl": 0, "s_client": 0, "command": 0, "In": 0, "case": 0, "host": 0, "oper": 0, "system": 0, "ha": 0, "sed": 0, "packag": 0, "instal": 0, "execut": 0, "follow": 0, "download": 0, "save": 0, "root": 0, "intermedi": 0, "note": 0, "window": 0, "user": 0, "linux": 0, "like": 0, "environ": 0, "nativ": 0, "mai": 0, "showcert": 0, "n": 0, "1": 0, "d": 0, "begin": 0, "end": 0, "p": 0, "x509": 0, "outform": 0, "websocket_org": 0, "second": 0, "chain": 0, "field": 0, "config": 0, "struct": 0, "can": 0, "request": 0, "soap": 0, "indiffer": 0, "respons": 0, "accept": 0, "matter": 0, "what": 0, "repli": 0, "For": 0, "more": 0, "pleas": 0, "below": 0, "websocket_event_connect": 0, "successfulli": 0, "establish": 0, "now": 0, "readi": 0, "receiv": 0, "contain": 0, "websocket_event_disconnect": 0, "abort": 0, "due": 0, "transport": 0, "layer": 0, "fail": 0, "read": 0, "e": 0, "g": 0, "becaus": 0, "unavail": 0, "websocket_event_data": 0, "pars": 0, "frame": 0, "pointer": 0, "payload": 0, "length": 0, "well": 0, "opcod": 0, "A": 0, "messag": 0, "fragment": 0, "exce": 0, "buffer": 0, "size": 0, "also": 0, "post": 0, "non": 0, "pong": 0, "close": 0, "websocket_event_error": 0, "Not": 0, "current": 0, "handl": 0, "handler": 0, "access": 0, "through": 0, "pass": 0, "esp_websocket_client_handle_t": 0, "handler_arg": 0, "abl": 0, "dure": 0, "handshak": 0, "doe": 0, "do": 0, "check": 0, "simpl": 0, "esp_websocket_cli": 0, "found": 0, "here": 0, "which": 0, "inform": 0, "encod": 0, "utf": 0, "8": 0, "esp_websocket_client_send_text": 0, "len": 0, "portmax_delai": 0, "includ": 0, "h": 0, "esp_websocket_client_init": 0, "start": 0, "session": 0, "must": 0, "first": 0, "call": 0, "return": 0, "input": 0, "other": 0, "interfac": 0, "have": 0, "correspond": 0, "esp_websocket_client_destroi": 0, "when": 0, "complet": 0, "paramet": 0, "null": 0, "error": 0, "esp_err_t": 0, "esp_websocket_client_set_uri": 0, "set": 0, "url": 0, "perform": 0, "behavior": 0, "replac": 0, "old": 0, "ones": 0, "stop": 0, "befor": 0, "been": 0, "esp_websocket_client_start": 0, "open": 0, "esp_websocket_client_stop": 0, "without": 0, "directli": 0, "It": 0, "good": 0, "practic": 0, "clean": 0, "wai": 0, "esp_websocket_client_clos": 0, "cannot": 0, "destroi": 0, "free": 0, "all": 0, "resourc": 0, "last": 0, "opposit": 0, "same": 0, "might": 0, "int": 0, "esp_websocket_client_send_bin": 0, "ticktype_t": 0, "timeout": 0, "write": 0, "binari": 0, "02": 0, "rto": 0, "tick": 0, "number": 0, "wa": 0, "sent": 0, "textual": 0, "01": 0, "esp_websocket_client_send_with_opcod": 0, "ws_transport_opcodes_t": 0, "uint8_t": 0, "sequenc": 0, "initi": 0, "wait": 0, "until": 0, "esp_websocket_client_close_with_cod": 0, "code": 0, "custom": 0, "statu": 0, "rfc6455": 0, "section": 0, "7": 0, "4": 0, "addit": 0, "bool": 0, "esp_websocket_client_is_connect": 0, "state": 0, "true": 0, "fals": 0, "size_t": 0, "esp_websocket_client_get_ping_interval_sec": 0, "get": 0, "ping": 0, "interv": 0, "sec": 0, "esp_websocket_client_set_ping_interval_sec": 0, "ping_interval_sec": 0, "new": 0, "esp_websocket_register_ev": 0, "esp_websocket_event_id_t": 0, "esp_event_handler_t": 0, "event_handl": 0, "void": 0, "event_handler_arg": 0, "regist": 0, "callback": 0, "context": 0, "esp_websocket_event_data_t": 0, "public": 0, "member": 0, "data_ptr": 0, "data_len": 0, "fin": 0, "flag": 0, "op_cod": 0, "user_context": 0, "user_data": 0, "payload_len": 0, "total": 0, "exceed": 0, "payload_offset": 0, "actual": 0, "offset": 0, "associ": 0, "overrid": 0, "domain": 0, "ip": 0, "string": 0, "depend": 0, "esp_websocket_transport_t": 0, "usernam": 0, "http": 0, "authent": 0, "password": 0, "disable_auto_reconnect": 0, "disabl": 0, "automat": 0, "reconnect": 0, "disconnect": 0, "task_prio": 0, "task": 0, "prioriti": 0, "task_stack": 0, "stack": 0, "buffer_s": 0, "der": 0, "termin": 0, "charact": 0, "cert_len": 0, "point": 0, "0": 0, "client_cert": 0, "mutual": 0, "client_kei": 0, "client_cert_len": 0, "privat": 0, "kei": 0, "client_key_len": 0, "client_key_pem": 0, "see": 0, "user_ag": 0, "agent": 0, "pingpong_timeout_sec": 0, "period": 0, "disable_pingpong_discon": 0, "auto": 0, "within": 0, "use_global_ca_stor": 0, "global": 0, "ca_stor": 0, "crt_bundle_attach": 0, "conf": 0, "esp_crt_bundle_attach": 0, "enabl": 0, "bundl": 0, "mbedtls_certificate_bundl": 0, "menuconfig": 0, "esp_crt_bundl": 0, "ca": 0, "skip_cert_common_name_check": 0, "skip": 0, "valid": 0, "cn": 0, "keep_alive_en": 0, "keep": 0, "aliv": 0, "keep_alive_idl": 0, "idl": 0, "time": 0, "5": 0, "keep_alive_interv": 0, "keep_alive_count": 0, "packet": 0, "retri": 0, "count": 0, "3": 0, "reconnect_timeout_m": 0, "after": 0, "valu": 0, "milisecond": 0, "10": 0, "network_timeout_m": 0, "network": 0, "millisecond": 0, "ifreq": 0, "if_nam": 0, "name": 0, "go": 0, "typedef": 0, "enum": 0, "websocket_event_ani": 0, "occur": 0, "onc": 0, "exchang": 0, "possibli": 0, "portion": 0, "websocket_event_clos": 0, "cleanli": 0, "websocket_event_max": 0, "websocket_transport_unknown": 0, "unknown": 0, "websocket_transport_over_tcp": 0, "websocket_transport_over_ssl": 0}, "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_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, "_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"]]}, "objtypes": {"0": "cpp:enumerator", "1": "cpp:function", "2": "cpp:functionParam", "3": "cpp:class", "4": "cpp:member", "5": "cpp:type", "6": "cpp:enum"}, "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"]}, "titleterms": {"esp": 0, "websocket": 0, "client": 0, "overview": 0, "featur": 0, "configur": 0, "uri": 0, "tl": 0, "subprotocol": 0, "event": 0, "limit": 0, "known": 0, "issu": 0, "applic": 0, "exampl": 0, "send": 0, "text": 0, "data": 0, "api": 0, "refer": 0, "header": 0, "file": 0, "function": 0, "structur": 0, "type": 0, "definit": 0, "enumer": 0}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "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": 57}, "alltitles": {"ESP WebSocket Client": [[0, "esp-websocket-client"]], "Overview": [[0, "overview"]], "Features": [[0, "features"]], "Configuration": [[0, "configuration"]], "URI": [[0, "uri"]], "TLS": [[0, "tls"]], "Subprotocol": [[0, "subprotocol"]], "Events": [[0, "events"]], "Limitations and Known Issues": [[0, "limitations-and-known-issues"]], "Application Example": [[0, "application-example"]], "Sending Text Data": [[0, "sending-text-data"]], "API Reference": [[0, "api-reference"]], "Header File": [[0, "header-file"]], "Functions": [[0, "functions"]], "Structures": [[0, "structures"]], "Type Definitions": [[0, "type-definitions"]], "Enumerations": [[0, "enumerations"]]}, "indexentries": {"esp_websocket_client_close (c++ function)": [[0, "_CPPv426esp_websocket_client_close29esp_websocket_client_handle_t10TickType_t"]], "esp_websocket_client_close_with_code (c++ function)": [[0, "_CPPv436esp_websocket_client_close_with_code29esp_websocket_client_handle_tiPKci10TickType_t"]], "esp_websocket_client_config_t (c++ struct)": [[0, "_CPPv429esp_websocket_client_config_t"]], "esp_websocket_client_config_t::buffer_size (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t11buffer_sizeE"]], "esp_websocket_client_config_t::cert_len (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t8cert_lenE"]], "esp_websocket_client_config_t::cert_pem (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t8cert_pemE"]], "esp_websocket_client_config_t::client_cert (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t11client_certE"]], "esp_websocket_client_config_t::client_cert_len (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t15client_cert_lenE"]], "esp_websocket_client_config_t::client_key (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t10client_keyE"]], "esp_websocket_client_config_t::client_key_len (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t14client_key_lenE"]], "esp_websocket_client_config_t::crt_bundle_attach (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t17crt_bundle_attachE"]], "esp_websocket_client_config_t::disable_auto_reconnect (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t22disable_auto_reconnectE"]], "esp_websocket_client_config_t::disable_pingpong_discon (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t23disable_pingpong_disconE"]], "esp_websocket_client_config_t::headers (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t7headersE"]], "esp_websocket_client_config_t::host (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t4hostE"]], "esp_websocket_client_config_t::if_name (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t7if_nameE"]], "esp_websocket_client_config_t::keep_alive_count (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t16keep_alive_countE"]], "esp_websocket_client_config_t::keep_alive_enable (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t17keep_alive_enableE"]], "esp_websocket_client_config_t::keep_alive_idle (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t15keep_alive_idleE"]], "esp_websocket_client_config_t::keep_alive_interval (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t19keep_alive_intervalE"]], "esp_websocket_client_config_t::network_timeout_ms (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t18network_timeout_msE"]], "esp_websocket_client_config_t::password (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t8passwordE"]], "esp_websocket_client_config_t::path (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t4pathE"]], "esp_websocket_client_config_t::ping_interval_sec (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t17ping_interval_secE"]], "esp_websocket_client_config_t::pingpong_timeout_sec (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t20pingpong_timeout_secE"]], "esp_websocket_client_config_t::port (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t4portE"]], "esp_websocket_client_config_t::reconnect_timeout_ms (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t20reconnect_timeout_msE"]], "esp_websocket_client_config_t::skip_cert_common_name_check (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t27skip_cert_common_name_checkE"]], "esp_websocket_client_config_t::subprotocol (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t11subprotocolE"]], "esp_websocket_client_config_t::task_prio (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t9task_prioE"]], "esp_websocket_client_config_t::task_stack (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t10task_stackE"]], "esp_websocket_client_config_t::transport (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t9transportE"]], "esp_websocket_client_config_t::uri (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t3uriE"]], "esp_websocket_client_config_t::use_global_ca_store (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t19use_global_ca_storeE"]], "esp_websocket_client_config_t::user_agent (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t10user_agentE"]], "esp_websocket_client_config_t::user_context (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t12user_contextE"]], "esp_websocket_client_config_t::username (c++ member)": [[0, "_CPPv4N29esp_websocket_client_config_t8usernameE"]], "esp_websocket_client_destroy (c++ function)": [[0, "_CPPv428esp_websocket_client_destroy29esp_websocket_client_handle_t"]], "esp_websocket_client_get_ping_interval_sec (c++ function)": [[0, "_CPPv442esp_websocket_client_get_ping_interval_sec29esp_websocket_client_handle_t"]], "esp_websocket_client_handle_t (c++ type)": [[0, "_CPPv429esp_websocket_client_handle_t"]], "esp_websocket_client_init (c++ function)": [[0, "_CPPv425esp_websocket_client_initPK29esp_websocket_client_config_t"]], "esp_websocket_client_is_connected (c++ function)": [[0, "_CPPv433esp_websocket_client_is_connected29esp_websocket_client_handle_t"]], "esp_websocket_client_send_bin (c++ function)": [[0, "_CPPv429esp_websocket_client_send_bin29esp_websocket_client_handle_tPKci10TickType_t"]], "esp_websocket_client_send_text (c++ function)": [[0, "_CPPv430esp_websocket_client_send_text29esp_websocket_client_handle_tPKci10TickType_t"]], "esp_websocket_client_send_with_opcode (c++ function)": [[0, "_CPPv437esp_websocket_client_send_with_opcode29esp_websocket_client_handle_t22ws_transport_opcodes_tPK7uint8_ti10TickType_t"]], "esp_websocket_client_set_ping_interval_sec (c++ function)": [[0, "_CPPv442esp_websocket_client_set_ping_interval_sec29esp_websocket_client_handle_t6size_t"]], "esp_websocket_client_set_uri (c++ function)": [[0, "_CPPv428esp_websocket_client_set_uri29esp_websocket_client_handle_tPKc"]], "esp_websocket_client_start (c++ function)": [[0, "_CPPv426esp_websocket_client_start29esp_websocket_client_handle_t"]], "esp_websocket_client_stop (c++ function)": [[0, "_CPPv425esp_websocket_client_stop29esp_websocket_client_handle_t"]], "esp_websocket_event_data_t (c++ struct)": [[0, "_CPPv426esp_websocket_event_data_t"]], "esp_websocket_event_data_t::client (c++ member)": [[0, "_CPPv4N26esp_websocket_event_data_t6clientE"]], "esp_websocket_event_data_t::data_len (c++ member)": [[0, "_CPPv4N26esp_websocket_event_data_t8data_lenE"]], "esp_websocket_event_data_t::data_ptr (c++ member)": [[0, "_CPPv4N26esp_websocket_event_data_t8data_ptrE"]], "esp_websocket_event_data_t::fin (c++ member)": [[0, "_CPPv4N26esp_websocket_event_data_t3finE"]], "esp_websocket_event_data_t::op_code (c++ member)": [[0, "_CPPv4N26esp_websocket_event_data_t7op_codeE"]], "esp_websocket_event_data_t::payload_len (c++ member)": [[0, "_CPPv4N26esp_websocket_event_data_t11payload_lenE"]], "esp_websocket_event_data_t::payload_offset (c++ member)": [[0, "_CPPv4N26esp_websocket_event_data_t14payload_offsetE"]], "esp_websocket_event_data_t::user_context (c++ member)": [[0, "_CPPv4N26esp_websocket_event_data_t12user_contextE"]], "esp_websocket_event_id_t (c++ enum)": [[0, "_CPPv424esp_websocket_event_id_t"]], "esp_websocket_event_id_t::websocket_event_any (c++ enumerator)": [[0, "_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_ANYE"]], "esp_websocket_event_id_t::websocket_event_closed (c++ enumerator)": [[0, "_CPPv4N24esp_websocket_event_id_t22WEBSOCKET_EVENT_CLOSEDE"]], "esp_websocket_event_id_t::websocket_event_connected (c++ enumerator)": [[0, "_CPPv4N24esp_websocket_event_id_t25WEBSOCKET_EVENT_CONNECTEDE"]], "esp_websocket_event_id_t::websocket_event_data (c++ enumerator)": [[0, "_CPPv4N24esp_websocket_event_id_t20WEBSOCKET_EVENT_DATAE"]], "esp_websocket_event_id_t::websocket_event_disconnected (c++ enumerator)": [[0, "_CPPv4N24esp_websocket_event_id_t28WEBSOCKET_EVENT_DISCONNECTEDE"]], "esp_websocket_event_id_t::websocket_event_error (c++ enumerator)": [[0, "_CPPv4N24esp_websocket_event_id_t21WEBSOCKET_EVENT_ERRORE"]], "esp_websocket_event_id_t::websocket_event_max (c++ enumerator)": [[0, "_CPPv4N24esp_websocket_event_id_t19WEBSOCKET_EVENT_MAXE"]], "esp_websocket_register_events (c++ function)": [[0, "_CPPv429esp_websocket_register_events29esp_websocket_client_handle_t24esp_websocket_event_id_t19esp_event_handler_tPv"]], "esp_websocket_transport_t (c++ enum)": [[0, "_CPPv425esp_websocket_transport_t"]], "esp_websocket_transport_t::websocket_transport_over_ssl (c++ enumerator)": [[0, "_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_SSLE"]], "esp_websocket_transport_t::websocket_transport_over_tcp (c++ enumerator)": [[0, "_CPPv4N25esp_websocket_transport_t28WEBSOCKET_TRANSPORT_OVER_TCPE"]], "esp_websocket_transport_t::websocket_transport_unknown (c++ enumerator)": [[0, "_CPPv4N25esp_websocket_transport_t27WEBSOCKET_TRANSPORT_UNKNOWNE"]]}})
\ 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,"_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_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,"_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,authent:0,auto:0,automat: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,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_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,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,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,non:0,note:0,now:0,number:0,occur:0,offset:0,old:0,onc:0,one:0,ones: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,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_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,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 1bd22d859..b6ad6ca11 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: e12145161279d5e00aed0f59b2c63a32
+config: b8f72f40903ff4c38ebe6ab9bb5c24a7
tags: 549b3d6d0415232fb7e35403b330ff49
diff --git a/mdns/en/_static/_sphinx_javascript_frameworks_compat.js b/mdns/en/_static/_sphinx_javascript_frameworks_compat.js
deleted file mode 100644
index 8549469dc..000000000
--- a/mdns/en/_static/_sphinx_javascript_frameworks_compat.js
+++ /dev/null
@@ -1,134 +0,0 @@
-/*
- * _sphinx_javascript_frameworks_compat.js
- * ~~~~~~~~~~
- *
- * Compatability shim for jQuery and underscores.js.
- *
- * WILL BE REMOVED IN Sphinx 6.0
- * xref RemovedInSphinx60Warning
- *
- */
-
-/**
- * select a different prefix for underscore
- */
-$u = _.noConflict();
-
-
-/**
- * small helper function to urldecode strings
- *
- * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
- */
-jQuery.urldecode = function(x) {
- if (!x) {
- return x
- }
- return decodeURIComponent(x.replace(/\+/g, ' '));
-};
-
-/**
- * small helper function to urlencode strings
- */
-jQuery.urlencode = encodeURIComponent;
-
-/**
- * This function returns the parsed url parameters of the
- * current request. Multiple values per key are supported,
- * it will always return arrays of strings for the value parts.
- */
-jQuery.getQueryParameters = function(s) {
- if (typeof s === 'undefined')
- s = document.location.search;
- var parts = s.substr(s.indexOf('?') + 1).split('&');
- var result = {};
- for (var i = 0; i < parts.length; i++) {
- var tmp = parts[i].split('=', 2);
- var key = jQuery.urldecode(tmp[0]);
- var value = jQuery.urldecode(tmp[1]);
- if (key in result)
- result[key].push(value);
- else
- result[key] = [value];
- }
- return result;
-};
-
-/**
- * highlight a given string on a jquery object by wrapping it in
- * span elements with the given class name.
- */
-jQuery.fn.highlightText = function(text, className) {
- function highlight(node, addItems) {
- if (node.nodeType === 3) {
- var val = node.nodeValue;
- var pos = val.toLowerCase().indexOf(text);
- if (pos >= 0 &&
- !jQuery(node.parentNode).hasClass(className) &&
- !jQuery(node.parentNode).hasClass("nohighlight")) {
- var span;
- var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
- if (isInSVG) {
- span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
- } else {
- span = document.createElement("span");
- span.className = className;
- }
- span.appendChild(document.createTextNode(val.substr(pos, text.length)));
- node.parentNode.insertBefore(span, node.parentNode.insertBefore(
- document.createTextNode(val.substr(pos + text.length)),
- node.nextSibling));
- node.nodeValue = val.substr(0, pos);
- if (isInSVG) {
- var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
- var bbox = node.parentElement.getBBox();
- rect.x.baseVal.value = bbox.x;
- rect.y.baseVal.value = bbox.y;
- rect.width.baseVal.value = bbox.width;
- rect.height.baseVal.value = bbox.height;
- rect.setAttribute('class', className);
- addItems.push({
- "parent": node.parentNode,
- "target": rect});
- }
- }
- }
- else if (!jQuery(node).is("button, select, textarea")) {
- jQuery.each(node.childNodes, function() {
- highlight(this, addItems);
- });
- }
- }
- var addItems = [];
- var result = this.each(function() {
- highlight(this, addItems);
- });
- for (var i = 0; i < addItems.length; ++i) {
- jQuery(addItems[i].parent).before(addItems[i].target);
- }
- return result;
-};
-
-/*
- * backward compatibility for jQuery.browser
- * This will be supported until firefox bug is fixed.
- */
-if (!jQuery.browser) {
- jQuery.uaMatch = function(ua) {
- ua = ua.toLowerCase();
-
- var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
- /(webkit)[ \/]([\w.]+)/.exec(ua) ||
- /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
- /(msie) ([\w.]+)/.exec(ua) ||
- ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
- [];
-
- return {
- browser: match[ 1 ] || "",
- version: match[ 2 ] || "0"
- };
- };
- jQuery.browser = {};
- jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
-}
diff --git a/mdns/en/_static/basic.css b/mdns/en/_static/basic.css
index 4e9a9f1fa..bf18350b6 100644
--- a/mdns/en/_static/basic.css
+++ b/mdns/en/_static/basic.css
@@ -222,7 +222,7 @@ table.modindextable td {
/* -- general body styles --------------------------------------------------- */
div.body {
- min-width: 360px;
+ min-width: 450px;
max-width: 800px;
}
@@ -237,6 +237,16 @@ a.headerlink {
visibility: hidden;
}
+a.brackets:before,
+span.brackets > a:before{
+ content: "[";
+}
+
+a.brackets:after,
+span.brackets > a:after {
+ content: "]";
+}
+
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
@@ -324,15 +334,13 @@ aside.sidebar {
p.sidebar-title {
font-weight: bold;
}
-nav.contents,
-aside.topic,
+
div.admonition, div.topic, blockquote {
clear: left;
}
/* -- topics ---------------------------------------------------------------- */
-nav.contents,
-aside.topic,
+
div.topic {
border: 1px solid #ccc;
padding: 7px;
@@ -371,8 +379,6 @@ div.body p.centered {
div.sidebar > :last-child,
aside.sidebar > :last-child,
-nav.contents > :last-child,
-aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
@@ -380,8 +386,6 @@ div.admonition > :last-child {
div.sidebar::after,
aside.sidebar::after,
-nav.contents::after,
-aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
@@ -424,6 +428,10 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}
+table.footnote td, table.footnote th {
+ border: 0 !important;
+}
+
th {
text-align: left;
padding-right: 5px;
@@ -606,26 +614,20 @@ ol.simple p,
ul.simple p {
margin-bottom: 0;
}
-aside.footnote > span,
-div.citation > span {
+
+dl.footnote > dt,
+dl.citation > dt {
float: left;
+ margin-right: 0.5em;
}
-aside.footnote > span:last-of-type,
-div.citation > span:last-of-type {
- padding-right: 0.5em;
-}
-aside.footnote > p {
- margin-left: 2em;
-}
-div.citation > p {
- margin-left: 4em;
-}
-aside.footnote > p:last-of-type,
-div.citation > p:last-of-type {
+
+dl.footnote > dd,
+dl.citation > dd {
margin-bottom: 0em;
}
-aside.footnote > p:last-of-type:after,
-div.citation > p:last-of-type:after {
+
+dl.footnote > dd:after,
+dl.citation > dd:after {
content: "";
clear: both;
}
@@ -642,6 +644,10 @@ dl.field-list > dt {
padding-right: 5px;
}
+dl.field-list > dt:after {
+ content: ":";
+}
+
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
diff --git a/mdns/en/_static/doctools.js b/mdns/en/_static/doctools.js
index 527b876ca..e1bfd708b 100644
--- a/mdns/en/_static/doctools.js
+++ b/mdns/en/_static/doctools.js
@@ -2,155 +2,357 @@
* doctools.js
* ~~~~~~~~~~~
*
- * Base JavaScript utilities for all Sphinx HTML documentation.
+ * Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
-"use strict";
-const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
- "TEXTAREA",
- "INPUT",
- "SELECT",
- "BUTTON",
-]);
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
-const _ready = (callback) => {
- if (document.readyState !== "loading") {
- callback();
- } else {
- document.addEventListener("DOMContentLoaded", callback);
+/**
+ * make the code below compatible with browsers without
+ * an installed firebug like debugger
+if (!window.console || !console.firebug) {
+ var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
+ "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
+ "profile", "profileEnd"];
+ window.console = {};
+ for (var i = 0; i < names.length; ++i)
+ window.console[names[i]] = function() {};
+}
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+ if (!x) {
+ return x
}
+ return decodeURIComponent(x.replace(/\+/g, ' '));
};
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+ if (typeof s === 'undefined')
+ s = document.location.search;
+ var parts = s.substr(s.indexOf('?') + 1).split('&');
+ var result = {};
+ for (var i = 0; i < parts.length; i++) {
+ var tmp = parts[i].split('=', 2);
+ var key = jQuery.urldecode(tmp[0]);
+ var value = jQuery.urldecode(tmp[1]);
+ if (key in result)
+ result[key].push(value);
+ else
+ result[key] = [value];
+ }
+ return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+ function highlight(node, addItems) {
+ if (node.nodeType === 3) {
+ var val = node.nodeValue;
+ var pos = val.toLowerCase().indexOf(text);
+ if (pos >= 0 &&
+ !jQuery(node.parentNode).hasClass(className) &&
+ !jQuery(node.parentNode).hasClass("nohighlight")) {
+ var span;
+ var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.className = className;
+ }
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+ document.createTextNode(val.substr(pos + text.length)),
+ node.nextSibling));
+ node.nodeValue = val.substr(0, pos);
+ if (isInSVG) {
+ var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+ var bbox = node.parentElement.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute('class', className);
+ addItems.push({
+ "parent": node.parentNode,
+ "target": rect});
+ }
+ }
+ }
+ else if (!jQuery(node).is("button, select, textarea")) {
+ jQuery.each(node.childNodes, function() {
+ highlight(this, addItems);
+ });
+ }
+ }
+ var addItems = [];
+ var result = this.each(function() {
+ highlight(this, addItems);
+ });
+ for (var i = 0; i < addItems.length; ++i) {
+ jQuery(addItems[i].parent).before(addItems[i].target);
+ }
+ return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+ jQuery.uaMatch = function(ua) {
+ ua = ua.toLowerCase();
+
+ var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+ /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+ /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+ /(msie) ([\w.]+)/.exec(ua) ||
+ ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+ [];
+
+ return {
+ browser: match[ 1 ] || "",
+ version: match[ 2 ] || "0"
+ };
+ };
+ jQuery.browser = {};
+ jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}
+
/**
* Small JavaScript module for the documentation.
*/
-const Documentation = {
- init: () => {
- Documentation.initDomainIndexTable();
- Documentation.initOnKeyListeners();
+var Documentation = {
+
+ init : function() {
+ this.fixFirefoxAnchorBug();
+ this.highlightSearchWords();
+ this.initIndexTable();
+ this.initOnKeyListeners();
},
/**
* i18n support
*/
- TRANSLATIONS: {},
- PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
- LOCALE: "unknown",
+ TRANSLATIONS : {},
+ PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
+ LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
- gettext: (string) => {
- const translated = Documentation.TRANSLATIONS[string];
- switch (typeof translated) {
- case "undefined":
- return string; // no translation
- case "string":
- return translated; // translation exists
- default:
- return translated[0]; // (singular, plural) translation tuple exists
+ gettext : function(string) {
+ var translated = Documentation.TRANSLATIONS[string];
+ if (typeof translated === 'undefined')
+ return string;
+ return (typeof translated === 'string') ? translated : translated[0];
+ },
+
+ ngettext : function(singular, plural, n) {
+ var translated = Documentation.TRANSLATIONS[singular];
+ if (typeof translated === 'undefined')
+ return (n == 1) ? singular : plural;
+ return translated[Documentation.PLURALEXPR(n)];
+ },
+
+ addTranslations : function(catalog) {
+ for (var key in catalog.messages)
+ this.TRANSLATIONS[key] = catalog.messages[key];
+ this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
+ this.LOCALE = catalog.locale;
+ },
+
+ /**
+ * add context elements like header anchor links
+ */
+ addContextElements : function() {
+ $('div[id] > :header:first').each(function() {
+ $('').
+ attr('href', '#' + this.id).
+ attr('title', _('Permalink to this headline')).
+ appendTo(this);
+ });
+ $('dt[id]').each(function() {
+ $('').
+ attr('href', '#' + this.id).
+ attr('title', _('Permalink to this definition')).
+ appendTo(this);
+ });
+ },
+
+ /**
+ * workaround a firefox stupidity
+ * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
+ */
+ fixFirefoxAnchorBug : function() {
+ if (document.location.hash && $.browser.mozilla)
+ window.setTimeout(function() {
+ document.location.href += '';
+ }, 10);
+ },
+
+ /**
+ * highlight the search words provided in the url in the text
+ */
+ highlightSearchWords : function() {
+ var params = $.getQueryParameters();
+ var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
+ if (terms.length) {
+ var body = $('div.body');
+ if (!body.length) {
+ body = $('body');
+ }
+ window.setTimeout(function() {
+ $.each(terms, function() {
+ body.highlightText(this.toLowerCase(), 'highlighted');
+ });
+ }, 10);
+ $('' + _('Hide Search Matches') + '
')
+ .appendTo($('#searchbox'));
}
},
- ngettext: (singular, plural, n) => {
- const translated = Documentation.TRANSLATIONS[singular];
- if (typeof translated !== "undefined")
- return translated[Documentation.PLURAL_EXPR(n)];
- return n === 1 ? singular : plural;
- },
-
- addTranslations: (catalog) => {
- Object.assign(Documentation.TRANSLATIONS, catalog.messages);
- Documentation.PLURAL_EXPR = new Function(
- "n",
- `return (${catalog.plural_expr})`
- );
- Documentation.LOCALE = catalog.locale;
+ /**
+ * init the domain index toggle buttons
+ */
+ initIndexTable : function() {
+ var togglers = $('img.toggler').click(function() {
+ var src = $(this).attr('src');
+ var idnum = $(this).attr('id').substr(7);
+ $('tr.cg-' + idnum).toggle();
+ if (src.substr(-9) === 'minus.png')
+ $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
+ else
+ $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
+ }).css('display', '');
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
+ togglers.click();
+ }
},
/**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords : function() {
+ $('#searchbox .highlight-link').fadeOut(300);
+ $('span.highlighted').removeClass('highlighted');
+ var url = new URL(window.location);
+ url.searchParams.delete('highlight');
+ window.history.replaceState({}, '', url);
+ },
+
+ /**
* helper function to focus on search bar
*/
- focusSearchBar: () => {
- document.querySelectorAll("input[name=q]")[0]?.focus();
+ focusSearchBar : function() {
+ $('input[name=q]').first().focus();
},
/**
- * Initialise the domain index toggle buttons
+ * make the url absolute
*/
- initDomainIndexTable: () => {
- const toggler = (el) => {
- const idNumber = el.id.substr(7);
- const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
- if (el.src.substr(-9) === "minus.png") {
- el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
- toggledRows.forEach((el) => (el.style.display = "none"));
- } else {
- el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
- toggledRows.forEach((el) => (el.style.display = ""));
- }
- };
-
- const togglerElements = document.querySelectorAll("img.toggler");
- togglerElements.forEach((el) =>
- el.addEventListener("click", (event) => toggler(event.currentTarget))
- );
- togglerElements.forEach((el) => (el.style.display = ""));
- if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
+ makeURL : function(relativeURL) {
+ return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
- initOnKeyListeners: () => {
+ /**
+ * get the current relative url
+ */
+ getCurrentURL : function() {
+ var path = document.location.pathname;
+ var parts = path.split(/\//);
+ $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
+ if (this === '..')
+ parts.pop();
+ });
+ var url = parts.join('/');
+ return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+ },
+
+ initOnKeyListeners: function() {
// only install a listener if it is really needed
- if (
- !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
- !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
- )
- return;
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+ !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+ return;
- document.addEventListener("keydown", (event) => {
- // bail for input elements
- if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
- // bail with special keys
- if (event.altKey || event.ctrlKey || event.metaKey) return;
+ $(document).keydown(function(event) {
+ var activeElementType = document.activeElement.tagName;
+ // don't navigate when in search box, textarea, dropdown or button
+ if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
+ && activeElementType !== 'BUTTON') {
+ if (event.altKey || event.ctrlKey || event.metaKey)
+ return;
- if (!event.shiftKey) {
+ if (!event.shiftKey) {
+ switch (event.key) {
+ case 'ArrowLeft':
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
+ break;
+ var prevHref = $('link[rel="prev"]').prop('href');
+ if (prevHref) {
+ window.location.href = prevHref;
+ return false;
+ }
+ break;
+ case 'ArrowRight':
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
+ break;
+ var nextHref = $('link[rel="next"]').prop('href');
+ if (nextHref) {
+ window.location.href = nextHref;
+ return false;
+ }
+ break;
+ case 'Escape':
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+ break;
+ Documentation.hideSearchWords();
+ return false;
+ }
+ }
+
+ // some keyboard layouts may need Shift to get /
switch (event.key) {
- case "ArrowLeft":
- if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
-
- const prevLink = document.querySelector('link[rel="prev"]');
- if (prevLink && prevLink.href) {
- window.location.href = prevLink.href;
- event.preventDefault();
- }
- break;
- case "ArrowRight":
- if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
-
- const nextLink = document.querySelector('link[rel="next"]');
- if (nextLink && nextLink.href) {
- window.location.href = nextLink.href;
- event.preventDefault();
- }
- break;
+ case '/':
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+ break;
+ Documentation.focusSearchBar();
+ return false;
}
}
-
- // some keyboard layouts may need Shift to get /
- switch (event.key) {
- case "/":
- if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
- Documentation.focusSearchBar();
- event.preventDefault();
- }
});
- },
+ }
};
// quick alias for translations
-const _ = Documentation.gettext;
+_ = Documentation.gettext;
-_ready(Documentation.init);
+$(document).ready(function() {
+ Documentation.init();
+});
diff --git a/mdns/en/_static/jquery-3.6.0.js b/mdns/en/_static/jquery-3.5.1.js
similarity index 98%
rename from mdns/en/_static/jquery-3.6.0.js
rename to mdns/en/_static/jquery-3.5.1.js
index fc6c299b7..50937333b 100644
--- a/mdns/en/_static/jquery-3.6.0.js
+++ b/mdns/en/_static/jquery-3.5.1.js
@@ -1,15 +1,15 @@
/*!
- * jQuery JavaScript Library v3.6.0
+ * jQuery JavaScript Library v3.5.1
* https://jquery.com/
*
* Includes Sizzle.js
* https://sizzlejs.com/
*
- * Copyright OpenJS Foundation and other contributors
+ * Copyright JS Foundation and other contributors
* Released under the MIT license
* https://jquery.org/license
*
- * Date: 2021-03-02T17:08Z
+ * Date: 2020-05-04T22:49Z
*/
( function( global, factory ) {
@@ -76,16 +76,12 @@ var support = {};
var isFunction = function isFunction( obj ) {
- // Support: Chrome <=57, Firefox <=52
- // In some browsers, typeof returns "function" for HTML
-Execution Speed
+Execution Speed
-Minimizing RAM Usage
+Minimizing RAM Usage
@@ -318,25 +316,25 @@
-Application Example
-mDNS server/scanner example: .
+Application Example
+mDNS server/scanner example: .
-API Reference
+API Reference
-Functions
+Functions
-
esp_err_t mdns_init(void)
Initialize mDNS on given interface.
-- Returns:
+- Returns
-- Parameters:
+- Parameters
instance_name – instance name to set. If NULL, global instance name or hostname will be used. Note that MDNS_MULTIPLE_INSTANCE config option needs to be enabled for adding multiple instances with the same instance type.
service_type – service type (_http, _ftp, etc)
@@ -472,7 +470,7 @@
num_items – number of items in TXT data
-- Returns:
+- Returns
ESP_OK success
ESP_ERR_INVALID_ARG Parameter error
@@ -493,7 +491,7 @@
The value length of txt items will be automatically decided by strlen
-- Parameters:
+- Parameters
instance_name – instance name to set. If NULL, global instance name or hostname will be used Note that MDNS_MULTIPLE_INSTANCE config option needs to be enabled for adding multiple instances with the same instance type.
service_type – service type (_http, _ftp, etc)
@@ -504,7 +502,7 @@
num_items – number of items in TXT data
-- Returns:
+- Returns