BLE_GAP_SubrateRequest

C

uint16_t BLE_GAP_SubrateRequest(uint16_t connHandle, BLE_GAP_SubrateParams_T  *p_subrateParams);

Description

Request a change to the subrating factor and/or other parameters.

Note

This command should be used only after the BLE_GAP_EVT_FEATURE_EXCHANGE_COMPL event has been received.The following conditions will result in an MBA_RES_INVALID_PARA response:

  • Subrate Max × (Max Latency + 1) is greater than 500.

  • Current connection interval × Subrate Max × (Max Latency + 1) is greater than or equal to half the Supervision Timeout parameter.

  • Subrate Max is less than Subrate Min.

  • Continuation Number is greater than or equal to Subrate Max.

Parameters

ParameterDescription
[in] connHandleConnection handle associated with this connection.
[in] p_subrateParamsPointer to a BLE_GAP_SubrateParams_T structure containing the subrate parameters.

Return values

Return valueDescription
MBA_RES_SUCCESSSuccessfully request a change to the subrating factor and/or other parameters.
MBA_RES_INVALID_PARAThe parameters provided are invalid.
MBA_RES_COMMAND_DISALLOWEDCommand disallowed due to a conflicting operation or state.