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:
@@ -250,7 +250,7 @@ In case a host operating system has openssl and sed pa
@@ -387,6 +387,30 @@ In case a host operating system has openssl and sed pa
+
+-
+int esp_websocket_client_send_with_opcode(esp_websocket_client_handle_t client, ws_transport_opcodes_t opcode, const uint8_t *data, int len, TickType_t timeout)
+Write opcode data to the WebSocket connection.
+
+- Parameters:
+-
+
+- Returns:
+
+Number of data was sent
(-1) if any errors
+
+
+
+
-
esp_err_t esp_websocket_client_close(esp_websocket_client_handle_t client, TickType_t timeout)
diff --git a/esp_websocket_client/objects.inv b/esp_websocket_client/objects.inv
index b5d587949..2865eaa18 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 8041a2063..9cb16be24 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, "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, "uint8_t": 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, "_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_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"], "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
diff --git a/mdns/en/.buildinfo b/mdns/en/.buildinfo
index 1ab824974..b7b947b92 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: 59638e7c422d6aacbc2d9d6d08d2cde1
+config: 0cb3bc28b3e0de897c39d75337d3d0d5
tags: 549b3d6d0415232fb7e35403b330ff49
diff --git a/mdns/en/genindex.html b/mdns/en/genindex.html
index c7fbbb2f6..30a3ca5ad 100644
--- a/mdns/en/genindex.html
+++ b/mdns/en/genindex.html
@@ -91,7 +91,7 @@
»
Index
- Edit on GitHub
+ Edit on GitHub
diff --git a/mdns/en/index.html b/mdns/en/index.html
index a15bf924f..539223d14 100644
--- a/mdns/en/index.html
+++ b/mdns/en/index.html
@@ -116,7 +116,7 @@
»
mDNS Service
- Edit on GitHub
+ Edit on GitHub
@@ -319,14 +319,14 @@
Application Example
-mDNS server/scanner example: .
+mDNS server/scanner example: .
API Reference
diff --git a/mdns/zh_CN/.buildinfo b/mdns/zh_CN/.buildinfo
index 076ae1a12..4e0dc0bf3 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: 061a526b702241753ea0dec13dd08852
+config: 894aa395b7c8ddb0f450e618e587f02d
tags: 549b3d6d0415232fb7e35403b330ff49
diff --git a/mdns/zh_CN/genindex.html b/mdns/zh_CN/genindex.html
index 521911197..787ad1149 100644
--- a/mdns/zh_CN/genindex.html
+++ b/mdns/zh_CN/genindex.html
@@ -92,7 +92,7 @@
»
索引
- 在 GitHub 上修改
+ 在 GitHub 上修改
diff --git a/mdns/zh_CN/index.html b/mdns/zh_CN/index.html
index e5c61025e..93b21e521 100644
--- a/mdns/zh_CN/index.html
+++ b/mdns/zh_CN/index.html
@@ -114,7 +114,7 @@
»
mDNS 服务
- 在 GitHub 上修改
+ 在 GitHub 上修改
@@ -298,14 +298,14 @@
应用示例
-有关 mDNS 服务器和查询器的应用示例请参考 。
+有关 mDNS 服务器和查询器的应用示例请参考 。