Function nrf_softdevice_s140::sd_ble_gap_conn_evt_trigger_start

source ·

pub unsafe fn sd_ble_gap_conn_evt_trigger_start(
    conn_handle: u16,
    p_params: *const ble_gap_conn_event_trigger_t
) -> u32

Expand description

@brief Start triggering a given task on connection event start.

@details When enabled, this feature will trigger a PPI task at the start of connection events. The application can configure the SoftDevice to trigger every N connection events starting from a given connection event counter. See also @ref ble_gap_conn_event_trigger_t.

@param[in] conn_handle Connection handle. @param[in] p_params Connection event trigger parameters.

@retval ::NRF_SUCCESS Success. @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid connection handle supplied. @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied. @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter supplied. See @ref ble_gap_conn_event_trigger_t. @retval ::NRF_ERROR_INVALID_STATE Either: - Trying to start connection event triggering when it is already ongoing. - @ref ble_gap_conn_event_trigger_t::conn_evt_counter_start is in the past. Use @ref sd_ble_gap_next_conn_evt_counter_get to find a new value to be used as ble_gap_conn_event_trigger_t::conn_evt_counter_start.