bt_le_ext_adv_cb Struct Reference

Callback struct to notify about advertiser activity. More...

#include <bluetooth.h>

Data Fields
void(*	sent )(struct bt_le_ext_adv *adv, struct bt_le_ext_adv_sent_info *info)
	The advertising set was disabled after reaching limit.
void(*	connected )(struct bt_le_ext_adv *adv, struct bt_le_ext_adv_connected_info *info)
	The advertising set has accepted a new connection.
void(*	scanned )(struct bt_le_ext_adv *adv, struct bt_le_ext_adv_scanned_info *info)
	The advertising set has sent scan response data.
bool(*	rpa_expired )(struct bt_le_ext_adv *adv)
	The RPA validity of the advertising set has expired.
void(*	pawr_data_request )(struct bt_le_ext_adv *adv, const struct bt_le_per_adv_data_request *request)
	The Controller indicates it is ready to transmit one or more PAwR subevents.
void(*	pawr_response )(struct bt_le_ext_adv *adv, struct bt_le_per_adv_response_info *info, struct net_buf_simple *buf)
	The Controller indicates that one or more synced devices have responded to a periodic advertising subevent indication.

Detailed Description

Callback struct to notify about advertiser activity.

The bt_le_ext_adv_cb struct contains callback functions that are invoked in response to various events related to the advertising set. These events include:

• Completion of advertising data transmission
• Acceptance of a new connection
• Transmission of scan response data
• If privacy is enabled:
  • Expiration of the advertising set's validity
• If PAwR (Periodic Advertising with Response) is enabled:
  • Readiness to send one or more PAwR subevents, namely the LE Periodic Advertising Subevent Data Request event
  • Response of synced devices to a periodic advertising subevent indication has been received, namely the LE Periodic Advertising Response Report event

Note

Must point to valid memory during the lifetime of the advertising set.

Used in bt_le_ext_adv_create.

Field Documentation

connected

void(* bt_le_ext_adv_cb::connected) (struct bt_le_ext_adv *adv, struct bt_le_ext_adv_connected_info *info)

The advertising set has accepted a new connection.

This callback notifies the application that the advertising set has accepted a new connection.

Parameters

adv	The advertising set object.
info	Information about the connected event.

pawr_data_request

void(* bt_le_ext_adv_cb::pawr_data_request) (struct bt_le_ext_adv *adv, const struct bt_le_per_adv_data_request *request)

The Controller indicates it is ready to transmit one or more PAwR subevents.

This callback notifies the application that the controller has requested data for upcoming subevents.

Parameters

adv	The advertising set object.
request	Information about the upcoming subevents.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_BT_PER_ADV_RSP 

.

pawr_response

void(* bt_le_ext_adv_cb::pawr_response) (struct bt_le_ext_adv *adv, struct bt_le_per_adv_response_info *info, struct net_buf_simple *buf)

The Controller indicates that one or more synced devices have responded to a periodic advertising subevent indication.

Parameters

adv	The advertising set object.
info	Information about the responses received.
buf	The received data. NULL if the controller reported that it did not receive any response.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_BT_PER_ADV_RSP 

.

rpa_expired

bool(* bt_le_ext_adv_cb::rpa_expired) (struct bt_le_ext_adv *adv)

The RPA validity of the advertising set has expired.

This callback notifies the application that the RPA validity of the advertising set has expired. The user can use this callback to synchronize the advertising payload update with the RPA rotation by for example invoking bt_le_ext_adv_set_data upon callback.

If RPA sharing is enabled (see

CONFIG_BT_RPA_SHARING 

) and this RPA expired callback of any adv-sets belonging to same adv id returns false, then adv-sets will continue with the old RPA throughout the RPA rotations.

Parameters

adv	The advertising set object.

Returns

true to rotate the current RPA, or false to use it for the next rotation period.

scanned

void(* bt_le_ext_adv_cb::scanned) (struct bt_le_ext_adv *adv, struct bt_le_ext_adv_scanned_info *info)

The advertising set has sent scan response data.

This callback notifies the application that the advertising set has has received a Scan Request packet, and has sent a Scan Response packet.

Parameters

adv	The advertising set object.
info	Information about the scanned event, namely the address.

sent

void(* bt_le_ext_adv_cb::sent) (struct bt_le_ext_adv *adv, struct bt_le_ext_adv_sent_info *info)

The advertising set was disabled after reaching limit.

This callback is invoked when the limit set in bt_le_ext_adv_start_param::timeout or bt_le_ext_adv_start_param::num_events is reached.

Parameters

adv	The advertising set object.
info	Information about the sent event.

---

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

• include/zephyr/bluetooth/bluetooth.h