Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_le_per_adv_sync_cb Struct Reference

#include <bluetooth.h>

Data Fields

void(* synced )(struct bt_le_per_adv_sync *sync, struct bt_le_per_adv_sync_synced_info *info)
 The periodic advertising has been successfully synced.
 
void(* term )(struct bt_le_per_adv_sync *sync, const struct bt_le_per_adv_sync_term_info *info)
 The periodic advertising sync has been terminated.
 
void(* recv )(struct bt_le_per_adv_sync *sync, const struct bt_le_per_adv_sync_recv_info *info, struct net_buf_simple *buf)
 Periodic advertising data received.
 
void(* state_changed )(struct bt_le_per_adv_sync *sync, const struct bt_le_per_adv_sync_state_info *info)
 The periodic advertising sync state has changed.
 
void(* biginfo )(struct bt_le_per_adv_sync *sync, const struct bt_iso_biginfo *biginfo)
 BIGInfo advertising report received.
 
void(* cte_report_cb )(struct bt_le_per_adv_sync *sync, struct bt_df_per_adv_sync_iq_samples_report const *info)
 Callback for IQ samples report collected when sampling CTE received with periodic advertising PDU.
 
sys_snode_t node
 

Field Documentation

◆ biginfo

void(* bt_le_per_adv_sync_cb::biginfo) (struct bt_le_per_adv_sync *sync, const struct bt_iso_biginfo *biginfo)

BIGInfo advertising report received.

This callback notifies the application of a BIGInfo advertising report. This is received if the advertiser is broadcasting isochronous streams in a BIG. See iso.h for more information.

Parameters
syncThe advertising set object.
biginfoThe BIGInfo report.

◆ cte_report_cb

void(* bt_le_per_adv_sync_cb::cte_report_cb) (struct bt_le_per_adv_sync *sync, struct bt_df_per_adv_sync_iq_samples_report const *info)

Callback for IQ samples report collected when sampling CTE received with periodic advertising PDU.

Parameters
syncThe periodic advertising sync object.
infoInformation about the sync event.

◆ node

sys_snode_t bt_le_per_adv_sync_cb::node

◆ recv

void(* bt_le_per_adv_sync_cb::recv) (struct bt_le_per_adv_sync *sync, const struct bt_le_per_adv_sync_recv_info *info, struct net_buf_simple *buf)

Periodic advertising data received.

This callback notifies the application of an periodic advertising report.

Parameters
syncThe advertising set object.
infoInformation about the periodic advertising event.
bufBuffer containing the periodic advertising data. NULL if the controller failed to receive a subevent indication. Only happens if
CONFIG_BT_PER_ADV_SYNC_RSP 
is enabled.

◆ state_changed

void(* bt_le_per_adv_sync_cb::state_changed) (struct bt_le_per_adv_sync *sync, const struct bt_le_per_adv_sync_state_info *info)

The periodic advertising sync state has changed.

This callback notifies the application about changes to the sync state. Initialize sync and termination is handled by their individual callbacks, and won't be notified here.

Parameters
syncThe periodic advertising sync object.
infoInformation about the state change.

◆ synced

void(* bt_le_per_adv_sync_cb::synced) (struct bt_le_per_adv_sync *sync, struct bt_le_per_adv_sync_synced_info *info)

The periodic advertising has been successfully synced.

This callback notifies the application that the periodic advertising set has been successfully synced, and will now start to receive periodic advertising reports.

Parameters
syncThe periodic advertising sync object.
infoInformation about the sync event.

◆ term

void(* bt_le_per_adv_sync_cb::term) (struct bt_le_per_adv_sync *sync, const struct bt_le_per_adv_sync_term_info *info)

The periodic advertising sync has been terminated.

This callback notifies the application that the periodic advertising sync has been terminated, either by local request, remote request or because due to missing data, e.g. by being out of range or sync.

Parameters
syncThe periodic advertising sync object.

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