nrfxlib API 3.3.99
Loading...
Searching...
No Matches

◆ sdc_hci_cmd_le_periodic_adv_sync_transfer()

uint8_t sdc_hci_cmd_le_periodic_adv_sync_transfer ( const sdc_hci_cmd_le_periodic_adv_sync_transfer_t * p_params,
sdc_hci_cmd_le_periodic_adv_sync_transfer_return_t * p_return )

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE Periodic Advertising Sync Transfer.

The description below is extracted from Core_v6.3, Vol 4, Part E, Section 7.8.89

This command is used to instruct the Controller to send synchronization information about the periodic advertising train identified by the Sync_Handle parameter to a connected device.

The Service_Data parameter is a value provided by the Host for use by the Host of the peer device. It is not used by the Controller.

The connected device is identified by the Connection_Handle parameter.

This command may successfully complete after the periodic advertising synchronization information is queued for transmission but before it is actually sent. No indication is given as to how the recipient handled the information.

Errors:

See Section 4.5.2 for a list of error types and descriptions.

Type   Condition                                                         Error code
MC     Sync_Handle does not identify an existing periodic advertising    Unknown Advertising
       train.                                                            Identifier (0x42)
MC     Connection_Handle does not identify a current connection.         Unknown Connection
                                                                         Identifier (0x02)
MC     The remote device has not indicated support for the Periodic      Unsupported Remote
       Advertising Sync Transfer – Recipient feature.                    Feature (0x1A)

Event(s) generated (unless masked away):

When the HCI_LE_Periodic_Advertising_Sync_Transfer command has completed, an HCI_Command_Complete event shall be generated.

Parameters
[in]p_paramsInput parameters.
[out]p_returnExtra return parameters.
Return values
0if success.
Returns
Returns value between 0x01-0xFF in case of error. See Vol 2, Part D, Error for a list of error codes and descriptions.