Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
AdvertisingEndEvent Struct Reference
Ble » Gap

Event produced when advertising ends. More...

#include <Events.h>

Public Member Functions

advertising_handle_t getAdvHandle () const
 Get advertising handle. More...
 
connection_handle_t getConnection () const
 Get connection handle (valid only if connected successfully). More...
 
uint8_t getCompleted_events () const
 Get how many events advertising created. More...
 
bool isConnected () const
 Has the advertising ended with a connection. More...
 
bool isLegacy () const
 Is the end of legacy advertising. More...
 
ble_error_t getStatus () const
 Get the result of the stop advertising event. More...
 

Detailed Description

Event produced when advertising ends.

See also
ble::Gap::EventHandler::onAdvertisingEnd().
Note
The connection handle, connected flag and completed_event fields are valid if the flag legacy is not set to true. If status is different from BLE_ERROR_NONE the completed_events field is not valid and the set may still be active.

Definition at line 624 of file Events.h.

Member Function Documentation

advertising_handle_t getAdvHandle ( ) const

Get advertising handle.

Definition at line 671 of file Events.h.

uint8_t getCompleted_events ( ) const

Get how many events advertising created.

Definition at line 683 of file Events.h.

connection_handle_t getConnection ( ) const

Get connection handle (valid only if connected successfully).

Definition at line 677 of file Events.h.

ble_error_t getStatus ( ) const

Get the result of the stop advertising event.

If the status is not BLE_ERROR_NONE the set may still be active.

Definition at line 706 of file Events.h.

bool isConnected ( ) const

Has the advertising ended with a connection.

Definition at line 689 of file Events.h.

bool isLegacy ( ) const

Is the end of legacy advertising.

If it is the return of getConnection() getCompleted_events() and isConnected() must be discarded

Definition at line 699 of file Events.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.