nrf-softdevice-s132

Crates

git

Versions

default

Flavors

pub unsafe fn sd_ble_gap_whitelist_set(
pp_wl_addrs: *const *const ble_gap_addr_t,
len: u8
) -> u32
Expand description

@brief Set the active whitelist in the SoftDevice.

@note Only one whitelist can be used at a time and the whitelist is shared between the BLE roles. The whitelist cannot be set if a BLE role is using the whitelist.

@note If an address is resolved using the information in the device identity list, then the whitelist filter policy applies to the peer identity address and not the resolvable address sent on air.

@mscs @mmsc{@ref BLE_GAP_WL_SHARE_MSC} @mmsc{@ref BLE_GAP_PRIVACY_SCAN_PRIVATE_SCAN_MSC} @endmscs

@param[in] pp_wl_addrs Pointer to a whitelist of peer addresses, if NULL the whitelist will be cleared. @param[in] len Length of the whitelist, maximum @ref BLE_GAP_WHITELIST_ADDR_MAX_COUNT.

@retval ::NRF_SUCCESS The whitelist is successfully set/cleared. @retval ::NRF_ERROR_INVALID_ADDR The whitelist (or one of its entries) provided is invalid. @retval ::BLE_ERROR_GAP_WHITELIST_IN_USE The whitelist is in use by a BLE role and cannot be set or cleared. @retval ::BLE_ERROR_GAP_INVALID_BLE_ADDR Invalid address type is supplied. @retval ::NRF_ERROR_DATA_SIZE The given whitelist size is invalid (zero or too large); this can only return when pp_wl_addrs is not NULL.