# otPingSenderConfig Struct Reference

# otPingSenderConfig


`#include <openthread/ping_sender.h>`

Represents a ping request configuration.

## Summary

| ### Public attributes ||
|---|---|
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1aea478db43785a69a75ea62e4e65271f9` | `bool` Indicates whether hop limit is zero. |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1ad7e5405f51638906b9e65bc8fa156a8c` | `void *` A pointer to the callback application-specific context. |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1a8092708622af99957346c5e75262eff8` | `uint16_t` Number of ping messages to send. Zero to use default. |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1aa06ea6f47d7ca25df117e3fbd822997d` | `https://openthread.io/reference/struct/ot-ip6-address` Destination address to ping. |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1a8b9264a865aa5209f72c7e53426c3584` | `uint8_t` Hop limit (used if `mAllowZeroHopLimit` is false). Zero for default. |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1aed9c67d9232ea48795c4268a50b456a0` | `uint32_t` Ping tx interval in milliseconds. Zero to use default. |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1a08d7aaf120d77bc5bb4fbec3f8b0a2f8` | `bool` Allow looping back pings to multicast address that device is subscribed to. |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1a40955a27f12b92230e19eacf66602351` | `https://openthread.io/reference/group/api-ping-sender#group__api-ping-sender_1ga2ff70763e156d85ed9845506dae4d32d` Callback function to report replies (can be NULL if not needed). |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1aa9bcfb563c523b9d2d08ba7debc936fb` | `uint16_t` Data size (# of bytes) excludes IPv6/ICMPv6 header. Zero for default. |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1a5401ce04d4b1e9ee3f91f364bafb188a` | `https://openthread.io/reference/struct/ot-ip6-address` Source address of the ping. |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1a8e7b059547dab27f0e0413ac573070df` | `https://openthread.io/reference/group/api-ping-sender#group__api-ping-sender_1ga1824c68194ac85275fa73b7024e83c51` Callback function to report statistics (can be NULL if not needed). |
| `https://openthread.io/reference/struct/ot-ping-sender-config#structot_ping_sender_config_1a7699f75c27fdb0b665215e50fc7f4530` | `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](https://github.com/openthread/openthread/tree/main/include/openthread).
For more information, or to contribute to our documentation, refer to
[Resources](https://openthread.io/resources).