nrf-softdevice-s122

Crates

git

Versions

default

Flavors

pub unsafe fn sd_ble_gap_conn_param_update(
conn_handle: u16,
p_conn_params: *const ble_gap_conn_params_t
) -> u32
Expand description

@brief Update connection parameters.

@details In the central role this will initiate a Link Layer connection parameter update procedure. This function can be used as a central both to reply to a @ref BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST or to start the procedure unrequested. Regardless of success or failure, the application will be informed of the result with a @ref BLE_GAP_EVT_CONN_PARAM_UPDATE event.

@events @event{@ref BLE_GAP_EVT_CONN_PARAM_UPDATE, Result of the connection parameter update procedure.} @endevents

@mscs @mmsc{@ref BLE_GAP_CENTRAL_CPU_MSC} @mmsc{@ref BLE_GAP_CENTRAL_ENC_AUTH_MUTEX_MSC} @mmsc{@ref BLE_GAP_MULTILINK_CPU_MSC} @mmsc{@ref BLE_GAP_MULTILINK_CTRL_PROC_MSC} @endmscs

@param[in] conn_handle Connection handle. @param[in] p_conn_params Pointer to desired connection parameters. If NULL is provided on a central role and in response to a @ref BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST, the peripheral request will be rejected.

@retval ::NRF_SUCCESS The Connection Update procedure has been started successfully. @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied. @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, check parameter limits and constraints. @retval ::NRF_ERROR_INVALID_STATE Either: - Disconnection in progress - Link has not been established. @retval ::NRF_ERROR_BUSY Procedure already in progress, wait for pending procedures to complete and retry. @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid connection handle supplied. @retval ::NRF_ERROR_NO_MEM Not enough memory to complete operation.