BLE_GAP_WriteAuthPayloadTimeout
C
uint16_t BLE_GAP_WriteAuthPayloadTimeout(uint16_t connHandle, uint16_t authPayloadTo);Description
Sets the authenticated payload timeout parameter for a BLE connection.
Note
This configuration determines when the LE ping sequence should be initiated to maintain a secure connection. The timeout value must be chosen considering the connection interval and peripheral latency.
Parameters
| Parameter | Description |
|---|---|
| [in] connHandle | Connection handle associated with this connection. |
| [in] authPayloadTo | Authenticated payload timeout value (Unit: 10 ms). The value must be equal to or greater than connInterval*(1 + peripheralLatency). See BLE_GAP_EvtConnect_T for more details. |
Return values
| Return value | Description |
|---|---|
| MBA_RES_SUCCESS | Successfully sets the authenticated payload timeout value. |
| MBA_RES_OOM | Internal memory allocation failure occurred. |
| MBA_RES_UNKNOWN_CONN_ID | Unknown connection identifier. |
| MBA_RES_COMMAND_DISALLOWED | Command disallowed due to a conflicting operation or state. |