Function openthread_sys::otThreadSetMaxChildIpAddresses

source ·

pub unsafe extern "C" fn otThreadSetMaxChildIpAddresses(
    aInstance: *mut otInstance,
    aMaxIpAddresses: u8
) -> otError

Expand description

Sets or restores the maximum number of IP addresses that each MTD child may register with this device as parent.

Pass 0 to clear the setting and restore the default.

Available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

@note Only used by Thread Test Harness to limit the address registrations of the reference parent in order to test the MTD DUT reaction.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aMaxIpAddresses The maximum number of IP addresses that each MTD child may register with this device as parent. 0 to clear the setting and restore the default.

@retval OT_ERROR_NONE Successfully set/cleared the number. @retval OT_ERROR_INVALID_ARGS If exceeds the allowed maximum number.

@sa otThreadGetMaxChildIpAddresses