Chapter 2. API Reference
Public Members
uint32_t count
A “ping”session contains count procedures
uint32_t interval_ms
Milliseconds between each ping procedure
uint32_t timeout_ms
Timeout value (in milliseconds) of each ping procedure
uint32_t data_size
Size of the data next to ICMP packet header
uint8_t tos
Type of Service, a field specified in the IP header
ip_addr_t target_addr
Target IP address, either IPv4 or IPv6
uint32_t task_stack_size
Stack size of internal ping task
uint32_t task_prio
Priority of internal ping task
uint32_t interface
Netif index, interface=0 means NETIF_NO_INDEX
Macros
ESP_PING_DEFAULT_CONFIG()
Default ping configuration.
ESP_PING_COUNT_INFINITE
Set ping count to zero will ping target infinitely
Type Definitions
typedef void *esp_ping_handle_t
Type of “ping”session handle.
Enumerations
enum esp_ping_profile_t
Profile of ping session.
Values:
ESP_PING_PROF_SEQNO
Sequence number of a ping procedure
ESP_PING_PROF_TTL
Time to live of a ping procedure
ESP_PING_PROF_REQUEST
Number of request packets sent out
ESP_PING_PROF_REPLY
Number of reply packets received
ESP_PING_PROF_IPADDR
IP address of replied target
ESP_PING_PROF_SIZE
Size of received packet
Espressif Systems 599
Submit Document Feedback
Release v4.4