« Back to documentation index
ConnectionCompleteEvent Struct Reference
Event generated when a connection initiation ends (successfully or not).
More...
#include <Events.h >
ConnectionCompleteEvent (ble_error_t status, connection_handle_t connectionHandle, connection_role_t ownRole, const peer_address_type_t &peerAddressType, const address_t &peerAddress, const address_t &localResolvablePrivateAddress, const address_t &peerResolvablePrivateAddress, conn_interval_t connectionInterval, slave_latency_t connectionLatency, supervision_timeout_t supervisionTimeout, uint16_t masterClockAccuracy) Create a connection complete event. ble_error_t getStatus () const Get connection complete event status. connection_handle_t getConnectionHandle () const Get connection handle (valid only when successful). connection_role_t getOwnRole () const Get own role. const peer_address_type_t & getPeerAddressType () const Get peer address type. const address_t & getPeerAddress () const Get peer address. const address_t & getLocalResolvablePrivateAddress () const Get get local resolvable random address if privacy is used. const address_t & getPeerResolvablePrivateAddress () const Get peer resolvable private address if privacy is used. conn_interval_t getConnectionInterval () const Get connection interval. slave_latency_t getConnectionLatency () const Get connection latency. supervision_timeout_t getSupervisionTimeout () const Get supervision timeout. uint16_t getMasterClockAccuracy () const Get clock accuracy in parts per million.
Detailed Description
Event generated when a connection initiation ends (successfully or not).
See also: ble::Gap::EventHandler::onConnectionComplete(). Definition at line 184 of file Events.h .
Constructor & Destructor Documentation
ConnectionCompleteEvent (
ble_error_t status ,
connection_handle_t connectionHandle ,
connection_role_t ownRole ,
const peer_address_type_t &
peerAddressType ,
const address_t &
peerAddress ,
const address_t &
localResolvablePrivateAddress ,
const address_t &
peerResolvablePrivateAddress ,
conn_interval_t connectionInterval ,
slave_latency_t connectionLatency ,
supervision_timeout_t supervisionTimeout ,
uint16_t
masterClockAccuracy
)
Create a connection complete event.
Parameters:
success BLE_ERROR_NONE if connection succeeded. connectionHandle Connection handle if successful. ownRole Role of the local device. peerAddressType Peer address type. peerAddress Peer address. localResolvablePrivateAddress Local address type if privacy enabled. peerResolvablePrivateAddress Peer address type if privacy enabled. connectionInterval Connection interval. connectionLatency Connection latency in events. supervisionTimeout Supervision timeout. masterClockAccuracy Peer clock accuracy in parts per million.
Definition at line 201 of file Events.h .
Member Function Documentation
Get connection handle (valid only when successful).
Definition at line 237 of file Events.h .
Get connection interval.
Definition at line 273 of file Events.h .
Get connection latency.
Definition at line 279 of file Events.h .
const address_t & getLocalResolvablePrivateAddress
(
)
const
Get get local resolvable random address if privacy is used.
Definition at line 261 of file Events.h .
uint16_t getMasterClockAccuracy
(
)
const
Get clock accuracy in parts per million.
Definition at line 291 of file Events.h .
Get peer address.
Definition at line 255 of file Events.h .
Get peer address type.
Definition at line 249 of file Events.h .
const address_t & getPeerResolvablePrivateAddress
(
)
const
Get peer resolvable private address if privacy is used.
Definition at line 267 of file Events.h .
Get connection complete event status.
Definition at line 231 of file Events.h .
Get supervision timeout.
Definition at line 285 of file Events.h .
1.7.2