otThreadDirectListenerConfig

#include <openthread/thread_direct_listener.h>

Represents the configuration parameters for starting the Thread Direct Wake Listener.

Summary

To ensure forward compatibility as new fields may be added in future revisions, the caller MUST zero-initialize (memset to zero) this structure before setting its fields.

For mChannel, mInterval, and mDuration, setting a field to 0 selects its specification-mandated default (OT_THREAD_DIRECT_LISTENER_CHANNEL, OT_THREAD_DIRECT_LISTENER_INTERVAL, and OT_THREAD_DIRECT_LISTENER_DURATION, respectively). Specifying a value other than 0 or the specification-mandated default makes the operation non-compliant with the specification and is intended for testing purposes only. Callers SHOULD either leave these fields set to 0 or set them to the corresponding OT_THREAD_DIRECT_LISTENER_* constant.

Public attributes

mChannel
uint8_t
Radio channel (0 for default).
mDuration
uint32_t
Listen duration in usec (0 for default).
mInterval
uint32_t
Listen interval in usec (0 for default, >= mDuration).
mWakeCallback
Callback invoked on Wake reception (can be NULL).
mWakeCallbackContext
void *
Context pointer passed to mWakeCallback.

Public attributes

mChannel

uint8_t otThreadDirectListenerConfig::mChannel

Radio channel (0 for default).

mDuration

uint32_t otThreadDirectListenerConfig::mDuration

Listen duration in usec (0 for default).

mInterval

uint32_t otThreadDirectListenerConfig::mInterval

Listen interval in usec (0 for default, >= mDuration).

mWakeCallback

otThreadDirectListenerWakeCallback otThreadDirectListenerConfig::mWakeCallback

Callback invoked on Wake reception (can be NULL).

mWakeCallbackContext

void * otThreadDirectListenerConfig::mWakeCallbackContext

Context pointer passed to mWakeCallback.

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.