Chapter 2. API Reference
• ESP_OK on success
• ESP_FAIL if conversion failed
• ESP_ERR_INVALID_ARG if invalid parameter is passed into
Parameters
• [in] src: IPv6 address in ascii representation (e.g. “”
2001:0db8:85a3:0000:0000:0000:0002:0001”)
• [out] dst: Address of the target esp_ip6_addr_t structure to receive converted address
esp_netif_iodriver_handle esp_netif_get_io_driver(esp_netif_t *esp_netif)
Gets media driver handle for this esp-netif instance.
Return opaque pointer of related IO driver
Parameters
• [in] esp_netif: Handle to esp-netif instance
esp_netif_t *esp_netif_get_handle_from_ifkey(const char *if_key)
Searches over a list of created objects to find an instance with supplied if key.
Return Handle to esp-netif instance
Parameters
• if_key: Textual description of network interface
esp_netif_flags_t esp_netif_get_flags(esp_netif_t *esp_netif)
Returns configured flags for this interface.
Return Configuration flags
Parameters
• [in] esp_netif: Handle to esp-netif instance
const char *esp_netif_get_ifkey(esp_netif_t *esp_netif)
Returns configured interface key for this esp-netif instance.
Return Textual description of related interface
Parameters
• [in] esp_netif: Handle to esp-netif instance
const char *esp_netif_get_desc(esp_netif_t *esp_netif)
Returns configured interface type for this esp-netif instance.
Return Enumerated type of this interface, such as station, AP, ethernet
Parameters
• [in] esp_netif: Handle to esp-netif instance
int esp_netif_get_route_prio(esp_netif_t *esp_netif)
Returns configured routing priority number.
Return Integer representing the instance’s route-prio, or -1 if invalid paramters
Parameters
• [in] esp_netif: Handle to esp-netif instance
int32_t esp_netif_get_event_id(esp_netif_t *esp_netif, esp_netif_ip_event_type_t event_type)
Returns configured event for this esp-netif instance and supplied event type.
Return specific event id which is configured to be raised if the interface lost or acquired IP address -1 if
supplied event_type is not known
Parameters
• [in] esp_netif: Handle to esp-netif instance
• event_type: (either get or lost IP)
esp_netif_t *esp_netif_next(esp_netif_t *esp_netif)
Iterates over list of interfaces. Returns first netif if NULL given as parameter.
Return First netif from the list if supplied parameter is NULL, next one otherwise
Parameters
• [in] esp_netif: Handle to esp-netif instance
Espressif Systems 208
Submit Document Feedback
Release v4.4
To Next Page
Loading...