This file includes the OpenThread API for the ping sender module.

Classes
struct	otPingSenderReply
	This structure represents a ping reply.

struct	otPingSenderStatistics
	This structure represents statistics of a ping request.

struct	otPingSenderConfig
	This structure represents a ping request configuration.

Typedefs
typedef struct otPingSenderReply	otPingSenderReply
	This structure represents a ping reply.

typedef struct otPingSenderStatistics	otPingSenderStatistics
	This structure represents statistics of a ping request.

typedef void(*	otPingSenderReplyCallback ) (const otPingSenderReply aReply, void aContext)
	This function pointer type specifies the callback to notify receipt of a ping reply.

typedef void(*	otPingSenderStatisticsCallback ) (const otPingSenderStatistics aStatistics, void aContext)
	This function pointer type specifies the callback to report the ping statistics.

typedef struct otPingSenderConfig	otPingSenderConfig
	This structure represents a ping request configuration.

Functions
otError	otPingSenderPing ( otInstance aInstance, const otPingSenderConfig aConfig)
	This function starts a ping.

void	otPingSenderStop ( otInstance *aInstance)
	This function stops an ongoing ping.

Detailed Description

This file includes the OpenThread API for the ping sender module.

Typedef Documentation

typedef void(* otPingSenderReplyCallback) (const otPingSenderReply *aReply, void *aContext)

This function pointer type specifies the callback to notify receipt of a ping reply.

Parameters

[in]	`aReply`	A pointer to a `otPingSenderReply` containing info about the received ping reply.
[in]	`aContext`	A pointer to application-specific context.

typedef void(* otPingSenderStatisticsCallback) (const otPingSenderStatistics *aStatistics, void *aContext)

This function pointer type specifies the callback to report the ping statistics.

Parameters

[in]	`aStatistics`	A pointer to a `otPingSenderStatistics` containing info about the received ping statistics.
[in]	`aContext`	A pointer to application-specific context.

This function starts a ping.

Parameters

[in]	`aInstance`	A pointer to an OpenThread instance.
[in]	`aConfig`	The ping config to use.

Return values

`OT_ERROR_NONE`	The ping started successfully.
`OT_ERROR_BUSY`	Could not start since busy with a previous ongoing ping request.
`OT_ERROR_INVALID_ARGS`	The `aConfig` contains invalid parameters (e.g., ping interval is too long).

void otPingSenderStop ( otInstance * aInstance )

This function stops an ongoing ping.

Parameters

[in] aInstance A pointer to an OpenThread instance.