otPingSenderConfig

#include <ping_sender.h>

Represents a ping request configuration.

Summary

Public attributes
`mAllowZeroHopLimit`	`bool` Indicates whether hop limit is zero.
`mCallbackContext`	`void *` A pointer to the callback application-specific context.
`mCount`	`uint16_t` Number of ping messages to send. Zero to use default.
`mDestination`	`otIp6Address` Destination address to ping.
`mHopLimit`	`uint8_t` Hop limit (used if `mAllowZeroHopLimit` is false). Zero for default.
`mInterval`	`uint32_t` Ping tx interval in milliseconds. Zero to use default.
`mMulticastLoop`	`bool` Allow looping back pings to multicast address that device is subscribed to.
`mReplyCallback`	`otPingSenderReplyCallback` Callback function to report replies (can be NULL if not needed).
`mSize`	`uint16_t` Data size (# of bytes) excludes IPv6/ICMPv6 header. Zero for default.
`mSource`	`otIp6Address` Source address of the ping.
`mStatisticsCallback`	`otPingSenderStatisticsCallback` Callback function to report statistics (can be NULL if not needed).
`mTimeout`	`uint16_t` Time in milliseconds to wait for final reply after sending final request.

Public attributes

mAllowZeroHopLimit

bool otPingSenderConfig::mAllowZeroHopLimit

Indicates whether hop limit is zero.

mCallbackContext

void * otPingSenderConfig::mCallbackContext

A pointer to the callback application-specific context.

mCount

uint16_t otPingSenderConfig::mCount

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

mDestination

otIp6Address otPingSenderConfig::mDestination

Destination address to ping.

mHopLimit

uint8_t otPingSenderConfig::mHopLimit

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

mInterval

uint32_t otPingSenderConfig::mInterval

Ping tx interval in milliseconds. Zero to use default.

mMulticastLoop

bool otPingSenderConfig::mMulticastLoop

Allow looping back pings to multicast address that device is subscribed to.

mReplyCallback

otPingSenderReplyCallback otPingSenderConfig::mReplyCallback

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

mSize

uint16_t otPingSenderConfig::mSize

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

mSource

otIp6Address otPingSenderConfig::mSource

Source address of the ping.

mStatisticsCallback

otPingSenderStatisticsCallback otPingSenderConfig::mStatisticsCallback

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

mTimeout

uint16_t otPingSenderConfig::mTimeout

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

Zero to use default.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.