| S332 SoftDevice v2.0.0 |

Choose documentation: | nRF5 SDK | S130 SoftDevice API | S132 SoftDevice API | S212 SoftDevice API | S332 SoftDevice API

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Fields
ble_gap_opt_auth_payload_timeout_t Struct Reference
Structures

Authenticated payload timeout option. More...

`#include <ble_gap.h>`

## Data Fields
uint16_t | conn_handle
uint16_t | auth_payload_timeout

## Detailed Description

Authenticated payload timeout option.

This can be used with sd_ble_opt_set to change the Authenticated payload timeout to a value other than the default of 8 minutes.

Note
  The authenticated payload timeout event BLE_GAP_TIMEOUT_SRC_AUTH_PAYLOAD will be generated if auth_payload_timeout time has elapsed without receiving a packet with a valid MIC on an encrypted link.
  The LE ping procedure will be initiated before the timer expires to give the peer a chance to reset the timer. In addition the stack will try to prioritize running of LE ping over other activities to increase chances of finishing LE ping before timer expires. To avoid side-effects on other activities, it is recommended to use high timeout values. Recommended timeout > 2*(connInterval * (6 + connSlaveLatency)).

Return values

  NRF_SUCCESS | Set successfully.
  NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. auth_payload_timeout was outside of allowed range.
  BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle parameter.

## Field Documentation

uint16_t ble_gap_opt_auth_payload_timeout_t::auth_payload_timeout

Requested timeout in 10 ms unit. Maximum is 48 000 (=480 000 ms =8 min). Minimum is 1 (=10ms).

uint16_t ble_gap_opt_auth_payload_timeout_t::conn_handle

Connection Handle