This structure represents a ping request configuration.

Public Attributes#

otIp6Address
mSource

Source address of the ping.

otIp6Address
mDestination

Destination address to ping.

otPingSenderReplyCallback
mReplyCallback

Callback function to report replies (can be NULL if not needed).

otPingSenderStatisticsCallback
mStatisticsCallback

Callback function to report statistics (can be NULL if not needed).

void *
mCallbackContext

A pointer to the callback application-specific context.

uint16_t
mSize

Data size (# of bytes) excludes IPv6/ICMPv6 header. Zero for default.

uint16_t
mCount

Number of ping messages to send. Zero to use default.

uint32_t
mInterval

Ping tx interval in milliseconds. Zero to use default.

uint16_t
mTimeout

Time in milliseconds to wait for final reply after sending final request.

uint8_t
mHopLimit

Hop limit (used if mAllowZeroHopLimit is false). Zero for default.

bool
mAllowZeroHopLimit

Indicates whether hop limit is zero.

Public Attribute Documentation#

mSource#

otIp6Address otPingSenderConfig::mSource

Source address of the ping.


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

mDestination#

otIp6Address otPingSenderConfig::mDestination

Destination address to ping.


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

mReplyCallback#

otPingSenderReplyCallback otPingSenderConfig::mReplyCallback

Callback function to report replies (can be NULL if not needed).


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

mStatisticsCallback#

otPingSenderStatisticsCallback otPingSenderConfig::mStatisticsCallback

Callback function to report statistics (can be NULL if not needed).


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

mCallbackContext#

void* otPingSenderConfig::mCallbackContext

A pointer to the callback application-specific context.


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

mSize#

uint16_t otPingSenderConfig::mSize

Data size (# of bytes) excludes IPv6/ICMPv6 header. Zero for default.


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

mCount#

uint16_t otPingSenderConfig::mCount

Number of ping messages to send. Zero to use default.


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

mInterval#

uint32_t otPingSenderConfig::mInterval

Ping tx interval in milliseconds. Zero to use default.


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

mTimeout#

uint16_t otPingSenderConfig::mTimeout

Time in milliseconds to wait for final reply after sending final request.

Zero to use default.


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

mHopLimit#

uint8_t otPingSenderConfig::mHopLimit

Hop limit (used if mAllowZeroHopLimit is false). Zero for default.


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

mAllowZeroHopLimit#

bool otPingSenderConfig::mAllowZeroHopLimit

Indicates whether hop limit is zero.


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