Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
st_ble_gap_adv_off_evt_t Struct Reference

Information about the advertising set which stops advertising. More...

Data Fields

uint8_t adv_hdl
 Advertising handle identifying the advertising set which has stopped advertising. More...
 
uint8_t reason
 The reason for stopping advertising. More...
 
uint16_t conn_hdl
 Connection handle. More...
 
uint8_t num_comp_ext_adv_evts
 The number of the advertising event that has been received until advertising has terminated. More...
 

Detailed Description

Information about the advertising set which stops advertising.

Field Documentation

◆ adv_hdl

uint8_t st_ble_gap_adv_off_evt_t::adv_hdl

Advertising handle identifying the advertising set which has stopped advertising.

Valid range is 0x00 - 0x03.

◆ reason

uint8_t st_ble_gap_adv_off_evt_t::reason

The reason for stopping advertising.

value description
0x01 Advertising has been stopped by R_BLE_GAP_StopAdv().
0x02 Because the duration specified by R_BLE_GAP_StartAdv() was expired, advertising has terminated.
0x03 Because the max_extd_adv_evts parameter specified by R_BLE_GAP_StartAdv() was reached, advertising has terminated.
0x04 Because the connection was established with the remote device, advertising has terminated.

◆ conn_hdl

uint16_t st_ble_gap_adv_off_evt_t::conn_hdl

Connection handle.

If the reason field is 0x04, this field indicates connection handle identifying the remote device connected with local device.
If other reasons, ignore this field.

◆ num_comp_ext_adv_evts

uint8_t st_ble_gap_adv_off_evt_t::num_comp_ext_adv_evts

The number of the advertising event that has been received until advertising has terminated.

If max_extd_adv_evts by R_BLE_GAP_StartAdv() is not 0, this parameter is valid.