Function openthread_sys::otCommissionerAnnounceBegin

source ·

pub unsafe extern "C" fn otCommissionerAnnounceBegin(
    aInstance: *mut otInstance,
    aChannelMask: u32,
    aCount: u8,
    aPeriod: u16,
    aAddress: *const otIp6Address
) -> otError

Expand description

Sends an Announce Begin message.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aChannelMask The channel mask value. @param[in] aCount The number of Announcement messages per channel. @param[in] aPeriod The time between two successive MLE Announce transmissions (in milliseconds). @param[in] aAddress A pointer to the IPv6 destination.

@retval OT_ERROR_NONE Successfully enqueued the Announce Begin message. @retval OT_ERROR_NO_BUFS Insufficient buffers to generate an Announce Begin message. @retval OT_ERROR_INVALID_STATE The commissioner is not active.

@note Only use this after successfully starting the Commissioner role with otCommissionerStart().