Function openthread_sys::otLinkSetPollPeriod

source ·

pub unsafe extern "C" fn otLinkSetPollPeriod(
    aInstance: *mut otInstance,
    aPollPeriod: u32
) -> otError

Expand description

Set/clear user-specified/external data poll period for sleepy end device.

@note This function updates only poll period of sleepy end device. To update child timeout the function otThreadSetChildTimeout() shall be called.

@note Minimal non-zero value should be OPENTHREAD_CONFIG_MAC_MINIMUM_POLL_PERIOD (10ms). Or zero to clear user-specified poll period.

@note User-specified value should be no more than the maximal value 0x3FFFFFF ((1 << 26) - 1) allowed, otherwise it would be clipped by the maximal value.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aPollPeriod data poll period in milliseconds.

@retval OT_ERROR_NONE Successfully set/cleared user-specified poll period. @retval OT_ERROR_INVALID_ARGS If aPollPeriod is invalid.

@sa otLinkGetPollPeriod