Zephyr API Documentation 4.5.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_conn_auth_info_cb Struct Reference

Authenticated pairing information callback structure. More...

#include <zephyr/bluetooth/conn.h>

Data Fields

void(* pairing_complete )(struct bt_conn *conn, bool bonded)
 notify that pairing procedure was complete.
void(* pairing_failed )(struct bt_conn *conn, enum bt_security_err reason)
 notify that pairing process has failed.
void(* bond_deleted )(uint8_t id, const bt_addr_le_t *peer)
 Notify that bond has been deleted.
void(* addr_res_support_read )(struct bt_conn *conn, enum bt_le_addr_res_support support)
 The peer's support for address resolution has been read.
void(* br_bond_deleted )(const bt_addr_t *peer)
 Notify that bond of classic has been deleted.
sys_snode_t node
 Internally used field for list handling.

Detailed Description

Authenticated pairing information callback structure.

Note
The callbacks are invoked from a thread context, never from an ISR. Whether a callback is invoked from a context internal to the stack or synchronously from within the API call that triggers it, and from which context, is not part of the API and may change between releases. See Callback execution contexts for the hazards of blocking in a callback and their mitigations.

Field Documentation

◆ addr_res_support_read

void(* bt_conn_auth_info_cb::addr_res_support_read) (struct bt_conn *conn, enum bt_le_addr_res_support support)

The peer's support for address resolution has been read.

This callback notifies the application that the automatic read of a bonded peer's Central Address Resolution characteristic, enabled with CONFIG_BT_GATT_AUTO_READ_CENTRAL_ADDR_RES, has finished. The answer is also available from bt_le_bond_addr_res_support(), and remains unknown when the read failed.

Parameters
connConnection the characteristic was read on.
supportThe peer's support for address resolution.

◆ bond_deleted

void(* bt_conn_auth_info_cb::bond_deleted) (uint8_t id, const bt_addr_le_t *peer)

Notify that bond has been deleted.

This callback notifies the application that the bond information for the remote peer has been deleted

Parameters
idWhich local identity had the bond.
peerRemote address.

◆ br_bond_deleted

void(* bt_conn_auth_info_cb::br_bond_deleted) (const bt_addr_t *peer)

Notify that bond of classic has been deleted.

This callback notifies the application that the bond information of classic for the remote peer has been deleted

Parameters
peerRemote address.

◆ node

sys_snode_t bt_conn_auth_info_cb::node

Internally used field for list handling.

◆ pairing_complete

void(* bt_conn_auth_info_cb::pairing_complete) (struct bt_conn *conn, bool bonded)

notify that pairing procedure was complete.

This callback notifies the application that the pairing procedure has been completed.

Parameters
connConnection object.
bondedBond information has been distributed during the pairing procedure.

◆ pairing_failed

void(* bt_conn_auth_info_cb::pairing_failed) (struct bt_conn *conn, enum bt_security_err reason)

notify that pairing process has failed.

Parameters
connConnection object.
reasonPairing failed reason

The documentation for this struct was generated from the following file: