nrf-softdevice-s113

Crates

git

Versions

default

Flavors

#[repr(C)]
pub struct ble_gap_opt_auth_payload_timeout_t { pub conn_handle: u16, pub auth_payload_timeout: u16, }
Expand description

@brief Authenticated payload timeout option.

@details This can be used with @ref sd_ble_opt_set to change the Authenticated payload timeout to a value other than the default of @ref BLE_GAP_AUTH_PAYLOAD_TIMEOUT_MAX.

@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.

@note 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)).

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

Fields§

§conn_handle: u16

< Connection Handle

§auth_payload_timeout: u16

< Requested timeout in 10 ms unit, see @ref BLE_GAP_AUTH_PAYLOAD_TIMEOUT.

Trait Implementations§

source§

impl Clone for ble_gap_opt_auth_payload_timeout_t

source§

fn clone(&self) -> ble_gap_opt_auth_payload_timeout_t

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for ble_gap_opt_auth_payload_timeout_t

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Copy for ble_gap_opt_auth_payload_timeout_t

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere
T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.