DOC:Correct IP_EVENT_STA_LOST_IP name

Fix the name of the IP_EVENT_STA_LOST_IP event (was IP_STA_LOST_IP)

Signed-off-by: xueyunfei <xueyunfei@espressif.com>

Closes https://github.com/espressif/esp-idf/pull/8347
pull/9422/head
Jack Farley 2022-02-04 15:39:36 +13:00 zatwierdzone przez chenjianxing
rodzic 31035183da
commit 15845ff47b
2 zmienionych plików z 3 dodań i 3 usunięć

Wyświetl plik

@ -205,11 +205,11 @@ IP_EVENT_GOT_IP6
++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++
This event arises when the IPV6 SLAAC support auto-configures an address for the {IDF_TARGET_NAME}, or when this address changes. The event means that everything is ready and the application can begin its tasks (e.g., creating sockets). This event arises when the IPV6 SLAAC support auto-configures an address for the {IDF_TARGET_NAME}, or when this address changes. The event means that everything is ready and the application can begin its tasks (e.g., creating sockets).
IP_STA_LOST_IP IP_EVENT_STA_LOST_IP
++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++
This event arises when the IPV4 address become invalid. This event arises when the IPV4 address become invalid.
IP_STA_LOST_IP doesn't arise immediately after the Wi-Fi disconnects, instead it starts an IPV4 address lost timer, if the IPV4 address is got before ip lost timer expires, IP_EVENT_STA_LOST_IP doesn't happen. Otherwise, the event arises when IPV4 address lost timer expires. IP_EVENT_STA_LOST_IP doesn't arise immediately after the Wi-Fi disconnects, instead it starts an IPV4 address lost timer, if the IPV4 address is got before ip lost timer expires, IP_EVENT_STA_LOST_IP doesn't happen. Otherwise, the event arises when IPV4 address lost timer expires.
Generally the application don't need to care about this event, it is just a debug event to let the application know that the IPV4 address is lost. Generally the application don't need to care about this event, it is just a debug event to let the application know that the IPV4 address is lost.

Wyświetl plik

@ -206,7 +206,7 @@ IP_EVENT_GOT_IP6
++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++
当 IPV6 SLAAC 支持自动为 {IDF_TARGET_NAME} 配置一个地址,或 {IDF_TARGET_NAME} 地址发生改变时,将引发此事件。此事件意味着应用程序一切就绪,可以开始任务(如:创建套接字)。 当 IPV6 SLAAC 支持自动为 {IDF_TARGET_NAME} 配置一个地址,或 {IDF_TARGET_NAME} 地址发生改变时,将引发此事件。此事件意味着应用程序一切就绪,可以开始任务(如:创建套接字)。
IP_STA_LOST_IP IP_EVENT_STA_LOST_IP
++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++
当 IPV4 地址失效时,将引发此事件。 当 IPV4 地址失效时,将引发此事件。