ble_gap_opt_local_conn_latency_t Struct Reference
[Structures]

Local connection latency option. More...

#include <ble_gap.h>

Detailed Description

Local connection latency option.

Local connection latency is a feature which enables the slave to improve current consumption by ignoring the slave latency set by the peer. The local connection latency can only be set to a multiple of the slave latency, and cannot be longer than half of the supervision timeout.

Used with sd_ble_opt_set to set the local connection latency. The sd_ble_opt_get is not supported for this option, but the actual local connection latency (unless set to NULL) is set as a return parameter when setting the option.

Note:

The latency set will be truncated down to the closest slave latency event multiple, or the nearest multiple before half of the supervision timeout.

The local connection latency is disabled by default, and needs to be enabled for new connections and whenever the connection is updated.

Return values:

NRF_SUCCESS	Set successfully.
NRF_ERROR_NOT_SUPPORTED	Get is not supported.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle parameter.

Definition at line 797 of file ble_gap.h.

Field Documentation