Modules#

Ping Sender#

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

Typedefs#

typedef struct otPingSenderReply

otPingSenderReply

Represents a ping reply.

typedef struct otPingSenderStatistics

otPingSenderStatistics

Represents statistics of a ping request.

typedef void(*

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

Pointer type specifies the callback to notify receipt of a ping reply.

typedef void(*

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

Pointer type specifies the callback to report the ping statistics.

typedef struct otPingSenderConfig

otPingSenderConfig

Represents a ping request configuration.

Functions#

otError

otPingSenderPing(otInstance *aInstance, const otPingSenderConfig *aConfig)

Starts a ping.

void

otPingSenderStop(otInstance *aInstance)

Stops an ongoing ping.

Typedef Documentation#

otPingSenderReply#

typedef struct otPingSenderReply otPingSenderReply

Represents a ping reply.

Definition at line 69 of file include/openthread/ping_sender.h

otPingSenderStatistics#

typedef struct otPingSenderStatistics otPingSenderStatistics

Represents statistics of a ping request.

Definition at line 83 of file include/openthread/ping_sender.h

otPingSenderReplyCallback#

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

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.

Definition at line 92 of file include/openthread/ping_sender.h

otPingSenderStatisticsCallback#

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

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.

Definition at line 102 of file include/openthread/ping_sender.h

otPingSenderConfig#

typedef struct otPingSenderConfig otPingSenderConfig

Represents a ping request configuration.

Definition at line 123 of file include/openthread/ping_sender.h

Function Documentation#

otPingSenderPing#

otError otPingSenderPing (otInstance * aInstance, const otPingSenderConfig * aConfig)

Starts a ping.

Parameters

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

Definition at line 137 of file include/openthread/ping_sender.h

otPingSenderStop#

void otPingSenderStop (otInstance * aInstance)

Stops an ongoing ping.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Definition at line 145 of file include/openthread/ping_sender.h