Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

AdvertisingEndEvent Struct Reference

AdvertisingEndEvent Struct Reference
[Gap]

Event produced when advertising ends. More...

#include <Events.h>

Public Member Functions

 AdvertisingEndEvent (advertising_handle_t advHandle, connection_handle_t connection, uint8_t completed_events, bool connected)
 Create advertising end event.
advertising_handle_t getAdvHandle () const
 Get advertising handle.
connection_handle_t getConnection () const
 Get connection handle (valid only if connected successfully).
uint8_t getCompleted_events () const
 Get how many events advertising created.
bool isConnected () const
 Has the advertising ended with a connection.

Detailed Description

Event produced when advertising ends.

See also:
ble::Gap::EventHandler::onAdvertisingEnd().

Definition at line 525 of file Events.h.


Constructor & Destructor Documentation

AdvertisingEndEvent ( advertising_handle_t  advHandle,
connection_handle_t  connection,
uint8_t  completed_events,
bool  connected 
)

Create advertising end event.

Parameters:
advHandleAdvertising set handle.
connectionConnection handle.
completed_eventsNumber of events created during before advertising end.
connectedTrue if connection has been established.

Definition at line 535 of file Events.h.


Member Function Documentation

advertising_handle_t getAdvHandle (  ) const

Get advertising handle.

Definition at line 551 of file Events.h.

uint8_t getCompleted_events (  ) const

Get how many events advertising created.

Definition at line 563 of file Events.h.

connection_handle_t getConnection (  ) const

Get connection handle (valid only if connected successfully).

Definition at line 557 of file Events.h.

bool isConnected (  ) const

Has the advertising ended with a connection.

Definition at line 569 of file Events.h.