zephyr::raw

Function bt_le_per_adv_sync_create

source
pub unsafe extern "C" fn bt_le_per_adv_sync_create(
    param: *const bt_le_per_adv_sync_param,
    out_sync: *mut *mut bt_le_per_adv_sync,
) -> i32
Expand description

@brief Create a periodic advertising sync object.

Create a periodic advertising sync object that can try to synchronize to periodic advertising reports from an advertiser. Scan shall either be disabled or extended scan shall be enabled.

This function does not timeout, and will continue to look for an advertiser until it either finds it or bt_le_per_adv_sync_delete() is called. It is thus suggested to implement a timeout when using this, if it is expected to find the advertiser within a reasonable timeframe.

@param[in] param Periodic advertising sync parameters. @param[out] out_sync Periodic advertising sync object on.

@return Zero on success or (negative) error code otherwise.