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

Event generated when a connection initiation ends (successfully or not). More...

#include <Events.h>

Public Member Functions

ble_error_t getStatus () const
 Get connection complete event status. More...
 
connection_handle_t getConnectionHandle () const
 Get connection handle (valid only when successful). More...
 
connection_role_t getOwnRole () const
 Get own role. More...
 
const peer_address_type_tgetPeerAddressType () const
 Get peer address type. More...
 
const address_tgetPeerAddress () const
 Get peer address. More...
 
const address_tgetLocalResolvablePrivateAddress () const
 Get get local resolvable random address if privacy is used. More...
 
const address_tgetPeerResolvablePrivateAddress () const
 Get peer resolvable private address if privacy is used. More...
 
conn_interval_t getConnectionInterval () const
 Get connection interval. More...
 
slave_latency_t getConnectionLatency () const
 Get connection latency. More...
 
supervision_timeout_t getSupervisionTimeout () const
 Get supervision timeout. More...
 
uint16_t getMasterClockAccuracy () const
 Get clock accuracy in parts per million. More...
 
void setStatus (ble_error_t new_status)
 Set connection complete event status. More...
 
void setPeerAddressType (const peer_address_type_t &address_type)
 Set peer address type. More...
 
void setPeerAddress (const address_t &address)
 Set peer address. More...
 
void setLocalResolvablePrivateAddress (const address_t &address)
 Set get local resolvable random address if privacy is used. More...
 
void setPeerResolvablePrivateAddress (const address_t &address)
 Set peer resolvable private address if privacy is used. More...
 

Detailed Description

Event generated when a connection initiation ends (successfully or not).

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

Definition at line 211 of file Events.h.

Member Function Documentation

connection_handle_t getConnectionHandle ( ) const

Get connection handle (valid only when successful).

Definition at line 264 of file Events.h.

conn_interval_t getConnectionInterval ( ) const

Get connection interval.

Definition at line 300 of file Events.h.

slave_latency_t getConnectionLatency ( ) const

Get connection latency.

Definition at line 306 of file Events.h.

const address_t& getLocalResolvablePrivateAddress ( ) const

Get get local resolvable random address if privacy is used.

Definition at line 288 of file Events.h.

uint16_t getMasterClockAccuracy ( ) const

Get clock accuracy in parts per million.

Definition at line 318 of file Events.h.

connection_role_t getOwnRole ( ) const

Get own role.

Definition at line 270 of file Events.h.

const address_t& getPeerAddress ( ) const

Get peer address.

Definition at line 282 of file Events.h.

const peer_address_type_t& getPeerAddressType ( ) const

Get peer address type.

Definition at line 276 of file Events.h.

const address_t& getPeerResolvablePrivateAddress ( ) const

Get peer resolvable private address if privacy is used.

Definition at line 294 of file Events.h.

ble_error_t getStatus ( ) const

Get connection complete event status.

Definition at line 258 of file Events.h.

supervision_timeout_t getSupervisionTimeout ( ) const

Get supervision timeout.

Definition at line 312 of file Events.h.

void setLocalResolvablePrivateAddress ( const address_t address)

Set get local resolvable random address if privacy is used.

Definition at line 343 of file Events.h.

void setPeerAddress ( const address_t address)

Set peer address.

Definition at line 337 of file Events.h.

void setPeerAddressType ( const peer_address_type_t address_type)

Set peer address type.

Definition at line 331 of file Events.h.

void setPeerResolvablePrivateAddress ( const address_t address)

Set peer resolvable private address if privacy is used.

Definition at line 349 of file Events.h.

void setStatus ( ble_error_t  new_status)

Set connection complete event status.

Definition at line 325 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.