1.1.2.1.1.4.8 BLE_GAP_CreateSync

C

uint16_t BLE_GAP_CreateSync(BLE_GAP_CreateSync_T *p_periSync);

Description

Synchronize with a periodic advertising train from an advertiser and begin receiving periodic advertising packets.

Note

This API may be called whether or not scanning is enabled and scanning may be enabled and disabled while this command is pending. However, synchronization can only occur when scanning is enabled. See BLE_GAP_SetExtScanningEnable.

This API belongs to extended advertising feature. It will be disallowed if any one API that belongs to legacy advertising feature is issued before. Categories of advertising APIs and events for details of advertising APIs.

BLE_GAP_ScanInit, BLE_GAP_ExtScanInit and BLE_GAP_SyncInit are required for this API.

Events generated

BLE_GAP_EVT_PERI_ADV_SYNC_EST Generated when sync. established.

BLE_GAP_EVT_PERI_ADV_REPORT Generated when enabling to receive the report.

Parameters


Parameter	Description
[in] p_periSync	Pointer to BLE_GAP_CreateSync_T structure buffer.

Return values


Return value	Description
MBA_RES_SUCCESS	Successfully issue a request to synchronize with a periodic advertising.
MBA_RES_OOM	Internal memory allocation failure.
MBA_RES_INVALID_PARA	Invalid parameters.
MBA_RES_CONN_ALREADY_EXISTS	Connection already exists.
MBA_RES_COMMAND_DISALLOWED	Command disallowed.