takashi kadono / Mbed OS Nucleo_446

Dependencies:   ssd1331

Embed: (wiki syntax)

« Back to documentation index

Gap::AdvertisementCallbackParams_t Struct Reference

Gap::AdvertisementCallbackParams_t Struct Reference

Representation of a scanned advertising packet. More...

#include <Gap.h>

Public Member Functions

 AdvertisementCallbackParams_t ()
 Default constructor.
 MBED_DEPRECATED_SINCE ("mbed-os-5.9.0","addressType won't work in connect when privacy is enabled; please""use peerAddrType") AddressType_t addressType
 Type of the address received.

Data Fields

BLEProtocol::AddressBytes_t peerAddr
 BLE address of the device that has advertised the packet.
int8_t rssi
 RSSI value of the packet.
bool isScanResponse
 Flag indicating if the packet is a response to a scan request.
GapAdvertisingParams::AdvertisingType_t type
 Type of advertisement.
uint8_t advertisingDataLen
 Length of the advertisement data.
const uint8_t * advertisingData
 Pointer to the advertisement packet's data.
PeerAddressType_t peerAddrType
 Type of the address received.

Detailed Description

Representation of a scanned advertising packet.

Instances of this type are passed to the callback registered in startScan().

Definition at line 667 of file Gap.h.


Constructor & Destructor Documentation

Default constructor.

Definition at line 153 of file Gap.cpp.


Member Function Documentation

MBED_DEPRECATED_SINCE ( "mbed-os-5.9.0"  ,
"addressType won't work in connect when privacy is enabled; please""use peerAddrType  
)

Type of the address received.

Note:
This value should be used in the connect function to establish a connection with the peer that has sent this advertisement packet.

Field Documentation

const uint8_t* advertisingData

Pointer to the advertisement packet's data.

Definition at line 701 of file Gap.h.

Length of the advertisement data.

Definition at line 696 of file Gap.h.

Flag indicating if the packet is a response to a scan request.

Definition at line 686 of file Gap.h.

BLE address of the device that has advertised the packet.

Definition at line 676 of file Gap.h.

Type of the address received.

Note:
This value should be used in the connect function to establish a connection with the peer that has sent this advertisement packet.

Definition at line 725 of file Gap.h.

int8_t rssi

RSSI value of the packet.

Definition at line 681 of file Gap.h.

Type of advertisement.

Definition at line 691 of file Gap.h.