esp_ping_new_session() function

Create a ping session

Syntax

Show:

Summary

Declaration

Definition

from ping_sock.h:118

esp_err_t esp_ping_new_session(const esp_ping_config_t *config, const esp_ping_callbacks_t *cbs, esp_ping_handle_t *hdl_out);

Implemented in ping_sock.c:239

Arguments

Argument

Description

config

ping configuration

cbs

a bunch of callback functions invoked by internal ping task

hdl_out

handle of ping session

Return value

- ESP_ERR_INVALID_ARG: invalid parameters (e.g. configuration is null, etc) - ESP_ERR_NO_MEM: out of memory - ESP_FAIL: other internal error (e.g. socket error) - ESP_OK: create ping session successfully, user can take the ping handle to do follow-on jobs

Examples

esp_ping_new_session() is referenced by 4 libraries and example projects:

References

from examples

esp_ping_new_session() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle