sdc_hci_cmd_le_big_terminate_sync()

uint8_t sdc_hci_cmd_le_big_terminate_sync	(	const sdc_hci_cmd_le_big_terminate_sync_t *	p_params,
		sdc_hci_cmd_le_big_terminate_sync_return_t *	p_return )

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE BIG Terminate Sync.

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

This command is used to stop synchronizing or cancel the process of synchronizing to the BIG identified by the BIG_Handle parameter. The command also terminates the reception of BISes in the BIG specified in the HCI_LE_BIG_Create_Sync command, destroys the associated connection handles of the BISes in the BIG and removes the data paths for all BISes in the BIG.

Errors:

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

Type   Condition                                                          Error code
MC     BIG_Handle does not identify a BIG.                                Unknown Advertising
                                                                          Identifier (0x42)
MC     BIG_Handle identifies a BIG which the Controller is neither        Command Disallowed
       synchronized to nor in the process of synchronizing to.            (0x0C)

Event(s) generated (unless masked away):

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

If the Host attempts to terminate synchronization with a BIG while the process of synchronization with that BIG is in progress (i.e. HCI_LE_BIG_Sync_Established event has not been generated) the process of synchronization shall stop, and the Controller shall generate the HCI_LE_BIG_Sync_Established event to the Host with the error code Operation Cancelled by Host (0x44).

Parameters

[in]	p_params	Input parameters.
[out]	p_return	Extra return parameters.

Return values

0	if 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.